summaryrefslogtreecommitdiff
path: root/cop.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-08-29 10:55:02 -0600
committerKarl Williamson <khw@cpan.org>2020-11-29 09:11:41 -0700
commitadd0fa588474394597ad4b9734b2d1646a7b225e (patch)
treec19a42f1e24aca3f32ab5b5426f79c7a4aca275d /cop.h
parentc2454cf4ab65969c7412dafa4c6fc9572a5fb5f9 (diff)
downloadperl-add0fa588474394597ad4b9734b2d1646a7b225e.tar.gz
Document various CopFILEfoo functions
Diffstat (limited to 'cop.h')
-rw-r--r--cop.h26
1 files changed, 26 insertions, 0 deletions
diff --git a/cop.h b/cop.h
index 0ddcd48f89..96b6739b19 100644
--- a/cop.h
+++ b/cop.h
@@ -423,6 +423,32 @@ struct cop {
U32 cop_features;
};
+/*
+=for apidoc Am|const char *|CopFILE|const COP * c
+Returns the name of the file associated with the C<COP> C<c>
+
+=for apidoc Am|STRLEN|CopLINE|const COP * c
+Returns the line number in the source code associated with the C<COP> C<c>
+
+=for apidoc Am|AV *|CopFILEAV|const COP * c
+Returns the AV associated with the C<COP> C<c>
+
+=for apidoc Am|SV *|CopFILESV|const COP * c
+Returns the SV associated with the C<COP> C<c>
+
+=for apidoc Am|void|CopFILE_set|COP * c|const char * pv
+Makes C<pv> the name of the file associated with the C<COP> C<c>
+
+=for apidoc Am|GV *|CopFILEGV|const COP * c
+Returns the GV associated with the C<COP> C<c>
+
+=for apidoc CopFILEGV_set
+Available only on unthreaded perls. Makes C<pv> the name of the file
+associated with the C<COP> C<c>
+
+=cut
+*/
+
#ifdef USE_ITHREADS
# define CopFILE(c) ((c)->cop_file)
# define CopFILEGV(c) (CopFILE(c) \