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@227343 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-01-16 01:39:18 +00:00
parent ec3f931fa0
commit d3847e3666
5 changed files with 98 additions and 112 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
reference/muscat/functions/muscat-close.xml
View file

@ -1,26 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/muscat.xml, last change in rev 1.1 -->
<refentry id="function.muscat-close">
<refnamediv>
<refname>muscat_close</refname>
<refpurpose>Shuts down the muscat session and releases any memory back to PHP</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>muscat_close</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
<para>
[Not back to the system, note!]
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry id="function.muscat-close">
<refnamediv>
<refname>muscat_close</refname>
<refpurpose>Shuts down the muscat session and releases any memory back to PHP</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>muscat_close</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

37
reference/muscat/functions/muscat-get.xml
View file

@ -1,24 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/muscat.xml, last change in rev 1.1 -->
<refentry id="function.muscat-get">
<refnamediv>
<refname>muscat_get</refname>
<refpurpose>Gets a line back from the core muscat API</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>muscat_get</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
&return.falseproblem;
</refsect1>
</refentry>
<!-- $Revision: 1.8 $ -->
<refentry id="function.muscat-get">
<refnamediv>
<refname>muscat_get</refname>
<refpurpose>Gets a line back from the core muscat API</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>muscat_get</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
&return.falseproblem;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

37
reference/muscat/functions/muscat-give.xml
View file

@ -1,24 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/muscat.xml, last change in rev 1.1 -->
<refentry id="function.muscat-give">
<refnamediv>
<refname>muscat_give</refname>
<refpurpose>Sends string to the core muscat API</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>muscat_give</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry id="function.muscat-give">
<refnamediv>
<refname>muscat_give</refname>
<refpurpose>Sends string to the core muscat API</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>muscat_give</methodname>
<methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

47
reference/muscat/functions/muscat-setup-net.xml
View file

@ -1,28 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/muscat.xml, last change in rev 1.1 -->
<refentry id="function.muscat-setup-net">
<refnamediv>
<refname>muscat_setup_net</refname>
<refpurpose>Creates a new muscat session and returns the handle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>muscat_setup_net</methodname>
<methodparam><type>string</type><parameter>muscat_host</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>muscat_setup_net</function> creates a new muscat session and
returns the handle.
</para>
<para>
<parameter>muscat_host</parameter> is the hostname to connect to.
<parameter>port</parameter> is the port number to connect to.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry id="function.muscat-setup-net">
<refnamediv>
<refname>muscat_setup_net</refname>
<refpurpose>Creates a new muscat session and returns the handle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>muscat_setup_net</methodname>
<methodparam><type>string</type><parameter>muscat_host</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>muscat_setup_net</function> creates a new muscat session and
returns the handle.
</para>
<para>
<parameter>muscat_host</parameter> is the hostname to connect to.
<parameter>port</parameter> is the port number to connect to.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

51
reference/muscat/functions/muscat-setup.xml
View file

@ -1,30 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/muscat.xml, last change in rev 1.1 -->
<refentry id="function.muscat-setup">
<refnamediv>
<refname>muscat_setup</refname>
<refpurpose>Creates a new muscat session and returns the handle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>muscat_setup</methodname>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>muscat_dir</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
<para>
<parameter>size</parameter> is the amount of memory in bytes to allocate
for muscat. <parameter>muscat_dir</parameter> is the muscat installation
dir e.g. "/usr/local/empower", it defaults to the compile time muscat
directory.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry id="function.muscat-setup">
<refnamediv>
<refname>muscat_setup</refname>
<refpurpose>Creates a new muscat session and returns the handle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>muscat_setup</methodname>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>muscat_dir</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
&warn.undocumented.func;
</para>
<para>
<parameter>size</parameter> is the amount of memory in bytes to allocate
for muscat. <parameter>muscat_dir</parameter> is the muscat installation
dir e.g. "/usr/local/empower", it defaults to the compile time muscat
directory.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: