document args of Perl_do_sv_dump()
authorDavid Mitchell <davem@iabyn.com>
Wed, 2 Mar 2016 17:29:31 +0000 (17:29 +0000)
committerDavid Mitchell <davem@iabyn.com>
Wed, 2 Mar 2016 17:29:31 +0000 (17:29 +0000)
dump.c

diff --git a/dump.c b/dump.c
index bc2776a..dcc00f5 100644 (file)
--- a/dump.c
+++ b/dump.c
@@ -1423,6 +1423,16 @@ const struct flag_to_name regexp_core_intflags_names[] = {
     {PREGf_ANCH_GPOS,       "ANCH_GPOS,"},
 };
 
+/* Perl_do_sv_dump():
+ *
+ * level:   amount to indent the output
+ * sv:      the object to dump
+ * nest:    the current level of recursion
+ * maxnest: the maximum allowed level of recursion
+ * dumpops: if true, also dump the ops associated with a CV
+ * pvlim:   limit on the length of any strings that are output
+ * */
+
 void
 Perl_do_sv_dump(pTHX_ I32 level, PerlIO *file, SV *sv, I32 nest, I32 maxnest, bool dumpops, STRLEN pvlim)
 {