summaryrefslogtreecommitdiff
path: root/embed.fnc
diff options
context:
space:
mode:
authorMarcus Holland-Moritz <mhx-perl@gmx.net>2004-06-02 16:42:24 +0000
committerMarcus Holland-Moritz <mhx-perl@gmx.net>2004-06-02 16:42:24 +0000
commit3c3f4ab8346141e357ca6b8576755a4db710d2ac (patch)
tree759a89bf509964456d9cf3d497c1db893a2d6409 /embed.fnc
parent69232efac4da91085d3445ce98427a2706e520f7 (diff)
downloadperl-3c3f4ab8346141e357ca6b8576755a4db710d2ac.tar.gz
Document embed.fnc 'U' and 's' flags.
p4raw-id: //depot/perl@22894
Diffstat (limited to 'embed.fnc')
-rw-r--r--embed.fnc4
1 files changed, 3 insertions, 1 deletions
diff --git a/embed.fnc b/embed.fnc
index b69b792ff4..180d867abf 100644
--- a/embed.fnc
+++ b/embed.fnc
@@ -10,7 +10,8 @@
: proto, no #define
: d function has documentation with its source
: s static function, should have an S_ prefix in
-: source file
+: source file; for macros (m), suffix the usage
+: example with a semicolon
: n has no implicit interpreter/thread context argument
: p function has a Perl_ prefix
: f function takes printf style format string, varargs
@@ -22,6 +23,7 @@
: E visible to extensions included in the Perl core
: b binary backward compatibility; function is a macro
: but has also Perl_ implementation (which is exported)
+: U suppress usage example in autogenerated documentation
:
: Individual flags may be separated by whitespace.
: