didou Sun Jan 7 23:38:21 2007 UTC
Modified files:
/phpdoc/en language-snippets.ent
/phpdoc/en/reference/apd reference.xml
/phpdoc/en/reference/apd/functions apd-breakpoint.xml
apd-callstack.xml apd-clunk.xml
apd-continue.xml apd-croak.xml
apd-dump-function-table.xml
apd-dump-persistent-resources.xml
apd-dump-regular-resources.xml
apd-echo.xml
apd-get-active-symbols.xml
apd-set-pprof-trace.xml
apd-set-session-trace.xml
apd-set-session.xml
apd-set-socket-session-trace.xml
override-function.xml
rename-function.xml
Log:
Document APD constants and rewrite docs to match new style
http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.176&r2=1.177&diff_format=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.176
phpdoc/en/language-snippets.ent:1.177
--- phpdoc/en/language-snippets.ent:1.176 Mon Jan 1 15:32:59 2007
+++ phpdoc/en/language-snippets.ent Sun Jan 7 23:38:20 2007
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.176 $ -->
+<!-- $Revision: 1.177 $ -->
<!-- Keep 'em sorted -->
@@ -441,6 +441,16 @@
<!ENTITY sqlsafemode '<link linkend="ini.sql.safe-mode">SQL safe mode</link>'>
+<!-- XMLWriter Notes -->
+<!ENTITY apd.debug-level.description '<varlistentry><term><parameter>
+debug_level</parameter></term><listitem><para>An integer which is formed by
adding
+together the <literal>XXX_TRACE</literal> constants.</para><para>It is not
recommended
+to use <constant>MEMORY_TRACE</constant>. It is very slow and does not appear
to be accurate.
+<constant>ASSIGNMENT_TRACE</constant> is not implemented yet.</para><para>To
turn on all
+functional traces (TIMING, FUNCTIONS, ARGS SUMMARY (like strace -c)) use the
value 99</para>
+</listitem></varlistentry>'>
+
+
<!-- Notes for SAPI/Apache -->
<!ENTITY note.apache.nsapi-module '<note><para>As of PHP 4.3.3 you can use
this function with the
<link linkend="ref.nsapi">NSAPI server module</link> in Netscape/iPlanet/SunONE
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/reference.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/apd/reference.xml
diff -u phpdoc/en/reference/apd/reference.xml:1.5
phpdoc/en/reference/apd/reference.xml:1.6
--- phpdoc/en/reference/apd/reference.xml:1.5 Sun Sep 4 11:49:40 2005
+++ phpdoc/en/reference/apd/reference.xml Sun Jan 7 23:38:21 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- Purpose: basic.php -->
<!-- Membership: pecl -->
@@ -37,10 +37,7 @@
&no.resource;
</section>
- <section id="apd.constants">
- &reftitle.constants;
- &no.constants;
- </section>
+ &reference.apd.constants;
<section id="apd.examples">
<title>How to use PHP-APD in your scripts</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-breakpoint.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-breakpoint.xml
diff -u phpdoc/en/reference/apd/functions/apd-breakpoint.xml:1.4
phpdoc/en/reference/apd/functions/apd-breakpoint.xml:1.5
--- phpdoc/en/reference/apd/functions/apd-breakpoint.xml:1.4 Sat Sep 16
20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-breakpoint.xml Sun Jan 7
23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.apd-breakpoint">
<refnamediv>
<refname>apd_breakpoint</refname>
<refpurpose>Stops the interpreter and waits on a CR from the
socket</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>apd_breakpoint</methodname>
<methodparam><type>int</type><parameter>debug_level</parameter></methodparam>
@@ -14,11 +14,32 @@
<para>
This can be used to stop the running of your script, and await responses
on the connected socket. To step the program, just send enter (a blank
- line), or enter a php command to be executed. A typical session using
- tcplisten would look like this.
+ line), or enter a php command to be executed.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ &apd.debug-level.description;
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <programlisting role="shell">
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Typical session using tcplisten</title>
+ <programlisting role="shell">
<![CDATA[
bash#tcplisten localhost 7777
@@ -55,9 +76,11 @@
........
>apd_continue(0);
]]>
- </programlisting>
+ </programlisting>
+ </example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-callstack.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-callstack.xml
diff -u phpdoc/en/reference/apd/functions/apd-callstack.xml:1.2
phpdoc/en/reference/apd/functions/apd-callstack.xml:1.3
--- phpdoc/en/reference/apd/functions/apd-callstack.xml:1.2 Sat Sep 16
20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-callstack.xml Sun Jan 7 23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.apd-callstack">
<refnamediv>
<refname>apd_callstack</refname>
<refpurpose>Returns the current call stack as an array</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>array</type><methodname>apd_callstack</methodname>
<void/>
@@ -14,6 +14,17 @@
<para>
Returns the current call stack as an array
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An array containing the current call stack.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_callstack</function> example</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-clunk.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-clunk.xml
diff -u phpdoc/en/reference/apd/functions/apd-clunk.xml:1.3
phpdoc/en/reference/apd/functions/apd-clunk.xml:1.4
--- phpdoc/en/reference/apd/functions/apd-clunk.xml:1.3 Sat Sep 16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-clunk.xml Sun Jan 7 23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.apd-clunk">
<refnamediv>
<refname>apd_clunk</refname>
<refpurpose>Throw a warning and a callstack</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>void</type><methodname>apd_clunk</methodname>
<methodparam><type>string</type><parameter>warning</parameter></methodparam>
@@ -14,21 +14,64 @@
</methodsynopsis>
<para>
Behaves like perl's Carp::cluck. Throw a warning and a callstack.
- The default line delimiter is "<BR />\n".
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>warning</parameter></term>
+ <listitem>
+ <para>
+ The warning to throw.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>delimiter</parameter></term>
+ <listitem>
+ <para>
+ The delimiter. Default to <literal><BR /></literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_clunk</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
-apd_clunk("Some Warning","<P>");
+apd_clunk("Some Warning", "<br/>");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>apd_croak</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-continue.xml?r1=1.7&r2=1.8&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-continue.xml
diff -u phpdoc/en/reference/apd/functions/apd-continue.xml:1.7
phpdoc/en/reference/apd/functions/apd-continue.xml:1.8
--- phpdoc/en/reference/apd/functions/apd-continue.xml:1.7 Sat Sep 16
20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-continue.xml Sun Jan 7 23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<refentry id="function.apd-continue">
<refnamediv>
<refname>apd_continue</refname>
<refpurpose>Restarts the interpreter</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>apd_continue</methodname>
<methodparam><type>int</type><parameter>debug_level</parameter></methodparam>
@@ -14,6 +14,26 @@
<para>
Usually sent via the socket to restart the interpreter.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ &apd.debug-level.description;
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_continue</function> example</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-croak.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-croak.xml
diff -u phpdoc/en/reference/apd/functions/apd-croak.xml:1.3
phpdoc/en/reference/apd/functions/apd-croak.xml:1.4
--- phpdoc/en/reference/apd/functions/apd-croak.xml:1.3 Sat Sep 16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-croak.xml Sun Jan 7 23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.apd-croak">
<refnamediv>
<refname>apd_croak</refname>
<refpurpose>Throw an error, a callstack and then exit</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>void</type><methodname>apd_croak</methodname>
<methodparam><type>string</type><parameter>warning</parameter></methodparam>
@@ -14,8 +14,43 @@
</methodsynopsis>
<para>
Behaves like perl's Carp::croak. Throw an error, a callstack and then
- exit. The default line delimiter is "<BR />\n".
+ exit.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>warning</parameter></term>
+ <listitem>
+ <para>
+ The warning to throw.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>delimiter</parameter></term>
+ <listitem>
+ <para>
+ The delimiter. Default to <literal><BR /></literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_croak</function> example</title>
@@ -29,6 +64,15 @@
</example>
</para>
</refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>apd_clunk</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-dump-function-table.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-dump-function-table.xml
diff -u phpdoc/en/reference/apd/functions/apd-dump-function-table.xml:1.3
phpdoc/en/reference/apd/functions/apd-dump-function-table.xml:1.4
--- phpdoc/en/reference/apd/functions/apd-dump-function-table.xml:1.3 Sat Sep
16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-dump-function-table.xml Sun Jan
7 23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.apd-dump-function-table">
<refnamediv>
<refname>apd_dump_function_table</refname>
<refpurpose>Outputs the current function table</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>void</type><methodname>apd_dump_function_table</methodname>
<void/>
@@ -14,6 +14,17 @@
<para>
Outputs the current function table.
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_dump_function_table</function> example</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-dump-persistent-resources.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-dump-persistent-resources.xml
diff -u phpdoc/en/reference/apd/functions/apd-dump-persistent-resources.xml:1.2
phpdoc/en/reference/apd/functions/apd-dump-persistent-resources.xml:1.3
--- phpdoc/en/reference/apd/functions/apd-dump-persistent-resources.xml:1.2
Sat Sep 16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-dump-persistent-resources.xml Sun Jan
7 23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.apd-dump-persistent-resources">
<refnamediv>
<refname>apd_dump_persistent_resources</refname>
<refpurpose>Return all persistent resources as an array</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>array</type><methodname>apd_dump_persistent_resources</methodname>
<void/>
@@ -14,6 +14,17 @@
<para>
Return all persistent resources as an array.
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An array containing the current call stack.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_dump_persistent_resources</function> example</title>
@@ -27,6 +38,15 @@
</example>
</para>
</refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>apd_dump_regular</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-dump-regular-resources.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-dump-regular-resources.xml
diff -u phpdoc/en/reference/apd/functions/apd-dump-regular-resources.xml:1.2
phpdoc/en/reference/apd/functions/apd-dump-regular-resources.xml:1.3
--- phpdoc/en/reference/apd/functions/apd-dump-regular-resources.xml:1.2
Sat Sep 16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-dump-regular-resources.xml Sun Jan
7 23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.apd-dump-regular-resources">
<refnamediv>
<refname>apd_dump_regular_resources</refname>
<refpurpose>Return all current regular resources as an array</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>array</type><methodname>apd_dump_regular_resources</methodname>
<void/>
@@ -14,6 +14,17 @@
<para>
Return all current regular resources as an array.
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An array containing the current regular resources.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_dump_regular_resources</function> example</title>
@@ -27,6 +38,15 @@
</example>
</para>
</refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>apd_dump_persistent_resources</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-echo.xml?r1=1.6&r2=1.7&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-echo.xml
diff -u phpdoc/en/reference/apd/functions/apd-echo.xml:1.6
phpdoc/en/reference/apd/functions/apd-echo.xml:1.7
--- phpdoc/en/reference/apd/functions/apd-echo.xml:1.6 Sat Sep 16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-echo.xml Sun Jan 7 23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<refentry id="function.apd-echo">
<refnamediv>
<refname>apd_echo</refname>
<refpurpose>Echo to the debugging socket</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>apd_echo</methodname>
<methodparam><type>string</type><parameter>output</parameter></methodparam>
@@ -15,6 +15,33 @@
Usually sent via the socket to request information about the running
script.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>output</parameter></term>
+ <listitem>
+ <para>
+ The debugged variable.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_echo</function> example</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-get-active-symbols.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-get-active-symbols.xml
diff -u phpdoc/en/reference/apd/functions/apd-get-active-symbols.xml:1.4
phpdoc/en/reference/apd/functions/apd-get-active-symbols.xml:1.5
--- phpdoc/en/reference/apd/functions/apd-get-active-symbols.xml:1.4 Thu Nov
2 11:09:07 2006
+++ phpdoc/en/reference/apd/functions/apd-get-active-symbols.xml Sun Jan
7 23:38:21 2007
@@ -1,20 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.apd-get-active-symbols">
<refnamediv>
<refname>apd_get_active_symbols</refname>
<refpurpose>Get an array of the current variables names in the local
scope</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>array</type><methodname>apd_get_active_symbols</methodname>
- <methodparam><parameter/></methodparam>
+ <void/>
</methodsynopsis>
<para>
Returns the names of all the variables defined in the active scope, (not
their values).
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ A multidimensional array with all the variables.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_get_active_symbols</function> example</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-set-pprof-trace.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-set-pprof-trace.xml
diff -u phpdoc/en/reference/apd/functions/apd-set-pprof-trace.xml:1.3
phpdoc/en/reference/apd/functions/apd-set-pprof-trace.xml:1.4
--- phpdoc/en/reference/apd/functions/apd-set-pprof-trace.xml:1.3 Sat Sep
16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-set-pprof-trace.xml Sun Jan 7
23:38:21 2007
@@ -1,21 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.apd-set-pprof-trace">
<refnamediv>
<refname>apd_set_pprof_trace</refname>
<refpurpose>Starts the session debugging</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>void</type><methodname>apd_set_pprof_trace</methodname>
<methodparam
choice="opt"><type>string</type><parameter>dump_directory</parameter></methodparam>
</methodsynopsis>
<para>
- Starts debugging to {dump_directory}/pprof_{process_id}, if
- dump_directory is not set, then the apd.dumpdir setting from the
- &php.ini; file is used.
+ Starts debugging to <filename>pprof_{process_id}</filename> in the
+ dump directory.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>dump_directory</parameter></term>
+ <listitem>
+ <para>
+ The directory in which the profile dump file is written. If not set,
+ the apd.dumpdir setting from the &php.ini; file is used.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_set_pprof_trace</function> example</title>
@@ -29,6 +56,16 @@
</example>
</para>
</refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>apd_set_session_trace</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-set-session-trace.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-set-session-trace.xml
diff -u phpdoc/en/reference/apd/functions/apd-set-session-trace.xml:1.3
phpdoc/en/reference/apd/functions/apd-set-session-trace.xml:1.4
--- phpdoc/en/reference/apd/functions/apd-set-session-trace.xml:1.3 Sat Sep
16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-set-session-trace.xml Sun Jan 7
23:38:21 2007
@@ -1,45 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.apd-set-session-trace">
<refnamediv>
<refname>apd_set_session_trace</refname>
<refpurpose>Starts the session debugging</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>void</type><methodname>apd_set_session_trace</methodname>
<methodparam><type>int</type><parameter>debug_level</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>dump_directory</parameter></methodparam>
</methodsynopsis>
<para>
- Starts debugging to {dump_directory}/apd_dump_{process_id}, if
- dump_directory is not set, then the apd.dumpdir setting from the
- &php.ini; file is used.
- </para>
- <para>
- debug_level is an integer which is formed by adding together the following
- values:
+ Starts debugging to <filename>apd_dump_{process_id}</filename> in the
+ dump directory.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- <programlisting role="script">
-<![CDATA[
- FUNCTION_TRACE 1
- ARGS_TRACE 2
- ASSIGNMENT_TRACE 4
- STATEMENT_TRACE 8
- MEMORY_TRACE 16
- TIMING_TRACE 32
- SUMMARY_TRACE 64
-]]>
- </programlisting>
+ <variablelist>
+ &apd.debug-level.description;
+ <varlistentry>
+ <term><parameter>dump_directory</parameter></term>
+ <listitem>
+ <para>
+ The directory in which the profile dump file is written. If not set,
+ the apd.dumpdir setting from the &php.ini; file is used.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- I would seriously not recommend using MEMORY_TRACE. It is very slow and
- does not appear to be accurate (great, huh?) also ASSIGNMENT_TRACE is not
- implemented. So, to turn on all functional traces (TIMING, FUNCTIONS, ARGS
- SUMMARY (like strace -c)) use the value 99
+ &return.void;
</para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_set_session_trace</function> example</title>
@@ -53,6 +58,7 @@
</example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-set-session.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-set-session.xml
diff -u phpdoc/en/reference/apd/functions/apd-set-session.xml:1.4
phpdoc/en/reference/apd/functions/apd-set-session.xml:1.5
--- phpdoc/en/reference/apd/functions/apd-set-session.xml:1.4 Thu Nov 2
11:09:07 2006
+++ phpdoc/en/reference/apd/functions/apd-set-session.xml Sun Jan 7
23:38:21 2007
@@ -1,34 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.apd-set-session">
<refnamediv>
<refname>apd_set_session</refname>
<refpurpose>Changes or sets the current debugging level</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>void</type><methodname>apd_set_session</methodname>
<methodparam><type>int</type><parameter>debug_level</parameter></methodparam>
</methodsynopsis>
<para>
This can be used to increase or decrease debugging in a different area of
- your application. <parameter>debug_level</parameter> is an integer which is
- formed by adding together the following values:
+ your application.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- <programlisting role="script">
-<![CDATA[
- FUNCTION_TRACE 1
- ARGS_TRACE 2
- ASSIGNMENT_TRACE 4
- STATEMENT_TRACE 8
- MEMORY_TRACE 16
- TIMING_TRACE 32
- SUMMARY_TRACE 64
-]]>
- </programlisting>
+ <variablelist>
+ &apd.debug-level.description;
+ </variablelist>
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_set_session</function> example</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/apd-set-socket-session-trace.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/apd/functions/apd-set-socket-session-trace.xml
diff -u phpdoc/en/reference/apd/functions/apd-set-socket-session-trace.xml:1.4
phpdoc/en/reference/apd/functions/apd-set-socket-session-trace.xml:1.5
--- phpdoc/en/reference/apd/functions/apd-set-socket-session-trace.xml:1.4
Sat Sep 16 20:33:25 2006
+++ phpdoc/en/reference/apd/functions/apd-set-socket-session-trace.xml Sun Jan
7 23:38:21 2007
@@ -1,51 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.apd-set-socket-session-trace">
<refnamediv>
<refname>apd_set_socket_session_trace</refname>
<refpurpose>Starts the remote session debugging</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>apd_set_socket_session_trace</methodname>
-
<methodparam><type>string</type><parameter>ip_address_or_unix_socket_file</parameter></methodparam>
+
<methodparam><type>string</type><parameter>tcp_server</parameter></methodparam>
<methodparam><type>int</type><parameter>socket_type</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam><type>int</type><parameter>debug_level</parameter></methodparam>
</methodsynopsis>
<para>
- Connects to the tcp server (eg. tcplisten) specified IP or Unix Domain
- socket (like a file), and sends debugging data to the socket. You can
- use any port, but higher numbers are better as most of the lower numbers
- may be used by other system services.
- </para>
- <para>
- the socket_type can be APD_AF_UNIX (for file based sockets) or APD_AF_INET
- (for standard tcp/ip)
+ Connects to the specified <parameter>tcp_server</parameter> (eg. tcplisten)
+ and sends debugging data to the socket.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
<para>
- debug_level is an integer which is formed by adding together the following
- values:
- </para>
- <para>
- <programlisting role="script">
-<![CDATA[
- FUNCTION_TRACE 1
- ARGS_TRACE 2
- ASSIGNMENT_TRACE 4
- STATEMENT_TRACE 8
- MEMORY_TRACE 16
- TIMING_TRACE 32
- SUMMARY_TRACE 64
-]]>
- </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>tcp_server</parameter></term>
+ <listitem>
+ <para>
+ IP or Unix Domain socket (like a file) of the TCP server.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>socket_type</parameter></term>
+ <listitem>
+ <para>
+ Can be <constant>AF_UNIX</constant> for file based sockets or
+ <constant>APD_AF_INET</constant> for standard tcp/ip.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>port</parameter></term>
+ <listitem>
+ <para>
+ You can use any port, but higher numbers are better as most of the
+ lower numbers may be used by other system services.
+ </para>
+ </listitem>
+ </varlistentry>
+ &apd.debug-level.description;
+ </variablelist>
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- I would seriously not recommend setting the value to 'zero' to start with,
- and use the breakpoint methods to start debugging at a specific place in
- the file.
+ &return.success;
</para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>apd_set_socket_session_trace</function> example</title>
@@ -59,6 +77,7 @@
</example>
</para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/override-function.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/apd/functions/override-function.xml
diff -u phpdoc/en/reference/apd/functions/override-function.xml:1.3
phpdoc/en/reference/apd/functions/override-function.xml:1.4
--- phpdoc/en/reference/apd/functions/override-function.xml:1.3 Sat Sep 16
20:33:25 2006
+++ phpdoc/en/reference/apd/functions/override-function.xml Sun Jan 7
23:38:21 2007
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.override-function">
<refnamediv>
<refname>override_function</refname>
<refpurpose>Overrides built-in functions</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>override_function</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
@@ -14,9 +14,60 @@
<methodparam><type>string</type><parameter>function_code</parameter></methodparam>
</methodsynopsis>
<para>
- Syntax similar to create_function(). Overrides built-in functions
- (replaces them in the symbol table).
+ Overrides built-in functions by replacing them in the symbol table.
</para>
+ </refsect1>
+
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>function_name</parameter></term>
+ <listitem>
+ <para>
+ The function to override.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>function_args</parameter></term>
+ <listitem>
+ <para>
+ The function arguments, as a coma separated string.
+ </para>
+ <para>
+ Usually you will want to pass this parameter, as well as the
+ <parameter>function_code</parameter> parameter, as a single quote
+ delimited string. The reason for using single quoted strings, is to
+ protect the variable names from parsing, otherwise, if you use double
+ quotes there will be a need to escape the variable names, e.g.
+ \<varname>$your_var</varname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>function_code</parameter></term>
+ <listitem>
+ <para>
+ The new code for the function.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>override_function</function> example</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/apd/functions/rename-function.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/apd/functions/rename-function.xml
diff -u phpdoc/en/reference/apd/functions/rename-function.xml:1.5
phpdoc/en/reference/apd/functions/rename-function.xml:1.6
--- phpdoc/en/reference/apd/functions/rename-function.xml:1.5 Sat Sep 16
20:33:25 2006
+++ phpdoc/en/reference/apd/functions/rename-function.xml Sun Jan 7
23:38:21 2007
@@ -1,21 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.rename-function">
<refnamediv>
<refname>rename_function</refname>
- <refpurpose>Renames orig_name to new_name in the global
function_table</refpurpose>
+ <refpurpose>Renames orig_name to new_name in the global function
table</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>rename_function</methodname>
<methodparam><type>string</type><parameter>original_name</parameter></methodparam>
<methodparam><type>string</type><parameter>new_name</parameter></methodparam>
</methodsynopsis>
<para>
- Renames orig_name to new_name in the global function_table. Useful
- for temporarily overriding builtin functions.
+ Renames a orig_name to new_name in the global function table. Useful
+ for temporarily overriding built-in functions.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>original_name</parameter></term>
+ <listitem>
+ <para>
+ The original function name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>new_name</parameter></term>
+ <listitem>
+ <para>
+ The new name for the <parameter>original_name</parameter> function.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>rename_function</function> example</title>
