sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WS, prepare for new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228882 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-02-03 16:22:05 +00:00
parent 4530d1af0f
commit 444d448733
5 changed files with 125 additions and 132 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
reference/w32api/functions/w32api-deftype.xml
View file

@ -1,34 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/w32api.xml, last change in rev 1.1 -->
<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>
<methodsynopsis>
<type>bool</type><methodname>w32api_deftype</methodname>
<methodparam><type>string</type><parameter>typename</parameter></methodparam>
<methodparam><type>string</type><parameter>member1_type</parameter></methodparam>
<methodparam><type>string</type><parameter>member1_name</parameter></methodparam>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<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>
<methodsynopsis>
<type>bool</type><methodname>w32api_deftype</methodname>
<methodparam><type>string</type><parameter>typename</parameter></methodparam>
<methodparam><type>string</type><parameter>member1_type</parameter></methodparam>
<methodparam><type>string</type><parameter>member1_name</parameter></methodparam>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

53
reference/w32api/functions/w32api-init-dtype.xml
View file

@ -1,32 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/w32api.xml, last change in rev 1.1 -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

51
reference/w32api/functions/w32api-invoke-function.xml
View file

@ -1,30 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/w32api.xml, last change in rev 1.1 -->
<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>
<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.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<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>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

51
reference/w32api/functions/w32api-register-function.xml
View file

@ -1,30 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/w32api.xml, last change in rev 1.1 -->
<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>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<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>
<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.
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

43
reference/w32api/functions/w32api-set-call-method.xml
View file

@ -1,26 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/w32api.xml, last change in rev 1.1 -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: