diff options
author | Karl Williamson <khw@cpan.org> | 2020-11-04 06:13:30 -0700 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2020-11-06 06:16:04 -0700 |
commit | 3f6206216e363ef43b165a72465dc5c3eb94376f (patch) | |
tree | 84806224266944f9341d4fac7550cf7d86032bf4 /sv.h | |
parent | 55d5a9fee827e3a97a143ccc6717207445b9918a (diff) | |
download | perl-3f6206216e363ef43b165a72465dc5c3eb94376f.tar.gz |
autodoc.pl: Enhance apidoc_section feature
This feature allows documentation destined for perlapi or perlintern to
be split into sections of related functions, no matter where the
documentation source is. Prior to this commit the line had to contain
the exact text of the title of the section. Now it can be a $variable
name that autodoc.pl expands to the title. It still has to be an exact
match for the variable in autodoc, but now, the expanded text can be
changed in autodoc alone, without other files needing to be updated at
the same time.
Diffstat (limited to 'sv.h')
-rw-r--r-- | sv.h | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -13,7 +13,7 @@ #endif /* -=for apidoc_section SV Flags +=for apidoc_section $SV_flags =for apidoc Ay||svtype An enum of flags for Perl types. These are found in the file F<sv.h> @@ -269,7 +269,7 @@ struct p5rx { #undef _SV_HEAD_UNION /* ensure no pollution */ /* -=for apidoc_section SV Handling +=for apidoc_section $SV =for apidoc Am|U32|SvREFCNT|SV* sv Returns the value of the object's reference count. Exposed @@ -2103,7 +2103,7 @@ incremented. /* the following macros update any magic values this C<sv> is associated with */ /* -=head1 Magic +=for apidoc_section $magic =for apidoc Am|void|SvGETMAGIC|SV* sv Invokes C<L</mg_get>> on an SV if it has 'get' magic. For example, this @@ -2142,7 +2142,7 @@ has been loaded. Releases a mutual exclusion lock on C<sv> if a suitable module has been loaded. -=for apidoc_section SV Handling +=for apidoc_section $SV =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len Expands the character buffer in the SV so that it has room for the |