From db8088a4bceca06fff66f246b5f4247ed155f0c8 Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Fri, 18 Jul 2003 08:31:09 +0000 Subject: [PATCH] Properly document the word "element" as an array key/value pair, and "value" as the value. This almost closes bug #20394 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@135353 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/array/functions/current.xml | 24 +++++++++++++++++++++--- reference/array/functions/end.xml | 5 +++-- reference/array/functions/next.xml | 26 +++++++++++++++++++++----- reference/array/functions/prev.xml | 21 +++++++++++++++++++-- 4 files changed, 64 insertions(+), 12 deletions(-) diff --git a/reference/array/functions/current.xml b/reference/array/functions/current.xml index 8ddb7c5c92..eecf044969 100644 --- a/reference/array/functions/current.xml +++ b/reference/array/functions/current.xml @@ -1,5 +1,5 @@ - + @@ -19,8 +19,8 @@ The current function simply returns the - array element that's currently being pointed by the internal - pointer. It does not move the pointer in any way. If the + value of the array element that's currently being pointed to by the + internal pointer. It does not move the pointer in any way. If the internal pointer points beyond the end of the elements list, current returns &false;. @@ -35,6 +35,24 @@ + + + Example use of <function>current</function> and friends + + +]]> + + + See also end, key, next, prev, and diff --git a/reference/array/functions/end.xml b/reference/array/functions/end.xml index 1e3c218500..dba5d33128 100644 --- a/reference/array/functions/end.xml +++ b/reference/array/functions/end.xml @@ -1,5 +1,5 @@ - + @@ -16,7 +16,8 @@ end advances array's - internal pointer to the last element, and returns that element. + internal pointer to the last element, and returns the value from + the last element. diff --git a/reference/array/functions/next.xml b/reference/array/functions/next.xml index 0c55e2fcb7..bc53b884f0 100644 --- a/reference/array/functions/next.xml +++ b/reference/array/functions/next.xml @@ -1,5 +1,5 @@ - + @@ -15,15 +15,14 @@ arrayarray - Returns the array element in the next place that's pointed by the - internal array pointer, or &false; if - there are no more elements. + Returns the array value in the next place that's pointed to by the + internal array pointer, or &false; if there are no more elements. next behaves like current, with one difference. It advances the internal array pointer one place forward before returning the - element. That means it returns the next array element and + element value. That means it returns the next array value and advances the internal array pointer by one. If advancing the internal array pointer results in going beyond the end of the element list, next returns &false;. @@ -37,6 +36,23 @@ + + + Example use of <function>next</function> and friends + + +]]> + + + See also current, end, diff --git a/reference/array/functions/prev.xml b/reference/array/functions/prev.xml index 8b53e59916..4f337902e4 100644 --- a/reference/array/functions/prev.xml +++ b/reference/array/functions/prev.xml @@ -1,5 +1,5 @@ - + @@ -13,7 +13,7 @@ arrayarray - Returns the array element in the previous place that's pointed by + Returns the array value in the previous place that's pointed to by the internal array pointer, or &false; if there are no more elements. @@ -30,6 +30,23 @@ next, except it rewinds the internal array pointer one place instead of advancing it. + + + Example use of <function>prev</function> and friends + + +]]> + + + See also current, end, next, and reset.