From add0fa588474394597ad4b9734b2d1646a7b225e Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Sat, 29 Aug 2020 10:55:02 -0600 Subject: Document various CopFILEfoo functions --- cop.h | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'cop.h') 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 C + +=for apidoc Am|STRLEN|CopLINE|const COP * c +Returns the line number in the source code associated with the C C + +=for apidoc Am|AV *|CopFILEAV|const COP * c +Returns the AV associated with the C C + +=for apidoc Am|SV *|CopFILESV|const COP * c +Returns the SV associated with the C C + +=for apidoc Am|void|CopFILE_set|COP * c|const char * pv +Makes C the name of the file associated with the C C + +=for apidoc Am|GV *|CopFILEGV|const COP * c +Returns the GV associated with the C C + +=for apidoc CopFILEGV_set +Available only on unthreaded perls. Makes C the name of the file +associated with the C C + +=cut +*/ + #ifdef USE_ITHREADS # define CopFILE(c) ((c)->cop_file) # define CopFILEGV(c) (CopFILE(c) \ -- cgit v1.2.1