summaryrefslogtreecommitdiff
path: root/perlio.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-08-27 09:28:17 -0600
committerKarl Williamson <khw@cpan.org>2022-04-29 09:01:28 -0600
commitdc911d66a871e429f8997d66de26ac6082d456cb (patch)
treee313fac2c3cb8616d1a313d955eedb8912df95e1 /perlio.h
parentf8ed0a91515917f85c17206609b60adcb3b59fc4 (diff)
downloadperl-dc911d66a871e429f8997d66de26ac6082d456cb.tar.gz
Document PERLIO_FUNCS_(DECL|CAST)
Diffstat (limited to 'perlio.h')
-rw-r--r--perlio.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/perlio.h b/perlio.h
index f444fa86d0..b802105e87 100644
--- a/perlio.h
+++ b/perlio.h
@@ -63,6 +63,17 @@ typedef PerlIOl *PerlIO;
#define PerlIO PerlIO
#define PERLIO_LAYERS 1
+/*
+=for apidoc_section $io
+=for apidoc Amu||PERLIO_FUNCS_DECL|PerlIO * ftab
+Declare C<ftab> to be a PerlIO function table, that is, of type
+C<PerlIO_funcs>.
+
+=for apidoc Ay|PerlIO_funcs *|PERLIO_FUNCS_CAST|PerlIO * func
+Cast the pointer C<func> to be of type S<C<PerlIO_funcs *>>.
+
+=cut
+*/
#define PERLIO_FUNCS_DECL(funcs) const PerlIO_funcs funcs
#define PERLIO_FUNCS_CAST(funcs) (PerlIO_funcs*)(funcs)