svn: /phpdoc/en/trunk/reference/judy/judy/ offsetexists.xml offsetget.xml offsetset.xml offsetunset.xml
| From: | Nicolas Brousse | Date: | Mon, 25 Oct 2010 21:43:45 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/judy/judy/ offsetexists.xml offsetget.xml offsetset.xml offsetunset.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7338@lists.php.net to get a copy of this message | ||
nicolas Mon, 25 Oct 2010 21:43:45 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=304895
Log:
update doc for judy array access methods (offset*)
Changed paths:
U phpdoc/en/trunk/reference/judy/judy/offsetexists.xml
U phpdoc/en/trunk/reference/judy/judy/offsetget.xml
U phpdoc/en/trunk/reference/judy/judy/offsetset.xml
U phpdoc/en/trunk/reference/judy/judy/offsetunset.xml
Modified: phpdoc/en/trunk/reference/judy/judy/offsetexists.xml
===================================================================
--- phpdoc/en/trunk/reference/judy/judy/offsetexists.xml 2010-10-25 21:41:15 UTC (rev 304894)
+++ phpdoc/en/trunk/reference/judy/judy/offsetexists.xml 2010-10-25 21:43:45 UTC (rev 304895)
@@ -4,21 +4,19 @@
<refentry xml:id="judy.offsetexists" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Judy::offsetExists</refname>
- <refpurpose>The offsetExists purpose</refpurpose>
+ <refpurpose>Whether a offset exists</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>void</type><methodname>Judy::offsetExists</methodname>
-
<methodparam><type>string</type><parameter>offset</parameter></methodparam>
+ <modifier>public</modifier>
<type>bool</type><methodname>Judy::offsetExists</methodname>
+
<methodparam><type>mixed</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
-
+ Whether or not an offset exists.
</para>
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -28,7 +26,7 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
-
+ An offset to check for.
</para>
</listitem>
</varlistentry>
@@ -38,7 +36,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns TRUE on success or FALSE on failure.
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/judy/judy/offsetget.xml
===================================================================
--- phpdoc/en/trunk/reference/judy/judy/offsetget.xml 2010-10-25 21:41:15 UTC (rev 304894)
+++ phpdoc/en/trunk/reference/judy/judy/offsetget.xml 2010-10-25 21:43:45 UTC (rev 304895)
@@ -4,21 +4,19 @@
<refentry xml:id="judy.offsetget" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Judy::offsetGet</refname>
- <refpurpose>The offsetGet purpose</refpurpose>
+ <refpurpose>Offset to retrieve</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>void</type><methodname>Judy::offsetGet</methodname>
-
<methodparam><type>string</type><parameter>offset</parameter></methodparam>
+ <modifier>public</modifier>
<type>mixed</type><methodname>Judy::offsetGet</methodname>
+
<methodparam><type>mixed</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
-
+ Returns the value at specified offset.
</para>
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -28,7 +26,7 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
-
+ The offset to retrieve.
</para>
</listitem>
</varlistentry>
@@ -38,7 +36,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Can return all value types.
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/judy/judy/offsetset.xml
===================================================================
--- phpdoc/en/trunk/reference/judy/judy/offsetset.xml 2010-10-25 21:41:15 UTC (rev 304894)
+++ phpdoc/en/trunk/reference/judy/judy/offsetset.xml 2010-10-25 21:43:45 UTC (rev 304895)
@@ -4,22 +4,20 @@
<refentry xml:id="judy.offsetset" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Judy::offsetSet</refname>
- <refpurpose>The offsetSet purpose</refpurpose>
+ <refpurpose>Offset to set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type><methodname>Judy::offsetSet</methodname>
-
<methodparam><type>string</type><parameter>offset</parameter></methodparam>
-
<methodparam><type>string</type><parameter>value</parameter></methodparam>
+
<methodparam><type>mixed</type><parameter>offset</parameter></methodparam>
+
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
-
+ Assigns a value to the specified offset.
</para>
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -29,7 +27,7 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
-
+ The offset to assign the value to.
</para>
</listitem>
</varlistentry>
@@ -37,7 +35,7 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
-
+ The value to set.
</para>
</listitem>
</varlistentry>
@@ -47,7 +45,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ No value is returned.
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/judy/judy/offsetunset.xml
===================================================================
--- phpdoc/en/trunk/reference/judy/judy/offsetunset.xml 2010-10-25 21:41:15 UTC (rev 304894)
+++ phpdoc/en/trunk/reference/judy/judy/offsetunset.xml 2010-10-25 21:43:45 UTC (rev 304895)
@@ -4,21 +4,19 @@
<refentry xml:id="judy.offsetunset" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Judy::offsetUnset</refname>
- <refpurpose>The offsetUnset purpose</refpurpose>
+ <refpurpose>Offset to unset</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type><methodname>Judy::offsetUnset</methodname>
-
<methodparam><type>string</type><parameter>offset</parameter></methodparam>
+
<methodparam><type>mixed</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
-
+ Unsets an offset.
</para>
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -28,7 +26,7 @@
<term><parameter>offset</parameter></term>
<listitem>
<para>
-
+ The offset to unset.
</para>
</listitem>
</varlistentry>
@@ -38,7 +36,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ No value is returned.
</para>
</refsect1>