develooper Front page | perl.perl5.porters | Postings from January 2013

Re: [perl #116366] [PATCH] better POD for unpackstring

Thread Previous | Thread Next
From:
Dave Mitchell
Date:
January 18, 2013 11:45
Subject:
Re: [perl #116366] [PATCH] better POD for unpackstring
Message ID:
20130118114541.GA13982@iabyn.com
On Mon, Jan 14, 2013 at 11:22:45AM -0800, bulk88 via RT wrote:
[ stuff ]

Ok how about the following instead:

/*
=for apidoc unpackstring

The engine implementing the unpack() Perl function.

Using the template pat..patend, this function unpacks the string
s..strend into a number of mortal SVs, which it pushes onto the perl
argument (@_) stack (so you will need to issue a C<PUTBACK> before and
C<SPAGAIN> after the call to this function). It returns the number of
pushed elements.

The strend and patend pointers should point to the byte following the last
character of each string.

Although this function returns its values on the perl argument stack, it
doesn't take any parameters from that stack (and thus in particular
there's no need to do a PUSHMARK before calling it, unlike L</call_pv> for
example).

=cut */

(With the above, the flags arg is still undocumented)

-- 
"Procrastination grows to fill the available time"
    -- Mitchell's corollary to Parkinson's Law

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About