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 /scope.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 'scope.h')
| -rw-r--r-- | scope.h | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -175,7 +175,7 @@ given literal string with the new scope. =for apidoc Ams||LEAVE_with_name(name) Same as C<L</LEAVE>>, but when debugging is enabled it first checks that the -scope has the given name. C<name> must be a C<NUL>-terminated literal string. +scope has the given name. C<name> must be a literal string. =cut */ |