Document is_xhtml parameter for nl2br()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@264802 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kalle Sommer Nielsen 2008-08-14 03:06:25 +00:00
parent cd0486c1b5
commit 0a596f62f4

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.nl2br">
<refnamediv>
<refname>nl2br</refname>
@ -11,6 +11,7 @@
<methodsynopsis>
<type>string</type><methodname>nl2br</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>bool</type><parameter>is_xhtml</parameter></methodparam>
</methodsynopsis>
<para>
Returns <parameter>string</parameter> with '&lt;br /&gt;' inserted
@ -30,6 +31,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>is_xhtml</parameter></term>
<listitem>
<para>
Whenever to use XHTML compatible line breaks or not (defaults to &true;)
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@ -41,32 +50,6 @@
</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>4.0.5</entry>
<entry>
<function>nl2br</function> is now XHTML compliant. All older versions
will return <parameter>string</parameter> with '&lt;br&gt;' inserted
before newlines instead of '&lt;br /&gt;'.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -90,6 +73,38 @@ foo isn't<br />
</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.3.0</entry>
<entry>
Added the <parameter>is_xhtml</parameter> parameter.
</entry>
</row>
<row>
<entry>4.0.5</entry>
<entry>
<function>nl2br</function> is now XHTML compliant. All older versions
will return <parameter>string</parameter> with '&lt;br&gt;' inserted
before newlines instead of '&lt;br /&gt;'.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>