This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document STMT_START .. STMT_END
authorKarl Williamson <khw@cpan.org>
Sat, 31 Aug 2019 20:55:07 +0000 (14:55 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 3 Sep 2019 03:52:12 +0000 (21:52 -0600)
Now that we have the 'u' flag we can document these macros and not have
to break downstream processing.

perl.h

diff --git a/perl.h b/perl.h
index 4a98718..f6a0794 100644 (file)
--- a/perl.h
+++ b/perl.h
 #endif
 
 /*
- * STMT_START { statements; } STMT_END;
- * can be used as a single statement, as in
- * if (x) STMT_START { ... } STMT_END; else ...
- *
- * Trying to select a version that gives no warnings...
- */
+=head1 Miscellaneous Functions
+
+=for apidoc AmnUu|void|STMT_START
+
+ STMT_START { statements; } STMT_END;
+
+can be used as a single statement, as in
+
+ if (x) STMT_START { ... } STMT_END; else ...
+
+These are often used in macro definitions.  Note that you can't return a value
+out of them.
+
+=for apidoc AmnUhu|void|STMT_END
+
+=cut
+
+ Trying to select a version that gives no warnings...
+*/
 #if !(defined(STMT_START) && defined(STMT_END))
 # ifdef PERL_USE_GCC_BRACE_GROUPS
 #   define STMT_START  (void)( /* gcc supports "({ STATEMENTS; })" */