Re: [PATCH] Sv_*set() doc's and extra const's for the SvPVX_const() tasks

[email protected] (Stas Bekman) Mon, 09 May 2005 19:03:09 -0400
Newsgroups perl.perl5.porters,perl.ponie.dev
Organization Hope, Humanized
Message-ID <[email protected]>
Steve Peters wrote:
> On Sun, May 08, 2005 at 08:49:17PM -0500, Steve Peters wrote:
> 
>>The attached patch finishes up the previous task for cleaning up lvalue 
>>assignments to Sv*X() macros and converting to the Sv*_set() macros....
[...]
>  =for apidoc Am|HV*|SvSTASH|SV* sv
>  Returns the stash of the SV.
>  
> +=for apidoc Am|void|SvIV_set|SV* sv|IV val
> +Set the value of the IV pointer in sv to val.
> +
> +=for apidoc Am|void|SvNV_set|SV* sv|NV val
> +Set the value of the IV pointer in sv to val.
> +
> +=for apidoc Am|void|SvPV_set|SV* sv|char* val
> +Set the value of the PV pointer in sv to val.
> +
> +=for apidoc Am|void|SvUV_set|SV* sv|UV val
> +Set the value of the PV pointer in sv to val.
> +
> +=for apidoc Am|void|SvRV_set|SV* sv|SV* val
> +Set the value of the RV pointer in sv to val.
> +
> +=for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
> +Set the value of the MAGIC pointer in sv to val.
> +
> +=for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
> +Set the value of the STASH pointer in sv to val.
> +
>  =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
> -Set the length of the string which is in the SV.  See C<SvCUR>.
> +Set the current length of the string which is in the SV.  See C<SvCUR>.
> +
> +=for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
> +Set the actual length of the string which is in the SV.

Steve, shouldn't those docs also explain why this API should be used and 
not the old one? at least in one of those entries. Thanks.


-- 
__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:[email protected] http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com