svn: /phpdoc/en/trunk/reference/errorfunc/functions/ debug-backtrace.xml debug-print-backtrace.xml
| From: | Sebastian Bergmann | Date: | Sat, 09 Apr 2011 10:07:36 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/errorfunc/functions/ debug-backtrace.xml debug-print-backtrace.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7937@lists.php.net to get a copy of this message | ||
sebastian Sat, 09 Apr 2011 10:07:36 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=310081
Log:
Update documentation of debug_backtrace() and debug_print_backtrace().
Changed paths:
U phpdoc/en/trunk/reference/errorfunc/functions/debug-backtrace.xml
U phpdoc/en/trunk/reference/errorfunc/functions/debug-print-backtrace.xml
Modified: phpdoc/en/trunk/reference/errorfunc/functions/debug-backtrace.xml
===================================================================
--- phpdoc/en/trunk/reference/errorfunc/functions/debug-backtrace.xml 2011-04-09 09:52:24 UTC (rev
310080)
+++ phpdoc/en/trunk/reference/errorfunc/functions/debug-backtrace.xml 2011-04-09 10:07:36 UTC (rev
310081)
@@ -11,6 +11,7 @@
<methodsynopsis>
<type>array</type><methodname>debug_backtrace</methodname>
<methodparam
choice="opt"><type>int</type><parameter>options</parameter><initializer>DEBUG_BACKTRACE_PROVIDE_OBJECT</initializer></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>limit</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>debug_backtrace</function> generates a PHP backtrace.
@@ -51,6 +52,14 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>limit</parameter></term>
+ <listitem>
+ <para>
+ Since 5.4.0, this parameter can be used to limit the number of stack frames returned. By
default (limit=0) it returns all stack frames.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1><!-- }}} -->
Modified: phpdoc/en/trunk/reference/errorfunc/functions/debug-print-backtrace.xml
===================================================================
--- phpdoc/en/trunk/reference/errorfunc/functions/debug-print-backtrace.xml 2011-04-09 09:52:24 UTC
(rev 310080)
+++ phpdoc/en/trunk/reference/errorfunc/functions/debug-print-backtrace.xml 2011-04-09 10:07:36 UTC
(rev 310081)
@@ -12,7 +12,8 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>debug_print_backtrace</methodname>
- <void/>
+ <methodparam
choice="opt"><type>int</type><parameter>options</parameter><initializer>DEBUG_BACKTRACE_PROVIDE_OBJECT</initializer></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>limit</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>debug_print_backtrace</function> prints a PHP backtrace. It
@@ -21,12 +22,49 @@
</para>
</refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- This function has no parameters.
- </para>
- </refsect1>
+ <refsect1 role="parameters"><!-- {{{ -->
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>options</parameter></term>
+ <listitem>
+ <para>
+ Since 5.3.6, this parameter is a bitmask for the following options:
+ <table>
+ <title><function>debug_backtrace</function> options</title>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>DEBUG_BACKTRACE_PROVIDE_OBJECT</entry>
+ <entry>
+ Whether or not to populate the "object" index.
+ </entry>
+ </row>
+ <row>
+ <entry>DEBUG_BACKTRACE_IGNORE_ARGS</entry>
+ <entry>
+ Whether or not to omit the "args" index and thus all the method arguments
+ to save memory.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>limit</parameter></term>
+ <listitem>
+ <para>
+ Since 5.4.0, this parameter can be used to limit the number of stack frames printed. By
default (limit=0) it prints all stack frames.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1><!-- }}} -->
<refsect1 role="returnvalues">
&reftitle.returnvalues;