This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Note that mro[gs]et_private_data are documented
authorKarl Williamson <khw@cpan.org>
Sat, 31 Aug 2019 17:05:11 +0000 (11:05 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 3 Sep 2019 03:52:11 +0000 (21:52 -0600)
autodoc.pl
embed.fnc
mro_core.c
pod/perlmroapi.pod

index 590053f..efd5e25 100644 (file)
@@ -43,6 +43,7 @@ my @specialized_docs = sort qw( perlguts
                                 perlapio
                                 perlcall
                                 perlfilter
+                                perlmroapi
                               );
 my $other_places_api = join " ",    map { "L<$_>" } sort @specialized_docs, 'perlintern';
 my $other_places_intern = join " ", map { "L<$_>" } sort @specialized_docs, 'perlapi';
index 739283a..7c3e88e 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
@@ -3265,9 +3265,9 @@ XExop     |void   |emulate_cop_io |NN const COP *const c|NN SV *const sv
 : Used by SvRX and SvRXOK
 XExop  |REGEXP *|get_re_arg|NULLOK SV *sv
 
-Aop    |SV*    |mro_get_private_data|NN struct mro_meta *const smeta \
+Aopdh  |SV*    |mro_get_private_data|NN struct mro_meta *const smeta \
                                     |NN const struct mro_alg *const which
-Aop    |SV*    |mro_set_private_data|NN struct mro_meta *const smeta \
+Aopdh  |SV*    |mro_set_private_data|NN struct mro_meta *const smeta \
                                     |NN const struct mro_alg *const which \
                                     |NN SV *const data
 Aop    |const struct mro_alg *|mro_get_from_name|NN SV *name
index c22e337..ffcbba6 100644 (file)
@@ -21,6 +21,7 @@
 /*
 =head1 MRO Functions
 These functions are related to the method resolution order of perl classes
+Also see L<perlmroapi>.
 
 =cut
 */
@@ -118,7 +119,8 @@ Perl_mro_get_from_name(pTHX_ SV *name) {
 
 /*
 =for apidoc mro_register
-Registers a custom mro plugin.  See L<perlmroapi> for details.
+Registers a custom mro plugin.  See L<perlmroapi> for details on this and other
+mro functions.
 
 =cut
 */
index 4d19cda..c585441 100644 (file)
@@ -79,10 +79,14 @@ stash, and a pointer to your C<mro_alg> structure:
     meta = HvMROMETA(stash);
     private_sv = MRO_GET_PRIVATE_DATA(meta, &my_mro_alg);
 
+=for apidoc mro_get_private_data
+
 To set your private value, call C<Perl_mro_set_private_data()>:
 
     Perl_mro_set_private_data(aTHX_ meta, &c3_alg, private_sv);
 
+=for apidoc mro_set_private_data
+
 The private data cache will take ownership of a reference to private_sv,
 much the same way that C<hv_store()> takes ownership of a reference to the
 value that you pass it.