adding docs and example

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@172602 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes 2004-11-13 17:58:53 +00:00
parent 658f71e867
commit 4eacb86850

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.debug-print-backtrace">
<refnamediv>
<refname>debug_print_backtrace</refname>
@ -14,16 +14,88 @@
<void/>
</methodsynopsis>
<para>
<function>debug_print_backtrace</function> prints a PHP backtrace.
</para>
&warn.undocumented.func;
<para>
See also <function>debug_backtrace</function>.
<function>debug_print_backtrace</function> prints a PHP backtrace. It
prints the function calls, included/required files and
<function>eval</function>ed stuff.
</para>
</refsect1>
</refentry>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
This function has no parameters.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>debug_print_backtrace</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// include.php file
function a() {
b();
}
function b() {
c();
}
function c(){
debug_print_backtrace();
}
a();
?>
<?php
// test.php file
// this is the file you should run
include 'include.php';
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
#0 eval() called at [/tmp/include.php:5]
#1 a() called at [/tmp/include.php:17]
#2 include(/tmp/include.php) called at [/tmp/test.php:3]
#0 c() called at [/tmp/include.php:10]
#1 b() called at [/tmp/include.php:6]
#2 a() called at [/tmp/include.php:17]
#3 include(/tmp/include.php) called at [/tmp/test.php:3]
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>debug_backtrace</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: