php-doc-en/reference/phpdbg/functions/phpdbg-color.xml
Christoph Michael Becker c7378721ff Improve phpdbg documentation
* use lowercase “phpdbg” throughout
* flesh out the preface
* actually document some of the functions


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345198 c90b9560-bf6c-de11-be94-00142212c4b1
2018-06-24 14:43:55 +00:00

83 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.phpdbg-color" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>phpdbg_color</refname>
<refpurpose>Sets the color of certain elements</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>phpdbg_color</methodname>
<methodparam><type>int</type><parameter>element</parameter></methodparam>
<methodparam><type>string</type><parameter>color</parameter></methodparam>
</methodsynopsis>
<para>
Set the <parameter>color</parameter> of the given <parameter>element</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>element</parameter></term>
<listitem>
<para>
One of the <constant>PHPDBG_COLOR_*</constant> constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<para>
The name of the color. One of <literal>white</literal>, <literal>red</literal>,
<literal>green</literal>, <literal>yellow</literal>, <literal>blue</literal>,
<literal>purple</literal>, <literal>cyan</literal> or <literal>black</literal>,
optionally with either a trailing <literal>-bold</literal> or <literal>-underline</literal>,
for instance, <literal>white-bold</literal> or <literal>green-underline</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>phpdbg_prompt</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->