This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document embed.fnc 'U' and 's' flags.
authorMarcus Holland-Moritz <mhx-perl@gmx.net>
Wed, 2 Jun 2004 16:42:24 +0000 (16:42 +0000)
committerMarcus Holland-Moritz <mhx-perl@gmx.net>
Wed, 2 Jun 2004 16:42:24 +0000 (16:42 +0000)
p4raw-id: //depot/perl@22894

embed.fnc

index b69b792..180d867 100644 (file)
--- 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.
 :