diff options
| author | Karl Williamson <khw@cpan.org> | 2020-10-08 06:37:40 -0600 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2020-10-08 08:23:29 -0600 |
| commit | 9e728159a33ae479369731865c6c86daea2deeb7 (patch) | |
| tree | ab4cff722cb913c38289361fe40e57139a8ec151 /embed.fnc | |
| parent | 4f0d304ec835f478a4dd9b4ab7af01f5b826c6d7 (diff) | |
| download | perl-9e728159a33ae479369731865c6c86daea2deeb7.tar.gz | |
autodoc: Add ability to specify typedefs
Typedefs are part of the API; this allows us to document basic things
such as CV, U8 that aren't currently covered.
Diffstat (limited to 'embed.fnc')
| -rw-r--r-- | embed.fnc | 4 |
1 files changed, 3 insertions, 1 deletions
@@ -180,7 +180,7 @@ : : The 'name' in any such line must not be the same as any in this file (i.e., : no redundant definitions), and one of the flags on the apidoc lines must be -: 'm', indicating it is a macro (or similar), and not a function. +: 'm' or 'y', indicating it is not a function. : : All but the name field of an apidoc_item line are optional, and if empty, : inherits from the controlling plain apidoc line. The flags field is @@ -539,6 +539,8 @@ : any doc entry is marked that it may change. Also used to suppress : making a perlapi doc entry if it would just be a placeholder. : +: y Typedef. The element names a type rather than being a macro +: : In this file, pointer parameters that must not be passed NULLs should be : prefixed with NN. : |