diff options
author | Karl Williamson <khw@cpan.org> | 2015-05-07 10:28:43 -0600 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2015-08-01 10:18:10 -0600 |
commit | 2d7f66116e374c78dcf18cb5b9fea7b79ac82b5b (patch) | |
tree | be7e0e18124a1314dcf01c1df236e5586bf91196 /sv.h | |
parent | 5133491184c815a15d098dfeddfa457530fb362d (diff) | |
download | perl-2d7f66116e374c78dcf18cb5b9fea7b79ac82b5b.tar.gz |
perlapi: Use C<> instead of I<> for parameter names, etc
The majority of perlapi uses C<> to specify these things, but a few
things used I<> instead. Standardize to C<>.
Diffstat (limited to 'sv.h')
-rw-r--r-- | sv.h | 18 |
1 files changed, 9 insertions, 9 deletions
@@ -278,7 +278,7 @@ All of the following SvREFCNT_inc* macros are optimized versions of SvREFCNT_inc, and can be replaced with SvREFCNT_inc. =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv -Same as SvREFCNT_inc, but can only be used if you know I<sv> +Same as SvREFCNT_inc, but can only be used if you know C<sv> is not NULL. Since we don't have to check the NULLness, it's faster and smaller. @@ -288,7 +288,7 @@ return value. The macro doesn't need to return a meaningful value. =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv Same as SvREFCNT_inc, but can only be used if you don't need the return -value, and you know that I<sv> is not NULL. The macro doesn't need +value, and you know that C<sv> is not NULL. The macro doesn't need to return a meaningful value, or check for NULLness, so it's smaller and faster. @@ -297,7 +297,7 @@ Same as SvREFCNT_inc, but can only be used with expressions without side effects. Since we don't have to store a temporary value, it's faster. =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv -Same as SvREFCNT_inc_simple, but can only be used if you know I<sv> +Same as SvREFCNT_inc_simple, but can only be used if you know C<sv> is not NULL. Since we don't have to check the NULLness, it's faster and smaller. @@ -307,15 +307,15 @@ return value. The macro doesn't need to return a meaningful value. =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv Same as SvREFCNT_inc, but can only be used if you don't need the return -value, and you know that I<sv> is not NULL. The macro doesn't need +value, and you know that C<sv> is not NULL. The macro doesn't need to return a meaningful value, or check for NULLness, so it's smaller and faster. =for apidoc Am|void|SvREFCNT_dec|SV* sv -Decrements the reference count of the given SV. I<sv> may be NULL. +Decrements the reference count of the given SV. C<sv> may be NULL. =for apidoc Am|void|SvREFCNT_dec_NN|SV* sv -Same as SvREFCNT_dec, but can only be used if you know I<sv> +Same as SvREFCNT_dec, but can only be used if you know C<sv> is not NULL. Since we don't have to check the NULLness, it's faster and smaller. @@ -2156,11 +2156,11 @@ Creates a new SV containing the pad name. /* =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len -Reads into I<len> the offset from SvPVX back to the true start of the +Reads into C<len> the offset from SvPVX back to the true start of the allocated buffer, which will be non-zero if C<sv_chop> has been used to efficiently remove characters from start of the buffer. Implemented as a -macro, which takes the address of I<len>, which must be of type C<STRLEN>. -Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false. +macro, which takes the address of C<len>, which must be of type C<STRLEN>. +Evaluates C<sv> more than once. Sets C<len> to 0 if C<SvOOK(sv)> is false. =cut */ |