cvs: phpdoc /en/reference/muscat reference.xml /en/reference/muscat/functions muscat-close.xml muscat-get.xml muscat-give.xml muscat-setup-net.xml
muscat-setup.xml

didou Tue Jan 16 02:06:27 2007 UTC Modified files: /phpdoc/en/reference/muscat reference.xml /phpdoc/en/reference/muscat/functions muscat-close.xml muscat-get.xml muscat-give.xml muscat-setup-net.xml muscat-setup.xml Log: Document muscat to meet the new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/muscat/reference.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/muscat/reference.xml diff -u phpdoc/en/reference/muscat/reference.xml:1.7 phpdoc/en/reference/muscat/reference.xml:1.8 --- phpdoc/en/reference/muscat/reference.xml:1.7 Sun Sep 4 19:39:20 2005 +++ phpdoc/en/reference/muscat/reference.xml Tue Jan 16 02:06:26 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- Purpose: basic.session --> <!-- Membership: pecl, external --> <!-- State: experimental --> @@ -11,6 +11,12 @@ <partintro> <section id="muscat.intro"> &reftitle.intro; + <para> + This extension provides an interface to the Muscat 3.6 search system. + Muscat doesn't exist anymore, but the <ulink + url="&url.dom3.spec;">Xapian</ulink> project may provide you with a + good alternative. + </para> &warn.experimental; </section> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/muscat/functions/muscat-close.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/muscat/functions/muscat-close.xml diff -u phpdoc/en/reference/muscat/functions/muscat-close.xml:1.7 phpdoc/en/reference/muscat/functions/muscat-close.xml:1.8 --- phpdoc/en/reference/muscat/functions/muscat-close.xml:1.7 Tue Jan 16 01:39:18 2007 +++ phpdoc/en/reference/muscat/functions/muscat-close.xml Tue Jan 16 02:06:26 2007 @@ -1,19 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.muscat-close"> <refnamediv> <refname>muscat_close</refname> - <refpurpose>Shuts down the muscat session and releases any memory back to PHP</refpurpose> + <refpurpose>Shuts down the muscat session</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>muscat_close</methodname> <methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - &warn.undocumented.func; + <para> + Shuts down the muscat session and releases any memory back to PHP. + </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>muscat_handle</parameter></term> + <listitem> + <para> + A muscat session handler, returned by + <function>muscat_setup</function> or + <function>muscat_setup_net</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>muscat_setup</function></member> + <member><function>muscat_setup_net</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/muscat/functions/muscat-get.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/muscat/functions/muscat-get.xml diff -u phpdoc/en/reference/muscat/functions/muscat-get.xml:1.8 phpdoc/en/reference/muscat/functions/muscat-get.xml:1.9 --- phpdoc/en/reference/muscat/functions/muscat-get.xml:1.8 Tue Jan 16 01:39:18 2007 +++ phpdoc/en/reference/muscat/functions/muscat-get.xml Tue Jan 16 02:06:26 2007 @@ -1,20 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>muscat_get</methodname> <methodparam><type>resource</type><parameter>muscat_handle</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - &warn.undocumented.func; + <para> + Gets a line back from the core muscat API. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>muscat_handle</parameter></term> + <listitem> + <para> + A muscat session handler, returned by + <function>muscat_setup</function> or + <function>muscat_setup_net</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the muscat response, as a string. + </para> &return.falseproblem; </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>muscat_give</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/muscat/functions/muscat-give.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/muscat/functions/muscat-give.xml diff -u phpdoc/en/reference/muscat/functions/muscat-give.xml:1.5 phpdoc/en/reference/muscat/functions/muscat-give.xml:1.6 --- phpdoc/en/reference/muscat/functions/muscat-give.xml:1.5 Tue Jan 16 01:39:18 2007 +++ phpdoc/en/reference/muscat/functions/muscat-give.xml Tue Jan 16 02:06:26 2007 @@ -1,20 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.muscat-give"> <refnamediv> <refname>muscat_give</refname> <refpurpose>Sends string to the core muscat API</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <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; + <para> + Sends a <parameter>string</parameter> to the core muscat API. + </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>muscat_handle</parameter></term> + <listitem> + <para> + A muscat session handler, returned by + <function>muscat_setup</function> or + <function>muscat_setup_net</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>string</parameter></term> + <listitem> + <para> + The string to be sent + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>muscat_get</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/muscat/functions/muscat-setup-net.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/muscat/functions/muscat-setup-net.xml diff -u phpdoc/en/reference/muscat/functions/muscat-setup-net.xml:1.7 phpdoc/en/reference/muscat/functions/muscat-setup-net.xml:1.8 --- phpdoc/en/reference/muscat/functions/muscat-setup-net.xml:1.7 Tue Jan 16 01:39:18 2007 +++ phpdoc/en/reference/muscat/functions/muscat-setup-net.xml Tue Jan 16 02:06:26 2007 @@ -1,26 +1,65 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.muscat-setup-net"> <refnamediv> <refname>muscat_setup_net</refname> - <refpurpose>Creates a new muscat session and returns the handle</refpurpose> + <refpurpose>Creates a new muscat session</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>muscat_setup_net</methodname> <methodparam><type>string</type><parameter>muscat_host</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> - <function>muscat_setup_net</function> creates a new muscat session and - returns the handle. + Creates a new muscat session. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>muscat_host</parameter></term> + <listitem> + <para> + The host name to connect to + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + The port number to connect to + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>muscat_host</parameter> is the hostname to connect to. - <parameter>port</parameter> is the port number to connect to. + Returns a session handler or &false; on error. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>muscat_setup</function></member> + <member><function>muscat_close</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/muscat/functions/muscat-setup.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/muscat/functions/muscat-setup.xml diff -u phpdoc/en/reference/muscat/functions/muscat-setup.xml:1.7 phpdoc/en/reference/muscat/functions/muscat-setup.xml:1.8 --- phpdoc/en/reference/muscat/functions/muscat-setup.xml:1.7 Tue Jan 16 01:39:18 2007 +++ phpdoc/en/reference/muscat/functions/muscat-setup.xml Tue Jan 16 02:06:26 2007 @@ -1,12 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.muscat-setup"> <refnamediv> <refname>muscat_setup</refname> - <refpurpose>Creates a new muscat session and returns the handle</refpurpose> + <refpurpose>Creates a new local muscat session</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>muscat_setup</methodname> <methodparam><type>int</type><parameter>size</parameter></methodparam> @@ -14,15 +15,52 @@ </methodsynopsis> &warn.experimental.func; <para> - &warn.undocumented.func; + Creates a new local muscat session. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + The amount of memory in bytes to allocate for muscat + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>muscat_dir</parameter></term> + <listitem> + <para> + The muscat installation dir e.g. "/usr/local/empower", it defaults to + the compile time muscat directory. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a session handler or &false; on error. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <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. + <simplelist> + <member><function>muscat_setup_net</function></member> + <member><function>muscat_close</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file