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.c | |
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.c')
-rw-r--r-- | sv.c | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -130,7 +130,7 @@ static const char S_destroy[] = "DESTROY"; /* ============================================================================ -=for apidoc_section SV Handling +=for apidoc_section $SV An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv, av, hv...) contains type and reference count information, and for many types, a pointer to the body (struct xrv, xpv, xpviv...), which @@ -408,7 +408,7 @@ S_del_sv(pTHX_ SV *p) /* -=for apidoc_section SV Handling +=for apidoc_section $SV =for apidoc sv_add_arena @@ -13454,7 +13454,7 @@ Perl_sv_vcatpvfn_flags(pTHX_ SV *const sv, const char *const pat, const STRLEN p /* ========================================================================= -=for apidoc_section Embedding and Interpreter Cloning +=for apidoc_section $embedding =cut @@ -16042,7 +16042,7 @@ Perl_init_constants(pTHX) } /* -=for apidoc_section Unicode Support +=for apidoc_section $unicode =for apidoc sv_recode_to_utf8 @@ -16313,7 +16313,7 @@ Perl_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ, /* -=apidoc_section Warning and Dieing +=apidoc_section $warning =for apidoc find_uninit_var Find the name of the undefined variable (if any) that caused the operator |