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 /XSUB.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 'XSUB.h')
| -rw-r--r-- | XSUB.h | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -14,7 +14,7 @@ /* first, some documentation for xsubpp-generated items */ /* -=for apidoc_section XS +=for apidoc_section $XS F<xsubpp> compiles XS code into C. See L<perlutil/xsubpp>. @@ -215,7 +215,7 @@ is a lexical C<$_> in scope. /* Typically used to return values from XS functions. */ /* -=for apidoc_section Stack Manipulation Macros +=for apidoc_section $stack =for apidoc Am|void|XST_mIV|int pos|IV iv Place an integer into the specified position C<pos> on the stack. The @@ -291,7 +291,7 @@ C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">. Macro to verify that the perl api version an XS module has been compiled against matches the api version of the perl interpreter it's being loaded into. -=for apidoc_section Exception Handling (simple) Macros +=for apidoc_section $exceptions =for apidoc Amns||dXCPT Set up necessary local variables for exception handling. |