summaryrefslogtreecommitdiff
path: root/sv.h
diff options
context:
space:
mode:
authorSteffen Mueller <smueller@cpan.org>2009-06-13 12:20:31 +0200
committerSteffen Mueller <smueller@cpan.org>2009-06-13 12:20:31 +0200
commitc0b6140e88943756b7fb000be354186a3d2d4398 (patch)
treeb98bc66e89832f3141c48b97a24aaf534c848ece /sv.h
parenta9df907534624f5a282220122d2c911bddcc08da (diff)
downloadperl-c0b6140e88943756b7fb000be354186a3d2d4398.tar.gz
Make SvOK and SvTRUE API docs slightly less utterly confusing
Diffstat (limited to 'sv.h')
-rw-r--r--sv.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/sv.h b/sv.h
index a1e990a255..243b798e85 100644
--- a/sv.h
+++ b/sv.h
@@ -599,8 +599,8 @@ double. Checks the B<private> setting. Use C<SvNIOK> instead.
Unsets the NV/IV status of an SV.
=for apidoc Am|U32|SvOK|SV* sv
-Returns a U32 value indicating whether the value is an SV. It also tells
-whether the value is defined or not.
+Returns a U32 value indicating whether the value is defined. This is
+only meaningful for scalars.
=for apidoc Am|U32|SvIOKp|SV* sv
Returns a U32 value indicating whether the SV contains an integer. Checks
@@ -1465,7 +1465,7 @@ otherwise use the more efficient C<SvUV>.
=for apidoc Am|bool|SvTRUE|SV* sv
Returns a boolean indicating whether Perl would evaluate the SV as true or
-false, defined or undefined. Does not handle 'get' magic.
+false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
Like C<SvPV_force>, but converts sv to utf8 first if necessary.