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 /inline.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 'inline.h')
-rw-r--r-- | inline.h | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -40,7 +40,7 @@ SOFTWARE. /* ------------------------------- av.h ------------------------------- */ /* -=for apidoc_section AV Handling +=for apidoc_section $AV =for apidoc av_count Returns the number of elements in the array C<av>. This is the true length of the array, including any undefined elements. It is always the same as @@ -60,7 +60,7 @@ Perl_av_count(pTHX_ AV *av) /* ------------------------------- cv.h ------------------------------- */ /* -=for apidoc_section CV Handling +=for apidoc_section $CV =for apidoc CvGV Returns the GV associated with the CV C<sv>, reifying it if necessary. @@ -311,7 +311,7 @@ S_sv_or_pv_pos_u2b(pTHX_ SV *sv, const char *pv, STRLEN pos, STRLEN *lenp) /* ------------------------------- utf8.h ------------------------------- */ /* -=for apidoc_section Unicode Support +=for apidoc_section $unicode */ PERL_STATIC_INLINE void @@ -1884,7 +1884,7 @@ Perl_utf8_to_uvchr_buf_helper(pTHX_ const U8 *s, const U8 *send, STRLEN *retlen) /* ------------------------------- perl.h ----------------------------- */ /* -=for apidoc_section Utility Functions +=for apidoc_section $utility =for apidoc is_safe_syscall @@ -2457,7 +2457,7 @@ Perl_cx_popgiven(pTHX_ PERL_CONTEXT *cx) /* ------------------ util.h ------------------------------------------- */ /* -=for apidoc_section String Handling +=for apidoc_section $string =for apidoc foldEQ @@ -2513,7 +2513,7 @@ Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len) } /* -=for apidoc_section Locales +=for apidoc_section $locale =for apidoc foldEQ_locale Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the @@ -2541,7 +2541,7 @@ Perl_foldEQ_locale(const char *s1, const char *s2, I32 len) } /* -=for apidoc_section String Handling +=for apidoc_section $string =for apidoc my_strnlen The C library C<strnlen> if available, or a Perl implementation of it. |