This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document SvOOK_off
[perl5.git] / sv.h
diff --git a/sv.h b/sv.h
index 2538741..59ef698 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -961,6 +961,16 @@ Returns the vstring magic, or NULL if none
 
 #define SvOOK(sv)              (SvFLAGS(sv) & SVf_OOK)
 #define SvOOK_on(sv)           (SvFLAGS(sv) |= SVf_OOK)
+
+
+/*
+=for apidoc Am|void|SvOOK_off|SV * sv
+
+Remove any string offset.
+
+=cut
+*/
+
 #define SvOOK_off(sv)          ((void)(SvOOK(sv) && (sv_backoff(sv),0)))
 
 #define SvFAKE(sv)             (SvFLAGS(sv) & SVf_FAKE)