Add 'apidoc_flag' to perlapi generation #23984
Open
+249
−233
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
So move them from perlapi to perlintern
Where they were made autodoc.pl think they were from a new entry
This is meant to easily document the flags a function accepts or returns. Currently this only is used for generating X<> entries for the flags, but it allows replacing (in the next commit) the previous, clumsier, method used that does the same thing. And it allows for future enhancements, including generating tests by Devel::PPPort and automatic text added by autodoc.
This replaces the clumsy method used previously by the new construct introduced in the previous commit.
khwilliamson
force-pushed
the
apidoc_flag
branch
from
34ee75a to
17b59da
Compare
tonycoz
reviewed
Dec 7, 2025
scope.c
Outdated
Comment on lines
294
to
295
| =for apidoc Amnh ||SAVEf_KEEPOLDELEM | ||
| =for apidoc Amnh ||SAVEf_SETMAGIC | ||
| =for apidoc Cmnh ||SAVEf_KEEPOLDELEM | ||
| =for apidoc Cmnh ||SAVEf_SETMAGIC |
Contributor
There was a problem hiding this comment.
These are also used by and documented for save_helem_flags(), which is API.
Contributor
|
Otherwise looks ok. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is designed to make noting what flag bits a function or macro takes very easy, while helping downstream code that processes things do a better job.