From: Gurusamy Sarathy Date: Tue, 8 Feb 2000 07:51:20 +0000 (+0000) Subject: documentation patches (from Michael Schwern and Yitzchak X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=96f1132bd42b8b1255f98b7e95b1ed46ae0eff5c;p=p5sagit%2Fp5-mst-13.2.git documentation patches (from Michael Schwern and Yitzchak Scott-Thoennes) p4raw-id: //depot/perl@5040 --- diff --git a/av.c b/av.c index 511d4d3..29afaff 100644 --- a/av.c +++ b/av.c @@ -167,8 +167,8 @@ Returns the SV at the specified index in the array. The C is the index. If C is set then the fetch will be part of a store. Check that the return value is non-null before dereferencing it to a C. -See L for more information -on how to use this function on tied arrays. +See L for +more information on how to use this function on tied arrays. =cut */ @@ -231,7 +231,7 @@ that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned NULL. -See L for +See L for more information on how to use this function on tied arrays. =cut diff --git a/hv.c b/hv.c index e3f3d95..435b10d 100644 --- a/hv.c +++ b/hv.c @@ -113,7 +113,7 @@ C is the length of the key. If C is set then the fetch will be part of a store. Check that the return value is non-null before dereferencing it to a C. -See L for more +See L for more information on how to use this function on tied hashes. =cut @@ -209,7 +209,7 @@ accessing it. The return value when C is a tied hash is a pointer to a static location, so be sure to make a copy of the structure if you need to store it somewhere. -See L for more +See L for more information on how to use this function on tied hashes. =cut @@ -336,7 +336,7 @@ be dereferenced to get the original C. Note that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned NULL. -See L for more +See L for more information on how to use this function on tied hashes. =cut @@ -425,7 +425,7 @@ described here. Note that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned NULL. -See L for more +See L for more information on how to use this function on tied hashes. =cut diff --git a/lib/UNIVERSAL.pm b/lib/UNIVERSAL.pm index 13cce58..f2f1fe9 100644 --- a/lib/UNIVERSAL.pm +++ b/lib/UNIVERSAL.pm @@ -62,19 +62,23 @@ The C and C methods can also be called as subroutines =item UNIVERSAL::isa ( VAL, TYPE ) -C returns I if the first argument is a reference and either -of the following statements is true. +C returns I if one of the following statements is true. =over 8 =item * -C is a blessed reference and is blessed into package C -or inherits from package C +C is a reference blessed into either package C or a package +which inherits from package C. =item * -C is a reference to a C of perl variable (er 'HASH') +C is a reference to a C of Perl variable (e.g. 'HASH'). + +=item * + +C is the name of a package that inherits from (or is itself) +package C. =back diff --git a/pod/perlapi.pod b/pod/perlapi.pod index 063cffc..e6191c0 100644 --- a/pod/perlapi.pod +++ b/pod/perlapi.pod @@ -45,8 +45,8 @@ Returns the SV at the specified index in the array. The C is the index. If C is set then the fetch will be part of a store. Check that the return value is non-null before dereferencing it to a C. -See L for more information -on how to use this function on tied arrays. +See L for +more information on how to use this function on tied arrays. SV** av_fetch(AV* ar, I32 key, I32 lval) @@ -95,7 +95,7 @@ that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned NULL. -See L for +See L for more information on how to use this function on tied arrays. SV** av_store(AV* ar, I32 key, SV* val) @@ -548,7 +548,7 @@ C is the length of the key. If C is set then the fetch will be part of a store. Check that the return value is non-null before dereferencing it to a C. -See L for more +See L for more information on how to use this function on tied hashes. SV** hv_fetch(HV* tb, const char* key, U32 klen, I32 lval) @@ -563,7 +563,7 @@ accessing it. The return value when C is a tied hash is a pointer to a static location, so be sure to make a copy of the structure if you need to store it somewhere. -See L for more +See L for more information on how to use this function on tied hashes. HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash) @@ -632,7 +632,7 @@ be dereferenced to get the original C. Note that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned NULL. -See L for more +See L for more information on how to use this function on tied hashes. SV** hv_store(HV* tb, const char* key, U32 klen, SV* val, U32 hash) @@ -649,7 +649,7 @@ described here. Note that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned NULL. -See L for more +See L for more information on how to use this function on tied hashes. HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)