summaryrefslogtreecommitdiff
path: root/op.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-11-04 06:13:30 -0700
committerKarl Williamson <khw@cpan.org>2020-11-06 06:16:04 -0700
commit3f6206216e363ef43b165a72465dc5c3eb94376f (patch)
tree84806224266944f9341d4fac7550cf7d86032bf4 /op.c
parent55d5a9fee827e3a97a143ccc6717207445b9918a (diff)
downloadperl-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 'op.c')
-rw-r--r--op.c18
1 files changed, 9 insertions, 9 deletions
diff --git a/op.c b/op.c
index 2933e2ed7d..bf3c84ea2c 100644
--- a/op.c
+++ b/op.c
@@ -789,7 +789,7 @@ Perl_allocmy(pTHX_ const char *const name, const STRLEN len, const U32 flags)
}
/*
-=for apidoc_section Optree Manipulation Functions
+=for apidoc_section $optree_manipulation
=for apidoc alloccopstash
@@ -5789,7 +5789,7 @@ Perl_block_end(pTHX_ I32 floor, OP *seq)
}
/*
-=for apidoc_section Compile-time scope hooks
+=for apidoc_section $scope
=for apidoc blockhook_register
@@ -6336,7 +6336,7 @@ S_gen_constant_list(pTHX_ OP *o)
}
/*
-=for apidoc_section Optree Manipulation Functions
+=for apidoc_section $optree_manipulation
*/
/* List constructors */
@@ -6508,7 +6508,7 @@ Perl_op_convert_list(pTHX_ I32 type, I32 flags, OP *o)
/*
-=for apidoc_section Optree construction
+=for apidoc_section $optree_construction
=for apidoc newNULLLIST
@@ -8877,7 +8877,7 @@ Perl_utilize(pTHX_ int aver, I32 floor, OP *version, OP *idop, OP *arg)
}
/*
-=for apidoc_section Embedding and Interpreter Cloning
+=for apidoc_section $embedding
=for apidoc load_module
@@ -9025,7 +9025,7 @@ Perl_dofile(pTHX_ OP *term, I32 force_builtin)
}
/*
-=for apidoc_section Optree construction
+=for apidoc_section $optree_construction
=for apidoc newSLICEOP
@@ -10613,7 +10613,7 @@ static void const_av_xsub(pTHX_ CV* cv);
/*
-=for apidoc_section Optree Manipulation Functions
+=for apidoc_section $optree_manipulation
=for apidoc cv_const_sv
@@ -17996,7 +17996,7 @@ Perl_peep(pTHX_ OP *o)
}
/*
-=for apidoc_section Custom Operators
+=for apidoc_section $custom
=for apidoc Perl_custom_op_xop
Return the XOP structure for a given custom op. This macro should be
@@ -18398,7 +18398,7 @@ Perl_report_redefined_cv(pTHX_ const SV *name, const CV *old_cv,
}
/*
-=for apidoc_section Hook manipulation
+=for apidoc_section $hook
These functions provide convenient and thread-safe means of manipulating
hook variables.