cvs: phpdoc /en/reference/fam reference.xml /en/reference/fam/functions fam-cancel-monitor.xml fam-close.xml fam-monitor-collection.xml
fam-monitor-directory.xml fam-monitor-file.xml fam-next-event.xml fam-open.xml fam-pending.xml fam-resume-monitor.xml fam-suspend-monitor.xml

didou Mon Jan 15 15:55:07 2007 UTC Modified files: /phpdoc/en/reference/fam reference.xml /phpdoc/en/reference/fam/functions fam-cancel-monitor.xml fam-close.xml fam-monitor-collection.xml fam-monitor-directory.xml fam-monitor-file.xml fam-next-event.xml fam-open.xml fam-pending.xml fam-resume-monitor.xml fam-suspend-monitor.xml Log: fam: switch to new doc style and rewrite resources section

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/reference.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/fam/reference.xml diff -u phpdoc/en/reference/fam/reference.xml:1.8 phpdoc/en/reference/fam/reference.xml:1.9 --- phpdoc/en/reference/fam/reference.xml:1.8 Sun Sep 4 19:39:13 2005 +++ phpdoc/en/reference/fam/reference.xml Mon Jan 15 15:55:07 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- Purpose: fileprocess.file --> <!-- Membership: pecl, external --> @@ -38,7 +38,6 @@ This extension uses the functions of the <ulink url="&url.fam.download;"> FAM</ulink> library, developed by SGI. Therefore you have to download and install the FAM library. - <!-- This extension requires ... version ... as available on ... --> </para> </section> @@ -51,11 +50,12 @@ <section id="fam.resources"> &reftitle.resources; - <section id="fam.resources.fam"> - <title>FAM resource</title> - <para> - </para> - </section> + <para> + There are two resource types used in the FAM module. The first one is + the connection to the FAM service returned by + <function>fam_open</function>, the second a monitoring resource returned + by the <literal>fam_monitor_XXX</literal> functions. + </para> </section> &reference.fam.constants; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml diff -u phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.6 phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.7 --- phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.6 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml Mon Jan 15 15:55:07 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.fam-cancel-monitor"> <refnamediv> <refname>fam_cancel_monitor</refname> <refpurpose>Terminate monitoring</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fam_cancel_monitor</methodname> @@ -13,16 +13,52 @@ <methodparam><type>resource</type><parameter>fam_monitor</parameter></methodparam> </methodsynopsis> <para> - <function>fam_cancel_monitor</function> terminates monitoring on - a resource previously requested using one of the - <literal>fam_monitor_</literal> functions. + Terminates monitoring on a resource. + </para> + <para> In addition an <constant>FAMAcknowledge</constant> event occurs. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fam_monitor</parameter></term> + <listitem> + <para> + A resource returned by one of the <literal>fam_monitor_XXX</literal> + functions + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_monitor_file</function>, - <function>fam_monitor_directory</function>, - <function>fam_monitor_collection</function>, and - <function>fam_suspend_monitor</function> + <simplelist> + <member><function>fam_monitor_file</function></member> + <member><function>fam_monitor_directory</function></member> + <member><function>fam_monitor_collection</function></member> + <member><function>fam_suspend_monitor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-close.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-close.xml diff -u phpdoc/en/reference/fam/functions/fam-close.xml:1.4 phpdoc/en/reference/fam/functions/fam-close.xml:1.5 --- phpdoc/en/reference/fam/functions/fam-close.xml:1.4 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-close.xml Mon Jan 15 15:55:07 2007 @@ -1,19 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.fam-close"> <refnamediv> <refname>fam_close</refname> <refpurpose>Close FAM connection</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>fam_close</methodname> <methodparam><type>resource</type><parameter>fam</parameter></methodparam> </methodsynopsis> <para> - <function>fam_close</function> closes a connection to the FAM service - previously opened using <function>fam_open</function>. + Closes a connection to the FAM service. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</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>fam_monitor_open</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-monitor-collection.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-monitor-collection.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.5 phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.6 --- phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.5 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-monitor-collection.xml Mon Jan 15 15:55:07 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.fam-monitor-collection"> <refnamediv> <refname>fam_monitor_collection</refname> <refpurpose>Monitor a collection of files in a directory for changes</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>resource</type><methodname>fam_monitor_collection</methodname> @@ -15,24 +15,72 @@ <methodparam><type>string</type><parameter>mask</parameter></methodparam> </methodsynopsis> <para> - <function>fam_monitor_collection</function> requests monitoring for a collection of - files within a directory. The actual files to be monitored are specified by a - directory path in <parameter>dirname</parameter>, the maximum search - <parameter>depth</parameter> starting from this directory and a shell pattern - <parameter>mask</parameter> restricting the file names to look for. - <!-- TODO: go a bit more into details here --> + Requests monitoring for a collection of files within a directory. </para> <para> A FAM event will be generated whenever the status of the files change. The possible event codes are described in detail in the <link linkend="fam.constants">constants part</link> of this section. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dirname</parameter></term> + <listitem> + <para> + Directory path to the monitored files + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>depth</parameter></term> + <listitem> + <para> + The maximum search <parameter>depth</parameter> starting from this + directory + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mask</parameter></term> + <listitem> + <para> + A shell pattern <parameter>mask</parameter> restricting the file names + to look for + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a monitoring resource or &false; on errors. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_monitor_file</function>, - <function>fam_monitor_directory</function>, - <function>fam_cancel_monitor</function>, - <function>fam_suspend_monitor</function>, and - <function>fam_resume_monitor</function>. + <simplelist> + <member><function>fam_monitor_file</function></member> + <member><function>fam_monitor_directory</function></member> + <member><function>fam_cancel_monitor</function></member> + <member><function>fam_suspend_monitor</function></member> + <member><function>fam_resume_monitor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-monitor-directory.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-monitor-directory.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.6 phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.7 --- phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.6 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-monitor-directory.xml Mon Jan 15 15:55:07 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.fam-monitor-directory"> <refnamediv> <refname>fam_monitor_directory</refname> <refpurpose>Monitor a directory for changes</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>resource</type><methodname>fam_monitor_directory</methodname> @@ -13,23 +13,58 @@ <methodparam><type>string</type><parameter>dirname</parameter></methodparam> </methodsynopsis> <para> - <function>fam_monitor_directory</function> requests monitoring for a directory - and all contained files. A FAM event will be generated whenever the status - of the directory (i.e. the result of function <function>stat</function> on - that directory) or its content (i.e. the results of <function>readdir</function>) - change. - <!-- TODO: go a bit more into details here --> + Requests monitoring for a directory and all contained files. + </para> + <para> + A FAM event will be generated whenever the status of the directory (i.e. + the result of function <function>stat</function> on that directory) or its + content (i.e. the results of <function>readdir</function>) changes. </para> <para> The possible event codes are described in detail in the <link linkend="fam.constants">constants part</link> of this section. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dirname</parameter></term> + <listitem> + <para> + Path to the monitored directory + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a monitoring resource or &false; on errors. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_monitor_file</function>, - <function>fam_monitor_collection</function>, - <function>fam_cancel_monitor</function>, - <function>fam_suspend_monitor</function>, and - <function>fam_resume_monitor</function>. + <simplelist> + <member><function>fam_monitor_file</function></member> + <member><function>fam_monitor_collection</function></member> + <member><function>fam_cancel_monitor</function></member> + <member><function>fam_suspend_monitor</function></member> + <member><function>fam_resume_monitor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-monitor-file.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-monitor-file.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.5 phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.6 --- phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.5 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-monitor-file.xml Mon Jan 15 15:55:07 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.fam-monitor-file"> <refnamediv> <refname>fam_monitor_file</refname> <refpurpose>Monitor a regular file for changes</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>resource</type><methodname>fam_monitor_file</methodname> @@ -13,21 +13,55 @@ <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - <function>fam_monitor_file</function> requests monitoring for a single - file. A FAM event will be generated whenever the file status - (i.e. the result of function <function>stat</function> on that file) - changes. + Requests monitoring for a single file. A FAM event will be generated + whenever the file status changes (i.e. the result of function + <function>stat</function> on that file). </para> <para> The possible event codes are described in detail in the <link linkend="fam.constants">constants part</link> of this section. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the monitored file + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a monitoring resource or &false; on errors. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_monitor_directory</function>, - <function>fam_monitor_collection</function>, - <function>fam_cancel_monitor</function>, - <function>fam_suspend_monitor</function>, and - <function>fam_resume_monitor</function>. + <simplelist> + <member><function>fam_monitor_directory</function></member> + <member><function>fam_monitor_collection</function></member> + <member><function>fam_cancel_monitor</function></member> + <member><function>fam_suspend_monitor</function></member> + <member><function>fam_resume_monitor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-next-event.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-next-event.xml diff -u phpdoc/en/reference/fam/functions/fam-next-event.xml:1.6 phpdoc/en/reference/fam/functions/fam-next-event.xml:1.7 --- phpdoc/en/reference/fam/functions/fam-next-event.xml:1.6 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-next-event.xml Mon Jan 15 15:55:07 2007 @@ -1,33 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.fam-next-event"> <refnamediv> <refname>fam_next_event</refname> <refpurpose>Get next pending FAM event</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>fam_next_event</methodname> <methodparam><type>resource</type><parameter>fam</parameter></methodparam> </methodsynopsis> <para> - <function>fam_next_event</function> returns the next pending FAM - event. The function will block until an event is available which can - be checked for using <function>fam_pending</function>. + Returns the next pending FAM event. </para> <para> - <function>fam_next_event</function> will return an array that contains - a FAM event code in element '<literal>code</literal>', the path of the - file this event applies to in element '<literal>filename</literal>' and - optionally a hostname in element '<literal>hostname</literal>'. + The function will block until an event is available which can be checked + for using <function>fam_pending</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array that contains a FAM event code in the + '<literal>code</literal>' element, the path of the file this event applies + to in the '<literal>filename</literal>' element and optionally a hostname + in the '<literal>hostname</literal>' element. </para> <para> The possible event codes are described in detail in the <link linkend="fam.constants">constants part</link> of this section. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_pending</function>. + <simplelist> + <member><function>fam_pending</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-open.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-open.xml diff -u phpdoc/en/reference/fam/functions/fam-open.xml:1.3 phpdoc/en/reference/fam/functions/fam-open.xml:1.4 --- phpdoc/en/reference/fam/functions/fam-open.xml:1.3 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-open.xml Mon Jan 15 15:55:07 2007 @@ -1,23 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.fam-open"> <refnamediv> <refname>fam_open</refname> <refpurpose>Open connection to FAM daemon</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>resource</type><methodname>fam_open</methodname> <methodparam choice='opt'><type>string</type><parameter>appname</parameter></methodparam> </methodsynopsis> <para> - <function>fam_open</function> opens a connection to the FAM service - daemon. The optional parameter <parameter>appname</parameter> should - be set to a string identifying the application for logging reasons. + Opens a connection to the FAM service daemon. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>appname</parameter></term> + <listitem> + <para> + A string identifying the application for logging reasons + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a resource representing a connection to the FAM service on success + or &false; on errors. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_close</function>. + <simplelist> + <member><function>fam_close</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-pending.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-pending.xml diff -u phpdoc/en/reference/fam/functions/fam-pending.xml:1.4 phpdoc/en/reference/fam/functions/fam-pending.xml:1.5 --- phpdoc/en/reference/fam/functions/fam-pending.xml:1.4 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-pending.xml Mon Jan 15 15:55:07 2007 @@ -1,22 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.fam-pending"> <refnamediv> <refname>fam_pending</refname> <refpurpose>Check for pending FAM events</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>fam_pending</methodname> <methodparam><type>resource</type><parameter>fam</parameter></methodparam> </methodsynopsis> <para> - <function>fam_pending</function> returns non-zero if events are - available to be fetched using <function>fam_next_event</function>. + Checks for pending FAM events. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns non-zero if events are available to be fetched using + <function>fam_next_event</function>, zero otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_next_event</function>. + <simplelist> + <member><function>fam_next_event</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-resume-monitor.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-resume-monitor.xml diff -u phpdoc/en/reference/fam/functions/fam-resume-monitor.xml:1.3 phpdoc/en/reference/fam/functions/fam-resume-monitor.xml:1.4 --- phpdoc/en/reference/fam/functions/fam-resume-monitor.xml:1.3 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-resume-monitor.xml Mon Jan 15 15:55:07 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.fam-resume-monitor"> <refnamediv> <refname>fam_resume_monitor</refname> <refpurpose>Resume suspended monitoring</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fam_resume_monitor</methodname> @@ -13,11 +13,47 @@ <methodparam><type>resource</type><parameter>fam_monitor</parameter></methodparam> </methodsynopsis> <para> - <function>fam_resume_monitor</function> resumes monitoring - of a resource previously suspend using <function>fam_suspend_monitor</function>. + Resumes monitoring of a resource previously suspended using + <function>fam_suspend_monitor</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fam_monitor</parameter></term> + <listitem> + <para> + A resource returned by one of the <literal>fam_monitor_XXX</literal> + functions + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_suspend_monitor</function>. + <simplelist> + <member><function>fam_suspend_monitor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fam/functions/fam-suspend-monitor.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/fam/functions/fam-suspend-monitor.xml diff -u phpdoc/en/reference/fam/functions/fam-suspend-monitor.xml:1.5 phpdoc/en/reference/fam/functions/fam-suspend-monitor.xml:1.6 --- phpdoc/en/reference/fam/functions/fam-suspend-monitor.xml:1.5 Mon Jan 15 15:04:16 2007 +++ phpdoc/en/reference/fam/functions/fam-suspend-monitor.xml Mon Jan 15 15:55:07 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.fam-suspend-monitor"> <refnamediv> <refname>fam_suspend_monitor</refname> <refpurpose>Temporarily suspend monitoring</refpurpose> </refnamediv> - <refsect1> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fam_suspend_monitor</methodname> @@ -14,14 +14,51 @@ </methodsynopsis> <para> <function>fam_suspend_monitor</function> temporarily suspend monitoring - of a resource previously requested using one of the - <literal>fam_monitor_</literal> functions. + of a resource. + </para> + <para> Monitoring can later be continued using <function>fam_resume_monitor</function> without the need of requesting a complete new monitor. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fam</parameter></term> + <listitem> + <para> + A resource representing a connection to the FAM service returned by + <function>fam_open</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fam_monitor</parameter></term> + <listitem> + <para> + A resource returned by one of the <literal>fam_monitor_XXX</literal> + functions + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fam_resume_monitor</function>, and - <function>fam_cancel_monitor</function>. + <simplelist> + <member><function>fam_cancel_monitor</function></member> + <member><function>fam_resume_monitor</function></member> + </simplelist> </para> </refsect1> </refentry>