summaryrefslogtreecommitdiff
path: root/hv.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2019-06-25 08:40:05 -0600
committerKarl Williamson <khw@cpan.org>2019-06-25 09:07:12 -0600
commit78342678c3d43495ec0526969486d748b07f0525 (patch)
tree91ac0dcdeacea9d8c052f07e4a8633a3d5340fe0 /hv.h
parent5c696bd319ee40ee8ca0a317377f9c7b73d1fa8b (diff)
downloadperl-78342678c3d43495ec0526969486d748b07f0525.tar.gz
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.
Diffstat (limited to 'hv.h')
-rw-r--r--hv.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/hv.h b/hv.h
index dcc6eb1e2f..96a710f1a7 100644
--- a/hv.h
+++ b/hv.h
@@ -142,14 +142,14 @@ struct xpvhv {
/*
=head1 Hash Manipulation Functions
-=for apidoc AmU||HEf_SVKEY
+=for apidoc AmnU||HEf_SVKEY
This flag, used in the length slot of hash entries and magic structures,
specifies the structure contains an C<SV*> pointer where a C<char*> pointer
is to be expected. (For information only--not to be used).
=head1 Handy Values
-=for apidoc AmU||Nullhv
+=for apidoc ADmnU||Nullhv
Null HV pointer.
(deprecated - use C<(HV *)NULL> instead)