reference/strings/functions/wordwrap.xml
e095023e408c8cb6378ae16bb6870343a3946919
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.wordwrap">
3
+
<refentry xml:id="function.wordwrap" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>wordwrap</refname>
6
6
<refpurpose>Wraps a string to a given number of characters</refpurpose>
...
...
@@ -10,10 +10,10 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>string</type><methodname>wordwrap</methodname>
13
-
<methodparam><type>string</type><parameter>str</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>string</parameter></methodparam>
14
14
<methodparam choice="opt"><type>int</type><parameter>width</parameter><initializer>75</initializer></methodparam>
15
15
<methodparam choice="opt"><type>string</type><parameter>break</parameter><initializer>"\n"</initializer></methodparam>
16
-
<methodparam choice="opt"><type>bool</type><parameter>cut</parameter><initializer>&false;</initializer></methodparam>
16
+
<methodparam choice="opt"><type>bool</type><parameter>cut_long_words</parameter><initializer>&false;</initializer></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
Wraps a string to a given number of characters using a string break
...
...
@@ -26,7 +26,7 @@
26
26
<para>
27
27
<variablelist>
28
28
<varlistentry>
29
-
<term><parameter>str</parameter></term>
29
+
<term><parameter>string</parameter></term>
30
30
<listitem>
31
31
<para>
32
32
The input string.
...
...
@@ -51,10 +51,10 @@
51
51
</listitem>
52
52
</varlistentry>
53
53
<varlistentry>
54
-
<term><parameter>cut</parameter></term>
54
+
<term><parameter>cut_long_words</parameter></term>
55
55
<listitem>
56
56
<para>
57
-
If the <parameter>cut</parameter> is set to &true;, the string is
57
+
If the <parameter>cut_long_words</parameter> is set to &true;, the string is
58
58
always wrapped at or before the specified <parameter>width</parameter>. So if you have
59
59
a word that is larger than the given width, it is broken apart.
60
60
(See second example). When &false; the function does not split the word
...
...
@@ -156,7 +156,6 @@ something
156
156
</refsect1>
157
157

158
158
</refentry>
159
-

160
159
<!-- Keep this comment at the end of the file
161
160
Local variables:
162
161
mode: sgml
163
162