cvs: phpdoc /en/reference/hw/functions hw-array2objrec.xml hw-cp.xml hw-getobject.xml hw-getremotechildren.xml hw-insertobject.xml hw-mapid.xml
hw-mv.xml hw-objrec2array.xml

dams Tue Feb 18 10:30:56 2003 EDT Modified files: /phpdoc/en/reference/hw/functions hw-array2objrec.xml hw-cp.xml hw-getobject.xml hw-getremotechildren.xml hw-insertobject.xml hw-mapid.xml hw-mv.xml hw-objrec2array.xml Log: Proto minor change : removing space in parameter name

Index: phpdoc/en/reference/hw/functions/hw-array2objrec.xml diff -u phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.2 phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.3 --- phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.2 Wed Apr 17 02:38:30 2002 +++ phpdoc/en/reference/hw/functions/hw-array2objrec.xml Tue Feb 18 10:30:56 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> <refentry id="function.hw-array2objrec"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>strin</type><methodname>hw_array2objrec</methodname> + <type>string</type><methodname>hw_array2objrec</methodname> <methodparam><type>array</type><parameter>object_array</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/hw/functions/hw-cp.xml diff -u phpdoc/en/reference/hw/functions/hw-cp.xml:1.2 phpdoc/en/reference/hw/functions/hw-cp.xml:1.3 --- phpdoc/en/reference/hw/functions/hw-cp.xml:1.2 Wed Apr 17 02:38:31 2002 +++ phpdoc/en/reference/hw/functions/hw-cp.xml Tue Feb 18 10:30:56 2003 @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> <refentry id="function.hw-cp"> <refnamediv> - <refname>hw_Cp</refname> - <refpurpose>copies objects</refpurpose> + <refname>hw_cp</refname> + <refpurpose>Copies objects</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,7 +12,7 @@ <type>int</type><methodname>hw_cp</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> <methodparam><type>array</type><parameter>object_id_array</parameter></methodparam> - <methodparam><type>int</type><parameter>destination id</parameter></methodparam> + <methodparam><type>int</type><parameter>destination_id</parameter></methodparam> </methodsynopsis> <para> Copies the objects with object ids as specified in the second Index: phpdoc/en/reference/hw/functions/hw-getobject.xml diff -u phpdoc/en/reference/hw/functions/hw-getobject.xml:1.3 phpdoc/en/reference/hw/functions/hw-getobject.xml:1.4 --- phpdoc/en/reference/hw/functions/hw-getobject.xml:1.3 Tue Feb 4 21:15:39 2003 +++ phpdoc/en/reference/hw/functions/hw-getobject.xml Tue Feb 18 10:30:56 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> <refentry id="function.hw-getobject"> <refnamediv> @@ -7,7 +7,7 @@ <refpurpose>object record</refpurpose> </refnamediv> <refsect1> - <title>Description</title> + <title>hw_getobject</title> <methodsynopsis> <type>array</type><methodname>hw_getobject</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> Index: phpdoc/en/reference/hw/functions/hw-getremotechildren.xml diff -u phpdoc/en/reference/hw/functions/hw-getremotechildren.xml:1.2 phpdoc/en/reference/hw/functions/hw-getremotechildren.xml:1.3 --- phpdoc/en/reference/hw/functions/hw-getremotechildren.xml:1.2 Wed Apr 17 02:38:38 2002 +++ phpdoc/en/reference/hw/functions/hw-getremotechildren.xml Tue Feb 18 10:30:56 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> <refentry id="function.hw-getremotechildren"> <refnamediv> - <refname>hw_GetRemoteChildren</refname> + <refname>hw_getremotechildren</refname> <refpurpose>Gets children of remote document</refpurpose> </refnamediv> <refsect1> @@ -11,7 +11,7 @@ <methodsynopsis> <type>int</type><methodname>hw_getremotechildren</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - <methodparam><type>string</type><parameter>object record</parameter></methodparam> + <methodparam><type>string</type><parameter>object_record</parameter></methodparam> </methodsynopsis> <para> Returns the children of a remote document. Children of a remote Index: phpdoc/en/reference/hw/functions/hw-insertobject.xml diff -u phpdoc/en/reference/hw/functions/hw-insertobject.xml:1.2 phpdoc/en/reference/hw/functions/hw-insertobject.xml:1.3 --- phpdoc/en/reference/hw/functions/hw-insertobject.xml:1.2 Wed Apr 17 02:38:40 2002 +++ phpdoc/en/reference/hw/functions/hw-insertobject.xml Tue Feb 18 10:30:56 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> <refentry id="function.hw-insertobject"> <refnamediv> @@ -11,7 +11,7 @@ <methodsynopsis> <type>int</type><methodname>hw_insertobject</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - <methodparam><type>string</type><parameter>object rec</parameter></methodparam> + <methodparam><type>string</type><parameter>object_rec</parameter></methodparam> <methodparam><type>string</type><parameter>parameter</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc/en/reference/hw/functions/hw-mapid.xml diff -u phpdoc/en/reference/hw/functions/hw-mapid.xml:1.2 phpdoc/en/reference/hw/functions/hw-mapid.xml:1.3 --- phpdoc/en/reference/hw/functions/hw-mapid.xml:1.2 Wed Apr 17 02:38:40 2002 +++ phpdoc/en/reference/hw/functions/hw-mapid.xml Tue Feb 18 10:30:56 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> <refentry id="function.hw-mapid"> <refnamediv> @@ -11,8 +11,8 @@ <methodsynopsis> <type>int</type><methodname>hw_mapid</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - <methodparam><type>int</type><parameter>server id</parameter></methodparam> - <methodparam><type>int</type><parameter>object id</parameter></methodparam> + <methodparam><type>int</type><parameter>server_id</parameter></methodparam> + <methodparam><type>int</type><parameter>object_id</parameter></methodparam> </methodsynopsis> <para> Maps a global object id on any hyperwave server, even those Index: phpdoc/en/reference/hw/functions/hw-mv.xml diff -u phpdoc/en/reference/hw/functions/hw-mv.xml:1.2 phpdoc/en/reference/hw/functions/hw-mv.xml:1.3 --- phpdoc/en/reference/hw/functions/hw-mv.xml:1.2 Wed Apr 17 02:38:40 2002 +++ phpdoc/en/reference/hw/functions/hw-mv.xml Tue Feb 18 10:30:56 2003 @@ -1,31 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> <refentry id="function.hw-mv"> <refnamediv> - <refname>hw_Mv</refname> - <refpurpose>moves objects</refpurpose> + <refname>hw_mv</refname> + <refpurpose>Moves objects</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>hw_mv</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> - <methodparam><type>array</type><parameter>object id array</parameter></methodparam> - <methodparam><type>int</type><parameter>source id</parameter></methodparam> + <methodparam><type>array</type><parameter>object_id_array</parameter></methodparam> + <methodparam><type>int</type><parameter>source_id</parameter></methodparam> <methodparam><type>int</type><parameter>destination id</parameter></methodparam> </methodsynopsis> <para> Moves the objects with object ids as specified in the second - parameter from the collection with id <parameter>source id</parameter> - to the collection with the id <parameter>destination id</parameter>. + parameter from the collection with id <parameter>source_id</parameter> + to the collection with the id <parameter>destination_id</parameter>. If the destination id is 0 the objects will be unlinked from the source collection. If this is the last instance of that object it will be deleted. If you want to delete all instances at once, use <function>hw_deleteobject</function>. </para> <para> - The value return is the number of moved objects. + The value returned is the number of moved objects. </para> <para> See also <function>hw_cp</function>, Index: phpdoc/en/reference/hw/functions/hw-objrec2array.xml diff -u phpdoc/en/reference/hw/functions/hw-objrec2array.xml:1.2 phpdoc/en/reference/hw/functions/hw-objrec2array.xml:1.3 --- phpdoc/en/reference/hw/functions/hw-objrec2array.xml:1.2 Wed Apr 17 02:38:40 2002 +++ phpdoc/en/reference/hw/functions/hw-objrec2array.xml Tue Feb 18 10:30:56 2003 @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> <refentry id="function.hw-objrec2array"> <refnamediv> - <refname>hw_Objrec2Array</refname> - <refpurpose>convert attributes from object record to object array</refpurpose> + <refname>hw_objrec2array</refname> + <refpurpose>Convert attributes from object record to object array</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -29,7 +29,7 @@ By passing an array holding the type for each attribute you can alter this behaviour. The array is an associated array with the attribute name as its key and the value being one of - <literal>HW_ATTR_LANG</literal> or <literal>HW_ATTR_NONE</literal> + <literal>HW_ATTR_LANG</literal> or <literal>HW_ATTR_NONE</literal>. </para> <para> See also <function>hw_array2objrec</function>.