svn: /phpdoc/en/trunk/reference/errorfunc/functions/ debug-backtrace.xml debug-print-backtrace.xml
| From: | Peter Cowburn | Date: | Wed, 04 May 2011 21:27:46 +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-8067@lists.php.net to get a copy of this message | ||
salathe Wed, 04 May 2011 21:27:46 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=310770
Log:
tidied debug_(print_)backtrace parameters, changelogs, return value (doc #54653)
Bug: http://bugs.php.net/54653 (Open) return value lsited
for debug_backtrace wrong
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-05-04 20:04:07 UTC (rev
310769)
+++ phpdoc/en/trunk/reference/errorfunc/functions/debug-backtrace.xml 2011-05-04 21:27:46 UTC (rev
310770)
@@ -26,7 +26,7 @@
<term><parameter>options</parameter></term>
<listitem>
<para>
- Since 5.3.6, this parameter is a bitmask for the following options:
+ As of 5.3.6, this parameter is a bitmask for the following options:
<table>
<title><function>debug_backtrace</function> options</title>
<tgroup cols="2">
@@ -40,15 +40,15 @@
<row>
<entry>DEBUG_BACKTRACE_IGNORE_ARGS</entry>
<entry>
- Whether or not to omit the "args" index and thus all the method arguments
+ Whether or not to omit the "args" index, and thus all the function/method
arguments,
to save memory.
</entry>
</row>
</tbody>
</tgroup>
</table>
- Before 5.3.6, only value recognized is &true; or &false;, which is the same as
- setting and unsetting <constant>DEBUG_BACKTRACE_PROVIDE_OBJECT</constant>
option.
+ Before 5.3.6, the only values recognized are &true; or &false;, which are the same
as
+ setting or not setting the <constant>DEBUG_BACKTRACE_PROVIDE_OBJECT</constant>
option respectively.
</para>
</listitem>
</varlistentry>
@@ -56,7 +56,8 @@
<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.
+ As of 5.4.0, this parameter can be used to limit the number of stack frames returned.
+ By default (<parameter>limit</parameter>=<literal>0</literal>) it
returns all stack frames.
</para>
</listitem>
</varlistentry>
@@ -67,7 +68,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns an associative <type>array</type>. The possible returned elements
+ Returns an array of associative <type>array</type>s. The possible returned elements
are as follows:
</para>
<para>
@@ -156,6 +157,12 @@
</thead>
<tbody>
<row>
+ <entry>5.4.0</entry>
+ <entry>
+ Added the optional parameter <parameter>limit</parameter>.
+ </entry>
+ </row>
+ <row>
<entry>5.3.6</entry>
<entry>
The parameter <parameter>provide_object</parameter> changed to
<parameter>options</parameter> and additional option
Modified: phpdoc/en/trunk/reference/errorfunc/functions/debug-print-backtrace.xml
===================================================================
--- phpdoc/en/trunk/reference/errorfunc/functions/debug-print-backtrace.xml 2011-05-04 20:04:07 UTC
(rev 310769)
+++ phpdoc/en/trunk/reference/errorfunc/functions/debug-print-backtrace.xml 2011-05-04 21:27:46 UTC
(rev 310770)
@@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>debug_print_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>options</parameter><initializer>0</initializer></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>limit</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
@@ -30,21 +30,15 @@
<term><parameter>options</parameter></term>
<listitem>
<para>
- Since 5.3.6, this parameter is a bitmask for the following options:
+ As of 5.3.6, this parameter is a bitmask for the following options:
<table>
- <title><function>debug_backtrace</function> options</title>
+ <title><function>debug_print_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
+ Whether or not to omit the "args" index, and thus all the function/method
arguments,
to save memory.
</entry>
</row>
@@ -58,7 +52,8 @@
<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.
+ As of 5.4.0, this parameter can be used to limit the number of stack frames printed.
+ By default (<parameter>limit</parameter>=<literal>0</literal>) it
prints all stack frames.
</para>
</listitem>
</varlistentry>
@@ -73,6 +68,36 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>5.4.0</entry>
+ <entry>
+ Added the optional parameter <parameter>limit</parameter>.
+ </entry>
+ </row>
+ <row>
+ <entry>5.3.6</entry>
+ <entry>
+ Added the optional parameter <parameter>options</parameter>.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>