reference/pspell/functions/pspell-new-personal.xml
81b23db050ac0627b056585c16bfe95445ae174e
81b23db050ac0627b056585c16bfe95445ae174e
...
...
@@ -9,12 +9,12 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>int</type><methodname>pspell_new_personal</methodname>
13
-
<methodparam><type>string</type><parameter>personal</parameter></methodparam>
12
+
<type class="union"><type>PSpell\Dictionary</type><type>false</type></type><methodname>pspell_new_personal</methodname>
13
+
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
14
14
<methodparam><type>string</type><parameter>language</parameter></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>spelling</parameter></methodparam>
16
-
<methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam>
17
-
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
15
+
<methodparam choice="opt"><type>string</type><parameter>spelling</parameter><initializer>""</initializer></methodparam>
16
+
<methodparam choice="opt"><type>string</type><parameter>jargon</parameter><initializer>""</initializer></methodparam>
17
+
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>""</initializer></methodparam>
18
18
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
19
19
</methodsynopsis>
20
20
<simpara>
...
...
@@ -40,7 +40,7 @@
40
40
<para>
41
41
<variablelist>
42
42
<varlistentry>
43
-
<term><parameter>personal</parameter></term>
43
+
<term><parameter>filename</parameter></term>
44
44
<listitem>
45
45
<para>
46
46
The file where words added to the personal list will be stored.
...
...
@@ -139,10 +139,33 @@
139
139
<refsect1 role="returnvalues">
140
140
&reftitle.returnvalues;
141
141
<para>
142
-
Returns the dictionary link identifier for use in other pspell functions.
142
+
Returns an <classname>PSpell\Dictionary</classname> instance on success,&return.falseforfailure;.
143
143
</para>
144
144
</refsect1>
145
145
146
+
<refsect1 role="changelog">
147
+
&reftitle.changelog;
148
+
<informaltable>
149
+
<tgroup cols="2">
150
+
<thead>
151
+
<row>
152
+
<entry>&Version;</entry>
153
+
<entry>&Description;</entry>
154
+
</row>
155
+
</thead>
156
+
<tbody>
157
+
<row>
158
+
<entry>8.1.0</entry>
159
+
<entry>
160
+
Returns an <classname>PSpell\Dictionary</classname> instance now;
161
+
previously, a &resource; was returned.
162
+
</entry>
163
+
</row>
164
+
</tbody>
165
+
</tgroup>
166
+
</informaltable>
167
+
</refsect1>
168
+
146
169
<refsect1 role="examples">
147
170
&reftitle.examples;
148
171
<para>
...
...
@@ -151,7 +174,7 @@
151
174
<programlisting role="php">
152
175
<![CDATA[
153
176
<?php
154
-
$pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws",
177
+
$pspell = pspell_new_personal ("/var/dictionaries/custom.pws",
155
178
"en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER);
156
179
?>
157
180
]]>
...
...
@@ -160,7 +183,6 @@ $pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws",
160
183
</para>
161
184
</refsect1>
162
185
</refentry>
163
-
164
186
<!-- Keep this comment at the end of the file
165
187
Local variables:
166
188
mode: sgml
167
189