reference/pspell/functions/pspell-new.xml
46364d741c835165e66564a1b17f33487cf923d2
46364d741c835165e66564a1b17f33487cf923d2
...
...
@@ -9,16 +9,16 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>int</type><methodname>pspell_new</methodname>
12
+
<type class="union"><type>PSpell\Dictionary</type><type>false</type></type><methodname>pspell_new</methodname>
13
13
<methodparam><type>string</type><parameter>language</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string</type><parameter>spelling</parameter></methodparam>
15
-
<methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam>
16
-
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
14
+
<methodparam choice="opt"><type>string</type><parameter>spelling</parameter><initializer>""</initializer></methodparam>
15
+
<methodparam choice="opt"><type>string</type><parameter>jargon</parameter><initializer>""</initializer></methodparam>
16
+
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>""</initializer></methodparam>
17
17
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
18
18
</methodsynopsis>
19
19
<para>
20
20
<function>pspell_new</function> opens up a new dictionary and
21
-
returns the dictionary link identifier for use in other pspell
21
+
returns an <classname>PSpell\Dictionary</classname> instance for use in other pspell
22
22
functions.
23
23
</para>
24
24
<para>
...
...
@@ -123,10 +123,33 @@
123
123
<refsect1 role="returnvalues">
124
124
&reftitle.returnvalues;
125
125
<para>
126
-
Returns the dictionary link identifier on success&return.falseforfailure;.
126
+
Returns an <classname>PSpell\Dictionary</classname> instance on success,&return.falseforfailure;.
127
127
</para>
128
128
</refsect1>
129
129
130
+
<refsect1 role="changelog">
131
+
&reftitle.changelog;
132
+
<informaltable>
133
+
<tgroup cols="2">
134
+
<thead>
135
+
<row>
136
+
<entry>&Version;</entry>
137
+
<entry>&Description;</entry>
138
+
</row>
139
+
</thead>
140
+
<tbody>
141
+
<row>
142
+
<entry>8.1.0</entry>
143
+
<entry>
144
+
Returns an <classname>PSpell\Dictionary</classname> instance now;
145
+
previously, a &resource; was returned.
146
+
</entry>
147
+
</row>
148
+
</tbody>
149
+
</tgroup>
150
+
</informaltable>
151
+
</refsect1>
152
+
130
153
<refsect1 role="examples">
131
154
&reftitle.examples;
132
155
<para>
...
...
@@ -135,8 +158,8 @@
135
158
<programlisting role="php">
136
159
<![CDATA[
137
160
<?php
138
-
$pspell_link = pspell_new("en", "", "", "",
139
-
(PSPELL_FAST|PSPELL_RUN_TOGETHER));
161
+
$pspell = pspell_new("en", "", "", "",
162
+
(PSPELL_FAST|PSPELL_RUN_TOGETHER));
140
163
?>
141
164
]]>
142
165
</programlisting>
...
...
@@ -144,7 +167,6 @@ $pspell_link = pspell_new("en", "", "", "",
144
167
</para>
145
168
</refsect1>
146
169
</refentry>
147
-
148
170
<!-- Keep this comment at the end of the file
149
171
Local variables:
150
172
mode: sgml
151
173