From 5d29ab74d042295f84acc19a844539bb67bd4c9a Mon Sep 17 00:00:00 2001 From: Christoph Michael Becker Date: Fri, 22 Jun 2018 12:59:54 +0000 Subject: [PATCH] Add phpdbg documentation to the manual We start by running docgen, and fixing and fleshing out the documentation by what we can get by skimming the phpdbg.c code. We also fix and update the version information. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345181 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/phpdbg/book.xml | 41 +++++++ reference/phpdbg/constants.xml | 112 ++++++++++++++++++ .../phpdbg/functions/phpdbg-break-file.xml | 75 ++++++++++++ .../functions/phpdbg-break-function.xml | 66 +++++++++++ .../phpdbg/functions/phpdbg-break-method.xml | 75 ++++++++++++ .../phpdbg/functions/phpdbg-break-next.xml | 57 +++++++++ reference/phpdbg/functions/phpdbg-clear.xml | 57 +++++++++ reference/phpdbg/functions/phpdbg-color.xml | 75 ++++++++++++ .../phpdbg/functions/phpdbg-end-oplog.xml | 66 +++++++++++ reference/phpdbg/functions/phpdbg-exec.xml | 69 +++++++++++ .../functions/phpdbg-get-executable.xml | 66 +++++++++++ reference/phpdbg/functions/phpdbg-prompt.xml | 66 +++++++++++ .../phpdbg/functions/phpdbg-start-oplog.xml | 57 +++++++++ reference/phpdbg/ini.xml | 87 ++++++++++++++ reference/phpdbg/reference.xml | 30 +++++ reference/phpdbg/setup.xml | 33 ++++++ reference/phpdbg/versions.xml | 41 +++++++ 17 files changed, 1073 insertions(+) create mode 100644 reference/phpdbg/book.xml create mode 100644 reference/phpdbg/constants.xml create mode 100644 reference/phpdbg/functions/phpdbg-break-file.xml create mode 100644 reference/phpdbg/functions/phpdbg-break-function.xml create mode 100644 reference/phpdbg/functions/phpdbg-break-method.xml create mode 100644 reference/phpdbg/functions/phpdbg-break-next.xml create mode 100644 reference/phpdbg/functions/phpdbg-clear.xml create mode 100644 reference/phpdbg/functions/phpdbg-color.xml create mode 100644 reference/phpdbg/functions/phpdbg-end-oplog.xml create mode 100644 reference/phpdbg/functions/phpdbg-exec.xml create mode 100644 reference/phpdbg/functions/phpdbg-get-executable.xml create mode 100644 reference/phpdbg/functions/phpdbg-prompt.xml create mode 100644 reference/phpdbg/functions/phpdbg-start-oplog.xml create mode 100644 reference/phpdbg/ini.xml create mode 100644 reference/phpdbg/reference.xml create mode 100644 reference/phpdbg/setup.xml create mode 100644 reference/phpdbg/versions.xml diff --git a/reference/phpdbg/book.xml b/reference/phpdbg/book.xml new file mode 100644 index 0000000000..be37c8f4ac --- /dev/null +++ b/reference/phpdbg/book.xml @@ -0,0 +1,41 @@ + + + + + Phpdbg + Phpdbg + + + &reftitle.intro; + + Implemented as a SAPI module, phpdbg can exert complete control over the + environment without impacting the functionality or performance of your code. + + + + &reference.phpdbg.setup; + &reference.phpdbg.constants; + &reference.phpdbg.reference; + + + + diff --git a/reference/phpdbg/constants.xml b/reference/phpdbg/constants.xml new file mode 100644 index 0000000000..dab4d9d70e --- /dev/null +++ b/reference/phpdbg/constants.xml @@ -0,0 +1,112 @@ + + + + + &reftitle.constants; + &extension.constants; + + + + + PHPDBG_VERSION + (string) + + + + + + + + + PHPDBG_FILE + (integer) + + + + + + + + + PHPDBG_METHOD + (integer) + + + + + + + + + PHPDBG_LINENO + (integer) + + + + + + + + + PHPDBG_FUNC + (integer) + + + + + + + + + PHPDBG_COLOR_PROMPT + (integer) + + + + + + + + + PHPDBG_COLOR_NOTICE + (integer) + + + + + + + + + PHPDBG_COLOR_ERROR + (integer) + + + + + + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-break-file.xml b/reference/phpdbg/functions/phpdbg-break-file.xml new file mode 100644 index 0000000000..8951a45396 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-break-file.xml @@ -0,0 +1,75 @@ + + + + + + phpdbg_break_file + + + + + &reftitle.description; + + voidphpdbg_break_file + stringfile + intline + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + file + + + + + + + + line + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-break-function.xml b/reference/phpdbg/functions/phpdbg-break-function.xml new file mode 100644 index 0000000000..539a0a0901 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-break-function.xml @@ -0,0 +1,66 @@ + + + + + + phpdbg_break_function + + + + + &reftitle.description; + + voidphpdbg_break_function + stringfunction + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + function + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-break-method.xml b/reference/phpdbg/functions/phpdbg-break-method.xml new file mode 100644 index 0000000000..b6fc04f9be --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-break-method.xml @@ -0,0 +1,75 @@ + + + + + + phpdbg_break_method + + + + + &reftitle.description; + + voidphpdbg_break_method + stringclass + stringmethod + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + class + + + + + + + + method + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-break-next.xml b/reference/phpdbg/functions/phpdbg-break-next.xml new file mode 100644 index 0000000000..5cc597c3d4 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-break-next.xml @@ -0,0 +1,57 @@ + + + + + + phpdbg_break_next + Inserts a breakpoint at the next opcode + + + + &reftitle.description; + + voidphpdbg_break_next + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-clear.xml b/reference/phpdbg/functions/phpdbg-clear.xml new file mode 100644 index 0000000000..2198a78213 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-clear.xml @@ -0,0 +1,57 @@ + + + + + + phpdbg_clear + Clears all breakpoints + + + + &reftitle.description; + + voidphpdbg_clear + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-color.xml b/reference/phpdbg/functions/phpdbg-color.xml new file mode 100644 index 0000000000..28412cc931 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-color.xml @@ -0,0 +1,75 @@ + + + + + + phpdbg_color + + + + + &reftitle.description; + + voidphpdbg_color + intelement + stringcolor + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + element + + + One of the PHPDBG_COLOR_* constants. + + + + + color + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-end-oplog.xml b/reference/phpdbg/functions/phpdbg-end-oplog.xml new file mode 100644 index 0000000000..69e0320a9e --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-end-oplog.xml @@ -0,0 +1,66 @@ + + + + + + phpdbg_end_oplog + + + + + &reftitle.description; + + arrayphpdbg_end_oplog + arrayoptions + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + options + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-exec.xml b/reference/phpdbg/functions/phpdbg-exec.xml new file mode 100644 index 0000000000..9326eb60d7 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-exec.xml @@ -0,0 +1,69 @@ + + + + + + phpdbg_exec + Attempts to set the execution context + + + + &reftitle.description; + + mixedphpdbg_exec + stringcontext + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + context + + + + + + + + + + + &reftitle.returnvalues; + + If the execution context was set previously it is returned. + If the execution context was not set previously &true; is returned. + If the request to set the context fails, &false; is returned, and an + E_WARNING raised. + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-get-executable.xml b/reference/phpdbg/functions/phpdbg-get-executable.xml new file mode 100644 index 0000000000..f89b9b77c4 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-get-executable.xml @@ -0,0 +1,66 @@ + + + + + + phpdbg_get_executable + + + + + &reftitle.description; + + arrayphpdbg_get_executable + arrayoptions + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + options + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-prompt.xml b/reference/phpdbg/functions/phpdbg-prompt.xml new file mode 100644 index 0000000000..f973b9adf0 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-prompt.xml @@ -0,0 +1,66 @@ + + + + + + phpdbg_prompt + + + + + &reftitle.description; + + voidphpdbg_prompt + stringstring + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + string + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/phpdbg/functions/phpdbg-start-oplog.xml b/reference/phpdbg/functions/phpdbg-start-oplog.xml new file mode 100644 index 0000000000..2123771da4 --- /dev/null +++ b/reference/phpdbg/functions/phpdbg-start-oplog.xml @@ -0,0 +1,57 @@ + + + + + + phpdbg_start_oplog + + + + + &reftitle.description; + + voidphpdbg_start_oplog + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/phpdbg/ini.xml b/reference/phpdbg/ini.xml new file mode 100644 index 0000000000..41853ecbad --- /dev/null +++ b/reference/phpdbg/ini.xml @@ -0,0 +1,87 @@ + + + +
+ &reftitle.runtime; + &extension.runtime; + + + Phpdbg &ConfigureOptions; + + + + &Name; + &Default; + &Changeable; + &Changelog; + + + + + phpdbg.eol + 2 + PHP_INI_ALL + Available as of PHP 5.6.3 + + + phpdbg.path + + 6 + Available as of PHP 5.6.3 + + + +
+
+ + &ini.descriptions.title; + + + + + + phpdbg.eol + integer + + + + + + + + + + phpdbg.path + string + + + + + + + + + + +
+ + diff --git a/reference/phpdbg/reference.xml b/reference/phpdbg/reference.xml new file mode 100644 index 0000000000..7dce7fce3b --- /dev/null +++ b/reference/phpdbg/reference.xml @@ -0,0 +1,30 @@ + + + + + Phpdbg &Functions; + + &reference.phpdbg.entities.functions; + + + + diff --git a/reference/phpdbg/setup.xml b/reference/phpdbg/setup.xml new file mode 100644 index 0000000000..ac79901cd9 --- /dev/null +++ b/reference/phpdbg/setup.xml @@ -0,0 +1,33 @@ + + + + + &reftitle.setup; + +
+ &reftitle.runtime; + &no.config; +
+ +
+ + diff --git a/reference/phpdbg/versions.xml b/reference/phpdbg/versions.xml new file mode 100644 index 0000000000..d569de2d54 --- /dev/null +++ b/reference/phpdbg/versions.xml @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + +