diff options
author | Father Chrysostomos <sprout@cpan.org> | 2011-07-16 14:33:27 -0700 |
---|---|---|
committer | Father Chrysostomos <sprout@cpan.org> | 2011-07-16 14:33:56 -0700 |
commit | 2baee27b98a9b7fe8a3209fb0cb6e1ab7386dfc4 (patch) | |
tree | 5090a7300447c94efdd780804092a11ac12a7296 /mg.c | |
parent | 90c87169fab88b312f4e459fd36b807eee55ed18 (diff) | |
download | perl-2baee27b98a9b7fe8a3209fb0cb6e1ab7386dfc4.tar.gz |
Clean up magic_methcall docs
This is rather unsightly, don’t you think?
magic_methcall
Invoke a magic method (like FETCH).
* sv and mg are the tied thingy and the tie magic; * meth is
the name of the method to call; * argc is the number of args
(in addition to $self) to pass to the method;
the args themselves are any values following the argc
argument. * flags:
G_DISCARD: invoke method with G_DISCARD flag and don’t
return a value
G_UNDEF_FILL: fill the stack with argc pointers to
PL_sv_undef.
Returns the SV (if any) returned by the method, or NULL on
failure.
(That’s the ‘rendered’ nroff output.)
I would have used =over/=item/=back, but autodoc.pl doesn’t seem to
like those.
Diffstat (limited to 'mg.c')
-rw-r--r-- | mg.c | 21 |
1 files changed, 14 insertions, 7 deletions
@@ -1733,13 +1733,20 @@ Perl_magic_setnkeys(pTHX_ SV *sv, MAGIC *mg) Invoke a magic method (like FETCH). -* sv and mg are the tied thingy and the tie magic; -* meth is the name of the method to call; -* argc is the number of args (in addition to $self) to pass to the method; - the args themselves are any values following the argc argument. -* flags: - G_DISCARD: invoke method with G_DISCARD flag and don't return a value - G_UNDEF_FILL: fill the stack with argc pointers to PL_sv_undef. +C<sv> and C<mg> are the tied thingy and the tie magic. + +C<meth> is the name of the method to call. + +C<argc> is the number of args (in addition to $self) to pass to the method. + +The C<flags> can be: + + G_DISCARD invoke method with G_DISCARD flag and don't + return a value + G_UNDEF_FILL fill the stack with argc pointers to + PL_sv_undef + +The arguments themselves are any values following the C<flags> argument. Returns the SV (if any) returned by the method, or NULL on failure. |