cvs: peardoc /en/core/pear/pear-errorstack raiseerror.xml setcontextcallback.xml setdefaultcallback.xml
| From: | Christophe Gesch� | Date: | Mon, 18 Jul 2005 07:15:59 +0000 |
| Subject: | cvs: peardoc /en/core/pear/pear-errorstack raiseerror.xml setcontextcallback.xml setdefaultcallback.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-6516@lists.php.net to get a copy of this message | ||
moosh Mon Jul 18 03:15:59 2005 EDT
Modified files:
/peardoc/en/core/pear/pear-errorstack raiseerror.xml
setcontextcallback.xml
setdefaultcallback.xml
Log:
- use entities
- indent
http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/raiseerror.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/raiseerror.xml diff -u peardoc/en/core/pear/pear-errorstack/raiseerror.xml:1.2 peardoc/en/core/pear/pear-errorstack/raiseerror.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/raiseerror.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/raiseerror.xml Mon Jul 18 03:15:59 2005 @@ -1,35 +1,41 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.raiseerror"> - <refnamediv> - <refname><function>PEAR_ErrorStack::raiseError</function></refname> - <refpurpose>emulate <function>PEAR::raiseError</function></refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>PEAR_Error <function>PEAR_ErrorStack::raiseError</function></funcdef> -<paramdef></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname><function>PEAR_ErrorStack::raiseError</function></refname> + <refpurpose>emulate <function>PEAR::raiseError</function></refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + PEAR_Error + <function>PEAR_ErrorStack::raiseError</function> + </funcdef> + <paramdef></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.raiseerror.desc"> - &title.desc; - <para>See <link linkend="core.pear.pear.raiseerror"><function>PEAR::raiseError</function></link></para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.raiseerror.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.raiseerror.note"> - &title.note; - ¬e.canstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.raiseerror.desc"> + &title.desc; + <para> + See + <link linkend="core.pear.pear.raiseerror"> + <function>PEAR::raiseError</function> + </link> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.raiseerror.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.raiseerror.note"> + &title.note; + ¬e.canstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml:1.2 peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml:1.2 Sat Oct 23 16:24:26 2004 +++ peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml Mon Jul 18 03:15:59 2005 @@ -1,56 +1,73 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.setcontextcallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setContextCallback</function></refname> - <refpurpose>Set a callback that generates context information (location of error) for an error stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setContextCallback</function></funcdef> - <paramdef>array|string|null <parameter>$contextCallback</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setContextCallback</function> + </refname> + <refpurpose> + Set a callback that generates context + information (location of error) for an error stack + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setContextCallback</function> + </funcdef> + <paramdef> + &type.array;|&type.string;|&type.null; + <parameter>$contextCallback</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.setcontextcallback.desc"> - &title.desc; - <para>This method sets the callback that can be used to generate context - information for an error. Passing in &null; will disable context generation - and remove the expensive call to <ulink url="&url.php.lookup;debug_backtrace"> - <function>debug_backtrace</function></ulink></para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setcontextcallback.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.mixed; - <parameter>$contextCallback</parameter> - </term> - <listitem> - <para> - A valid callback as defined by <ulink url="&url.php.lookup;is_callable"><function>is_callable</function></ulink> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setcontextcallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setcontextcallback.note"> - &title.note; - ¬e.notstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setcontextcallback.desc"> + &title.desc; + <para> + This method sets the callback that can be used to generate context + information for an error. + + Passing in &null; will disable context generation + and remove the expensive call to + <ulink url="&url.php.lookup;debug_backtrace"> + <function>debug_backtrace</function></ulink> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setcontextcallback.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.mixed; + <parameter>$contextCallback</parameter> + </term> + <listitem> + <para> + A valid callback as defined by + <ulink url="&url.php.lookup;is_callable"> + <function>is_callable</function> + </ulink> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setcontextcallback.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setcontextcallback.note"> + &title.note; + ¬e.notstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.1 peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.2 --- peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.1 Sat Mar 20 01:16:32 2004 +++ peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml Mon Jul 18 03:15:59 2005 @@ -1,54 +1,66 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="core.pear.pear-errorstack.setdefaultcallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setDefaultCallback</function></refname> - <refpurpose>Sets a default callback to be used by all error stacks</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setDefaultCallback</function></funcdef> - <paramdef>array|string <parameter> <optional>$callback = &false;</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setDefaultCallback</function> + </refname> + <refpurpose> + Sets a default callback to be used by all error stacks + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setDefaultCallback</function> + </funcdef> + <paramdef> + &type.array;|&type.string; + <parameter><optional>$callback = &false;</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.desc"> - &title.desc; - <para>This method sets the callback that can be used to generate error messages for a singleton</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - <type>array|string</type> - <parameter>$callback</parameter> - </term> - <listitem> - <para> - Callback function/method - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.desc"> + &title.desc; + <para> + This method sets the callback + that can be used to generate error + messages for a singleton + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <type>array|string</type> + <parameter>$callback</parameter> + </term> + <listitem> + <para> + Callback function/method + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables:
http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/raiseerror.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/raiseerror.xml diff -u peardoc/en/core/pear/pear-errorstack/raiseerror.xml:1.2 peardoc/en/core/pear/pear-errorstack/raiseerror.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/raiseerror.xml:1.2 Sat Mar 20 02:43:04 2004 +++ peardoc/en/core/pear/pear-errorstack/raiseerror.xml Mon Jul 18 03:15:59 2005 @@ -1,35 +1,41 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.raiseerror"> - <refnamediv> - <refname><function>PEAR_ErrorStack::raiseError</function></refname> - <refpurpose>emulate <function>PEAR::raiseError</function></refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>PEAR_Error <function>PEAR_ErrorStack::raiseError</function></funcdef> -<paramdef></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname><function>PEAR_ErrorStack::raiseError</function></refname> + <refpurpose>emulate <function>PEAR::raiseError</function></refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + PEAR_Error + <function>PEAR_ErrorStack::raiseError</function> + </funcdef> + <paramdef></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.raiseerror.desc"> - &title.desc; - <para>See <link linkend="core.pear.pear.raiseerror"><function>PEAR::raiseError</function></link></para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.raiseerror.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.raiseerror.note"> - &title.note; - ¬e.canstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.raiseerror.desc"> + &title.desc; + <para> + See + <link linkend="core.pear.pear.raiseerror"> + <function>PEAR::raiseError</function> + </link> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.raiseerror.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.raiseerror.note"> + &title.note; + ¬e.canstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml:1.2 peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml:1.3 --- peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml:1.2 Sat Oct 23 16:24:26 2004 +++ peardoc/en/core/pear/pear-errorstack/setcontextcallback.xml Mon Jul 18 03:15:59 2005 @@ -1,56 +1,73 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="core.pear.pear-errorstack.setcontextcallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setContextCallback</function></refname> - <refpurpose>Set a callback that generates context information (location of error) for an error stack</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setContextCallback</function></funcdef> - <paramdef>array|string|null <parameter>$contextCallback</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setContextCallback</function> + </refname> + <refpurpose> + Set a callback that generates context + information (location of error) for an error stack + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setContextCallback</function> + </funcdef> + <paramdef> + &type.array;|&type.string;|&type.null; + <parameter>$contextCallback</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.setcontextcallback.desc"> - &title.desc; - <para>This method sets the callback that can be used to generate context - information for an error. Passing in &null; will disable context generation - and remove the expensive call to <ulink url="&url.php.lookup;debug_backtrace"> - <function>debug_backtrace</function></ulink></para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setcontextcallback.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - &type.mixed; - <parameter>$contextCallback</parameter> - </term> - <listitem> - <para> - A valid callback as defined by <ulink url="&url.php.lookup;is_callable"><function>is_callable</function></ulink> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setcontextcallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setcontextcallback.note"> - &title.note; - ¬e.notstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setcontextcallback.desc"> + &title.desc; + <para> + This method sets the callback that can be used to generate context + information for an error. + + Passing in &null; will disable context generation + and remove the expensive call to + <ulink url="&url.php.lookup;debug_backtrace"> + <function>debug_backtrace</function></ulink> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setcontextcallback.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + &type.mixed; + <parameter>$contextCallback</parameter> + </term> + <listitem> + <para> + A valid callback as defined by + <ulink url="&url.php.lookup;is_callable"> + <function>is_callable</function> + </ulink> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setcontextcallback.throws"> + &title.throws; + &noexceptions; + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setcontextcallback.note"> + &title.note; + ¬e.notstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml diff -u peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.1 peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.2 --- peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml:1.1 Sat Mar 20 01:16:32 2004 +++ peardoc/en/core/pear/pear-errorstack/setdefaultcallback.xml Mon Jul 18 03:15:59 2005 @@ -1,54 +1,66 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="core.pear.pear-errorstack.setdefaultcallback"> - <refnamediv> - <refname><function>PEAR_ErrorStack::setDefaultCallback</function></refname> - <refpurpose>Sets a default callback to be used by all error stacks</refpurpose> - </refnamediv> - <refsynopsisdiv> - <funcsynopsis> - <funcsynopsisinfo> - require_once 'PEAR/ErrorStack.php'; - </funcsynopsisinfo> - <funcprototype> - <funcdef>void <function>PEAR_ErrorStack::setDefaultCallback</function></funcdef> - <paramdef>array|string <parameter> <optional>$callback = &false;</optional></parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> + <refnamediv> + <refname> + <function>PEAR_ErrorStack::setDefaultCallback</function> + </refname> + <refpurpose> + Sets a default callback to be used by all error stacks + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo> + require_once 'PEAR/ErrorStack.php'; + </funcsynopsisinfo> + <funcprototype> + <funcdef> + &type.void; + <function>PEAR_ErrorStack::setDefaultCallback</function> + </funcdef> + <paramdef> + &type.array;|&type.string; + <parameter><optional>$callback = &false;</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> - <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.desc"> - &title.desc; - <para>This method sets the callback that can be used to generate error messages for a singleton</para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.param"> - &title.param; - <para> - <variablelist> - <varlistentry> - <term> - <type>array|string</type> - <parameter>$callback</parameter> - </term> - <listitem> - <para> - Callback function/method - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.throws"> - &title.throws; - <para> - <emphasis>throws</emphasis> no exceptions thrown - </para> - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.desc"> + &title.desc; + <para> + This method sets the callback + that can be used to generate error + messages for a singleton + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.param"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <type>array|string</type> + <parameter>$callback</parameter> + </term> + <listitem> + <para> + Callback function/method + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.throws"> + &title.throws; + &noexceptions; + </refsect1> - <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.note"> - &title.note; - ¬e.shouldstatic; - </refsect1> + <refsect1 id="core.pear.pear-errorstack.setdefaultcallback.note"> + &title.note; + ¬e.shouldstatic; + </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: