Skip to content

Commit

Permalink
perlapi, av.h: Need "apidoc_item"
Browse files Browse the repository at this point in the history
Commit 0d564a3 added docs for
newAV_mortal, but it needed to use "apidoc_item", not plain "apidoc".

Not doing so resulted in this build time warning:

Empty pod for newAV (from av.h) at autodoc.pl line 1265.

and the resulting pod/perlapi.pod was incorrect.

Plain "apidoc" is used to begin a new entry.  "apidoc_item" is for
related subsidiary functions to the main entry.

Suggestions welcome as to how to make this relationship more obvious.
Perhaps it should be renamed "apidoc_sub_item"
  • Loading branch information
khwilliamson committed Feb 7, 2024
1 parent 583eadc commit ebb7a94
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion av.h
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Note that there are both real and fake AVs; see the beginning of this file and
'av.c'
=for apidoc newAV
=for apidoc newAV_mortal
=for apidoc_item newAV_mortal
=for apidoc_item newAV_alloc_x
=for apidoc_item newAV_alloc_xz
Expand Down

0 comments on commit ebb7a94

Please sign in to comment.