reference/pspell/functions/pspell-new-config.xml
81b23db050ac0627b056585c16bfe95445ae174e
81b23db050ac0627b056585c16bfe95445ae174e
...
...
@@ -10,12 +10,12 @@
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<methodsynopsis>
13
-
<type>int</type><methodname>pspell_new_config</methodname>
14
-
<methodparam><type>int</type><parameter>config</parameter></methodparam>
13
+
<type class="union"><type>PSpell\Dictionary</type><type>false</type></type><methodname>pspell_new_config</methodname>
14
+
<methodparam><type>PSpell\Config</type><parameter>config</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<simpara>
17
17
<function>pspell_new_config</function> opens up a new dictionary with
18
-
settings specified in a config, created with
18
+
settings specified in a <parameter>config</parameter>, created with
19
19
<function>pspell_config_create</function> and modified with
20
20
<function>pspell_config_*</function> functions. This method provides you
21
21
with the most flexibility and has all the functionality provided by
...
...
@@ -44,10 +44,34 @@
44
44
<refsect1 role="returnvalues">
45
45
&reftitle.returnvalues;
46
46
<para>
47
-
Returns a dictionary link identifier on success.
47
+
Returns an <classname>PSpell\Dictionary</classname> instance on success, &return.falseforfailure;
48
48
</para>
49
49
</refsect1>
50
50
51
+
<refsect1 role="changelog">
52
+
&reftitle.changelog;
53
+
<informaltable>
54
+
<tgroup cols="2">
55
+
<thead>
56
+
<row>
57
+
<entry>&Version;</entry>
58
+
<entry>&Description;</entry>
59
+
</row>
60
+
</thead>
61
+
<tbody>
62
+
&pspell.changelog.pspell-config;
63
+
<row>
64
+
<entry>8.1.0</entry>
65
+
<entry>
66
+
Returns an <classname>PSpell\Dictionary</classname> instance now;
67
+
previously, a &resource; was returned.
68
+
</entry>
69
+
</row>
70
+
</tbody>
71
+
</tgroup>
72
+
</informaltable>
73
+
</refsect1>
74
+
51
75
<refsect1 role="examples">
52
76
&reftitle.examples;
53
77
<para>
...
...
@@ -59,7 +83,7 @@
59
83
$pspell_config = pspell_config_create("en");
60
84
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
61
85
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
62
-
$pspell_link = pspell_new_config($pspell_config);
86
+
$pspell = pspell_new_config($pspell_config);
63
87
?>
64
88
]]>
65
89
</programlisting>
66
90