From 78342678c3d43495ec0526969486d748b07f0525 Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Tue, 25 Jun 2019 08:40:05 -0600 Subject: Fix apidoc macro entries This makes various fixes to the text that is used to generate the documentation. The dominant change is to add the 'n' flag to indicate that the macro takes no arguments. A couple should have been marked with a D (for deprecated) flag, and a couple were missing parameters, and a couple were missing return values. These were spotted by using Devel::PPPort on them. --- unicode_constants.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'unicode_constants.h') diff --git a/unicode_constants.h b/unicode_constants.h index d7ccd90b7e..4102f4b915 100644 --- a/unicode_constants.h +++ b/unicode_constants.h @@ -24,7 +24,7 @@ /* =head1 Unicode Support -=for apidoc AmU|placeholder|BOM_UTF8 +=for apidoc AmnU|const char *|BOM_UTF8 This is a macro that evaluates to a string constant of the UTF-8 bytes that define the Unicode BYTE ORDER MARK (U+FEFF) for the platform that perl @@ -33,7 +33,7 @@ works on both ASCII and EBCDIC platforms. S> can be used to get its length in bytes. -=for apidoc AmU|placeholder|REPLACEMENT_CHARACTER_UTF8 +=for apidoc AmnU|const char *|REPLACEMENT_CHARACTER_UTF8 This is a macro that evaluates to a string constant of the UTF-8 bytes that define the Unicode REPLACEMENT CHARACTER (U+FFFD) for the platform that perl -- cgit v1.2.1