diff options
| author | Zefram <zefram@fysh.org> | 2017-11-12 05:58:36 +0000 |
|---|---|---|
| committer | Zefram <zefram@fysh.org> | 2017-11-12 06:06:00 +0000 |
| commit | 1568d13a11564a7d9d62aaf6a79b9b04172a2a45 (patch) | |
| tree | 0ab414c0b8e814426a4df60ec36b77db727443d4 /pad.h | |
| parent | bc3331071e1ccbdab715397718bb00282f5c5e88 (diff) | |
| download | perl-1568d13a11564a7d9d62aaf6a79b9b04172a2a45.tar.gz | |
better document macros taking literal strings
When giving a function-style prototype for a macro taking a literal string
parameter, put a string literal in place of a type for that parameter.
This goofy appearance makes it obvious that this isn't really a function,
and clues the reader in that the parameter can't actually be an arbitrary
expression of the right type. Also change the nonsensical "NUL-terminated
literal string" to "literal string" to describe these parameters.
Fixes [perl #116286].
Diffstat (limited to 'pad.h')
| -rw-r--r-- | pad.h | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -492,9 +492,9 @@ Clone the state variables associated with running and compiling pads. PL_cop_seqmax = proto_perl->Icop_seqmax; /* -=for apidoc Am|PADOFFSET|pad_add_name_pvs|const char *name|U32 flags|HV *typestash|HV *ourstash +=for apidoc Am|PADOFFSET|pad_add_name_pvs|"literal string" name|U32 flags|HV *typestash|HV *ourstash -Exactly like L</pad_add_name_pvn>, but takes a C<NUL>-terminated literal string +Exactly like L</pad_add_name_pvn>, but takes a literal string instead of a string/length pair. =cut @@ -504,9 +504,9 @@ instead of a string/length pair. Perl_pad_add_name_pvn(aTHX_ STR_WITH_LEN(name), flags, typestash, ourstash) /* -=for apidoc Am|PADOFFSET|pad_findmy_pvs|const char *name|U32 flags +=for apidoc Am|PADOFFSET|pad_findmy_pvs|"literal string" name|U32 flags -Exactly like L</pad_findmy_pvn>, but takes a C<NUL>-terminated literal string +Exactly like L</pad_findmy_pvn>, but takes a literal string instead of a string/length pair. =cut |