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 /cop.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 'cop.h')
| -rw-r--r-- | cop.h | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -166,7 +166,7 @@ typedef struct jmpenv JMPENV; } STMT_END /* -=for apidoc_section COP Hint Hashes +=for apidoc_section $COP */ typedef struct refcounted_he COPHH; @@ -1083,7 +1083,7 @@ typedef struct stackinfo PERL_SI; } STMT_END /* -=for apidoc_section Utility Functions +=for apidoc_section $utility =for apidoc Amn|bool|IN_PERL_COMPILETIME Returns 1 if this macro is being called during the compilation phase of the program; otherwise 0; @@ -1098,7 +1098,7 @@ program; otherwise 0; #define IN_PERL_RUNTIME cBOOL(PL_curcop != &PL_compiling) /* -=for apidoc_section Multicall Functions +=for apidoc_section $multicall =for apidoc Amns||dMULTICALL Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>. |