didou Sat Feb 3 16:22:20 2007 UTC
Modified files:
/phpdoc/en/reference/w32api/functions w32api-deftype.xml
w32api-init-dtype.xml
w32api-invoke-function.xml
w32api-register-function.xml
w32api-set-call-method.xml
Log:
ref.w32api: switch to new style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/w32api/functions/w32api-deftype.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/w32api/functions/w32api-deftype.xml
diff -u phpdoc/en/reference/w32api/functions/w32api-deftype.xml:1.5
phpdoc/en/reference/w32api/functions/w32api-deftype.xml:1.6
--- phpdoc/en/reference/w32api/functions/w32api-deftype.xml:1.5 Sat Feb 3
16:22:05 2007
+++ phpdoc/en/reference/w32api/functions/w32api-deftype.xml Sat Feb 3
16:22:20 2007
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.w32api-deftype">
<refnamediv>
<refname>w32api_deftype</refname>
<refpurpose>Defines a type for use with other w32api_functions</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>w32api_deftype</methodname>
<methodparam><type>string</type><parameter>typename</parameter></methodparam>
@@ -15,18 +16,76 @@
<methodparam
choice="opt"><type>string</type><parameter>...</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>...</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
<para>
- If you would like to define a type for a w32api call, you need to call
- <function>w32api_deftype</function>. This function takes 2n+1 arguments,
- where n is the number of members the type has. The first argument is the
- name of the type. After that is the type of the member followed by the
- members name (in pairs). A member type can be a user defined type. All
- the type names are case sensitive. Built in type names should be provided
- in lowercase.
+ You need to call this function if you would like to define a type for a
+ w32api call.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>typename</parameter></term>
+ <listitem>
+ <para>
+ The name of the type.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>member1_type</parameter></term>
+ <listitem>
+ <para>
+ A member type can be a user defined type. All the type names are case
+ sensitive. Built in type names should be provided in lowercase.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>member1_name</parameter></term>
+ <listitem>
+ <para>
+ The member name of <parameter>member1_type</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <para>
+ This function takes 2n+1 arguments, where n is the number of members the
+ type has. After that is the type of the member followed by the members
+ name (in pairs).
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
&return.success;
</para>
</refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ &warn.experimental.func;
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/w32api/functions/w32api-init-dtype.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/w32api/functions/w32api-init-dtype.xml
diff -u phpdoc/en/reference/w32api/functions/w32api-init-dtype.xml:1.5
phpdoc/en/reference/w32api/functions/w32api-init-dtype.xml:1.6
--- phpdoc/en/reference/w32api/functions/w32api-init-dtype.xml:1.5 Sat Feb
3 16:22:05 2007
+++ phpdoc/en/reference/w32api/functions/w32api-init-dtype.xml Sat Feb 3
16:22:20 2007
@@ -1,28 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.w32api-init-dtype">
<refnamediv>
<refname>w32api_init_dtype</refname>
<refpurpose>Creates an instance of the data type typename and fills it with
the values passed</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>w32api_init_dtype</methodname>
<methodparam><type>string</type><parameter>typename</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
<para>
This function creates an instance of the data type named
- <parameter>typename</parameter>, filling in the values of the data
- type. The <parameter>typename</parameter> parameter is case sensitive.
- You should give the values in the same order as you defined the
- data type with <function>w32api_deftype</function>. The type of the
- resource returned is <literal>dynaparm</literal>.
+ <parameter>typename</parameter>, filling in the values of the data type.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>typename</parameter></term>
+ <listitem>
+ <para>
+ The <parameter>typename</parameter> parameter is case sensitive.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ You should give the values in the same order as you defined the data
+ type with <function>w32api_deftype</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a <literal>dynaparm</literal> resource.
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ &warn.experimental.func;
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/w32api/functions/w32api-invoke-function.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/w32api/functions/w32api-invoke-function.xml
diff -u phpdoc/en/reference/w32api/functions/w32api-invoke-function.xml:1.4
phpdoc/en/reference/w32api/functions/w32api-invoke-function.xml:1.5
--- phpdoc/en/reference/w32api/functions/w32api-invoke-function.xml:1.4 Sat Feb
3 16:22:05 2007
+++ phpdoc/en/reference/w32api/functions/w32api-invoke-function.xml Sat Feb
3 16:22:20 2007
@@ -1,28 +1,70 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.w32api-invoke-function">
<refnamediv>
<refname>w32api_invoke_function</refname>
<refpurpose>Invokes function funcname with the arguments passed after the
function name</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>w32api_invoke_function</methodname>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam><type>mixed</type><parameter>argument</parameter></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
<para>
<function>w32api_invoke_function</function> tries to find the previously
- registered function, named <parameter>funcname</parameter>, passing the
- parameters you provided. The return type is the one you set when you
- registered the function, the value is the one returned by the function
- itself. Any of the arguments can be of any PHP type or
- <function>w32api_deftype</function> defined type, as needed.
+ registered function, passing the parameters you provided.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>funcname</parameter></term>
+ <listitem>
+ <para>
+ The function name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>argument</parameter></term>
+ <listitem>
+ <para>
+ Any of the arguments can be of any PHP type or
+ <function>w32api_deftype</function> defined type, as needed.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The return type is the one you set when you registered the function, the
+ value is the one returned by the function itself.
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ &warn.experimental.func;
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/w32api/functions/w32api-register-function.xml?r1=1.6&r2=1.7&diff_format=u
Index: phpdoc/en/reference/w32api/functions/w32api-register-function.xml
diff -u phpdoc/en/reference/w32api/functions/w32api-register-function.xml:1.6
phpdoc/en/reference/w32api/functions/w32api-register-function.xml:1.7
--- phpdoc/en/reference/w32api/functions/w32api-register-function.xml:1.6
Sat Feb 3 16:22:05 2007
+++ phpdoc/en/reference/w32api/functions/w32api-register-function.xml Sat Feb
3 16:22:20 2007
@@ -1,28 +1,73 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<refentry id="function.w32api-register-function">
<refnamediv>
<refname>w32api_register_function</refname>
<refpurpose>Registers function function_name from library with
PHP</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>w32api_register_function</methodname>
<methodparam><type>string</type><parameter>library</parameter></methodparam>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>string</type><parameter>return_type</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
<para>
This function tries to find the <parameter>function_name</parameter>
function
- in <parameter>libary</parameter>, and tries to import it into PHP. The
function
- will be registered with the given <parameter>return_type</parameter>. This
type
- can be a generic PHP type, or a type defined with
<function>w32api_deftype</function>.
- All type names are case sensitive. Built in type names should be provided
in lowercase.
+ in <parameter>libary</parameter>, and tries to import it into PHP.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>library</parameter></term>
+ <listitem>
+ <para>
+ The library name, as a string.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>function_name</parameter></term>
+ <listitem>
+ <para>
+ The function name, as a string.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>return_type</parameter></term>
+ <listitem>
+ <para>
+ The function will be registered with the given
+ <parameter>return_type</parameter>. This type can be a generic PHP
+ type, or a type defined with <function>w32api_deftype</function>.
+ All type names are case sensitive. Built in type names should be
+ provided in lowercase.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
&return.success;
</para>
</refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ &warn.experimental.func;
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/w32api/functions/w32api-set-call-method.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/w32api/functions/w32api-set-call-method.xml
diff -u phpdoc/en/reference/w32api/functions/w32api-set-call-method.xml:1.4
phpdoc/en/reference/w32api/functions/w32api-set-call-method.xml:1.5
--- phpdoc/en/reference/w32api/functions/w32api-set-call-method.xml:1.4 Sat Feb
3 16:22:05 2007
+++ phpdoc/en/reference/w32api/functions/w32api-set-call-method.xml Sat Feb
3 16:22:20 2007
@@ -1,24 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.w32api-set-call-method">
<refnamediv>
<refname>w32api_set_call_method</refname>
<refpurpose>Sets the calling method used</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>void</type><methodname>w32api_set_call_method</methodname>
<methodparam><type>int</type><parameter>method</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
<para>
- This function sets the method call type. The parameter can be
- one of the constants <constant>DC_CALL_CDECL</constant> or
- <constant>DC_CALL_STD</constant>. The extension default is
- <constant>DC_CALL_STD</constant>.
+ This function sets the method call type.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>method</parameter></term>
+ <listitem>
+ <para>
+ Can be one of <constant>DC_CALL_CDECL</constant> or
+ <constant>DC_CALL_STD</constant> (the extension default).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ &warn.experimental.func;
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
