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 /op.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 'op.h')
-rw-r--r-- | op.h | 24 |
1 files changed, 12 insertions, 12 deletions
@@ -613,7 +613,7 @@ struct loop { Given the root of an optree, link the tree in execution order using the C<op_next> pointers and return the first op executed. If this has already been done, it will not be redone, and C<< o->op_next >> will be -returned. If C<< o->op_next >> is not already set, I<o> should be at +returned. If C<< o->op_next >> is not already set, C<o> should be at least an C<UNOP>. =cut @@ -712,30 +712,30 @@ struct block_hooks { Return the BHK's flags. =for apidoc mx|void *|BhkENTRY|BHK *hk|which -Return an entry from the BHK structure. I<which> is a preprocessor token +Return an entry from the BHK structure. C<which> is a preprocessor token indicating which entry to return. If the appropriate flag is not set this will return NULL. The type of the return value depends on which entry you ask for. =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr Set an entry in the BHK structure, and set the flags to indicate it is -valid. I<which> is a preprocessing token indicating which entry to set. -The type of I<ptr> depends on the entry. +valid. C<which> is a preprocessing token indicating which entry to set. +The type of C<ptr> depends on the entry. =for apidoc Amx|void|BhkDISABLE|BHK *hk|which Temporarily disable an entry in this BHK structure, by clearing the -appropriate flag. I<which> is a preprocessor token indicating which +appropriate flag. C<which> is a preprocessor token indicating which entry to disable. =for apidoc Amx|void|BhkENABLE|BHK *hk|which Re-enable an entry in this BHK structure, by setting the appropriate -flag. I<which> is a preprocessor token indicating which entry to enable. +flag. C<which> is a preprocessor token indicating which entry to enable. This will assert (under -DDEBUGGING) if the entry doesn't contain a valid pointer. =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg -Call all the registered block hooks for type I<which>. I<which> is a -preprocessing token; the type of I<arg> depends on I<which>. +Call all the registered block hooks for type C<which>. C<which> is a +preprocessing token; the type of C<arg> depends on C<which>. =cut */ @@ -810,19 +810,19 @@ preprocessing token; the type of I<arg> depends on I<which>. Return the XOP's flags. =for apidoc Am||XopENTRY|XOP *xop|which -Return a member of the XOP structure. I<which> is a cpp token +Return a member of the XOP structure. C<which> is a cpp token indicating which entry to return. If the member is not set this will return a default value. The return type depends -on I<which>. This macro evaluates its arguments more than +on C<which>. This macro evaluates its arguments more than once. If you are using C<Perl_custom_op_xop> to retreive a C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead. =for apidoc Am||XopENTRYCUSTOM|const OP *o|which Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more -efficient. The I<which> parameter is identical to L</XopENTRY>. +efficient. The C<which> parameter is identical to L</XopENTRY>. =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value -Set a member of the XOP structure. I<which> is a cpp token +Set a member of the XOP structure. C<which> is a cpp token indicating which entry to set. See L<perlguts/"Custom Operators"> for details about the available members and how they are used. This macro evaluates its argument |