didou Thu Nov 13 08:04:09 2003 EDT
Modified files:
/phpdoc/en/reference/dba/functions dba-key-split.xml
Log:
correct the types
clarify the function purpose (was buggy)
reformat see also and put it in the end of the reference
Index: phpdoc/en/reference/dba/functions/dba-key-split.xml
diff -u phpdoc/en/reference/dba/functions/dba-key-split.xml:1.1
phpdoc/en/reference/dba/functions/dba-key-split.xml:1.2
--- phpdoc/en/reference/dba/functions/dba-key-split.xml:1.1 Thu Nov 13 04:40:08
2003
+++ phpdoc/en/reference/dba/functions/dba-key-split.xml Thu Nov 13 08:04:09 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
<refentry id="function.dba-key-split">
<refnamediv>
@@ -9,20 +9,16 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>array|false</type><methodname>dba_key_split</methodname>
- <methodparam><type>string|false</type><parameter>key</parameter></methodparam>
+ <type>mixed</type><methodname>dba_key_split</methodname>
+ <methodparam><type>mixed</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
- <function>dba_key_split</function> returns &false; if key is NULL of
- &false; or an array of the form array(0=>group,1=>value_name).
+ <function>dba_key_split</function> returns an array of the form
+ array(0=>group,1=>value_name). This function will return &false;
+ if <parameter>key</parameter> is &null; or &false;.
</para>
<para>
- <parameter>key</parameter> the key in string representation.
- </para>
- <para>
- See also:
- <function>dba_firstkey</function>, <function>dba_nextkey</function>
- and <function>dba_fetch</function>.
+ <parameter>key</parameter> is the key in string representation.
</para>
<para>
<note>
@@ -30,6 +26,12 @@
This function is available since PHP 5.0.0.
</simpara>
</note>
+ </para>
+ <para>
+ See also
+ <function>dba_firstkey</function>,
+ <function>dba_nextkey</function> and
+ <function>dba_fetch</function>.
</para>
</refsect1>
</refentry>
