summaryrefslogtreecommitdiff
path: root/autodoc.pl
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-08-26 16:15:37 -0600
committerKarl Williamson <khw@cpan.org>2020-09-04 16:13:25 -0600
commit7260d4ba4e838006b1dbfb499d26308262f44767 (patch)
tree612e2d7b8d737ef3aec908b25d4fd78e789b261e /autodoc.pl
parent51b56f5c7c7e109a2c53226c83c2d324801d4f9b (diff)
downloadperl-7260d4ba4e838006b1dbfb499d26308262f44767.tar.gz
autodoc: Display list of sections near top
This would enable someone to more quickly organize their search
Diffstat (limited to 'autodoc.pl')
-rw-r--r--autodoc.pl10
1 files changed, 10 insertions, 0 deletions
diff --git a/autodoc.pl b/autodoc.pl
index 9457f28fe8..c247c24433 100644
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -1266,6 +1266,8 @@ $valid_sections{'General Configuration'}{footer} =~ s/__HAS_R_LIST__/$has_r_defs
my $include_defs_text .= join ",S< > ", map { "C<$_>" } sort sort_helper @include_defs;
$valid_sections{'General Configuration'}{footer} =~ s/__INCLUDE_LIST__/$include_defs_text/;
+my $section_list = join "\n\n", map { "=item L</$_>" } sort sort_helper keys %valid_sections;
+
output('perlapi', <<"_EOB_", $docs{api}, \@missing_api, <<"_EOE_");
|=encoding UTF-8
|
@@ -1286,6 +1288,14 @@ output('perlapi', <<"_EOB_", $docs{api}, \@missing_api, <<"_EOE_");
|to be documented. Patches welcome! The interfaces of these are subject to
|change without notice.
|
+|The sections in this document are
+|
+|=over
+
+|$section_list
+|
+|=back
+|
|Anything not listed here or in the other mentioned pods is not part of the
|public API, and should not be used by extension writers at all. For these
|reasons, blindly using functions listed in F<proto.h> is to be avoided when