From 796b6530911f5ebd6a26275873610304e63d5d19 Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Thu, 7 May 2015 10:58:54 -0600 Subject: Various pods: Add C<> around many typed-as-is things Removes 'the' in front of parameter names in some instances. --- gv.c | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) (limited to 'gv.c') diff --git a/gv.c b/gv.c index 5b7d9e1caa..15b493d223 100644 --- a/gv.c +++ b/gv.c @@ -142,7 +142,7 @@ Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen, If C is a typeglob whose subroutine entry is a constant sub eligible for inlining, or C is a placeholder reference that would be promoted to such a typeglob, then returns the value returned by the sub. Otherwise, returns -NULL. +C. =cut */ @@ -304,8 +304,8 @@ Perl_cvstash_set(pTHX_ CV *cv, HV *st) Converts a scalar into a typeglob. This is an incoercible typeglob; assigning a reference to it will assign to one of its slots, instead of -overwriting it as happens with typeglobs created by SvSetSV. Converting -any scalar that is SvOK() may produce unpredictable results and is reserved +overwriting it as happens with typeglobs created by C. Converting +any scalar that is C may produce unpredictable results and is reserved for perl's internal use. C is the scalar to be converted. @@ -318,25 +318,25 @@ stash element, it is the caller's responsibility to ensure that the name passed to this function matches the name of the element. If it does not match, perl's internal bookkeeping will get out of sync. -C can be set to SVf_UTF8 if C is a UTF8 string, or +C can be set to C if C is a UTF8 string, or the return value of SvUTF8(sv). It can also take the -GV_ADDMULTI flag, which means to pretend that the GV has been +C flag, which means to pretend that the GV has been seen before (i.e., suppress "Used once" warnings). =for apidoc gv_init -The old form of gv_init_pvn(). It does not work with UTF8 strings, as it +The old form of C. It does not work with UTF8 strings, as it has no flags parameter. If the C parameter is set, the -GV_ADDMULTI flag will be passed to gv_init_pvn(). +C flag will be passed to C. =for apidoc gv_init_pv -Same as gv_init_pvn(), but takes a nul-terminated string for the name +Same as C, but takes a nul-terminated string for the name instead of separate char * and length parameters. =for apidoc gv_init_sv -Same as gv_init_pvn(), but takes an SV * for the name instead of separate +Same as C, but takes an SV * for the name instead of separate char * and length parameters. C is currently unused. =cut @@ -669,16 +669,16 @@ Perl_gv_fetchmeth_pv(pTHX_ HV *stash, const char *name, I32 level, U32 flags) Returns the glob with the given C and a defined subroutine or C. The glob lives in the given C, or in the stashes -accessible via @ISA and UNIVERSAL::. +accessible via C<@ISA> and C. The argument C should be either 0 or -1. If C, as a side-effect creates a glob with the given C in the given C which in the case of success contains an alias for the subroutine, and sets up caching info for this glob. -The only significant values for C are GV_SUPER and SVf_UTF8. +The only significant values for C are C and C. -GV_SUPER indicates that we want to look up the method in the superclasses +C indicates that we want to look up the method in the superclasses of the C. The @@ -909,14 +909,14 @@ Perl_gv_fetchmeth_pv_autoload(pTHX_ HV *stash, const char *name, I32 level, U32 /* =for apidoc gv_fetchmeth_pvn_autoload -Same as gv_fetchmeth_pvn(), but looks for autoloaded subroutines too. +Same as C, but looks for autoloaded subroutines too. Returns a glob for the subroutine. For an autoloaded subroutine without a GV, will create a GV even -if C. For an autoloaded subroutine without a stub, GvCV() +if C. For an autoloaded subroutine without a stub, C of the result may be zero. -Currently, the only significant value for C is SVf_UTF8. +Currently, the only significant value for C is C. =cut */ @@ -958,7 +958,7 @@ Perl_gv_fetchmeth_pvn_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I3 Returns the glob which contains the subroutine to call to invoke the method on the C. In fact in the presence of autoloading this may be the -glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is +glob for "AUTOLOAD". In this case the corresponding variable C<$AUTOLOAD> is already setup. The third parameter of C determines whether @@ -971,7 +971,7 @@ These functions grant C<"SUPER"> token as a prefix of the method name. Note that if you want to keep the returned glob for a long time, you need to check for it being "AUTOLOAD", since at the later time the call may load a -different subroutine due to $AUTOLOAD changing its value. Use the glob +different subroutine due to C<$AUTOLOAD> changing its value. Use the glob created as a side effect to do this. These functions have the same side-effects as C with @@ -1364,7 +1364,7 @@ Returns a pointer to the stash for a specified package. The C parameter indicates the length of the C, in bytes. C is passed to C, so if set to C then the package will be created if it does not already exist. If the package does not exist and -C is 0 (or any other setting that does not create packages) then NULL +C is 0 (or any other setting that does not create packages) then C is returned. Flags may be one of: @@ -1376,7 +1376,7 @@ Flags may be one of: GV_NOEXPAND GV_ADDMG -The most important of which are probably GV_ADD and SVf_UTF8. +The most important of which are probably C and C. Note, use of C instead of C where possible is strongly recommended for performance reasons. -- cgit v1.2.1