reference/pspell/functions/pspell-config-create.xml
549aa1c4f045e8331b944626b35f3336262f5c14
549aa1c4f045e8331b944626b35f3336262f5c14
...
...
@@ -9,11 +9,11 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>int</type><methodname>pspell_config_create</methodname>
12
+
<type>PSpell\Config</type><methodname>pspell_config_create</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
</methodsynopsis>
18
18
<para>
19
19
Create a config used to open a dictionary.
...
...
@@ -87,10 +87,32 @@
87
87
<refsect1 role="returnvalues">
88
88
&reftitle.returnvalues;
89
89
<para>
90
-
Retuns a pspell config identifier, or &false; on error.
90
+
Returns an <classname>PSpell\Config</classname> instance.
91
91
</para>
92
92
</refsect1>
93
93
94
+
<refsect1 role="changelog">
95
+
&reftitle.changelog;
96
+
<informaltable>
97
+
<tgroup cols="2">
98
+
<thead>
99
+
<row>
100
+
<entry>&Version;</entry>
101
+
<entry>&Description;</entry>
102
+
</row>
103
+
</thead>
104
+
<tbody>
105
+
<row>
106
+
<entry>8.1.0</entry>
107
+
<entry>
108
+
Returns an <classname>PSpell\Config</classname> instance now;
109
+
previously, a &resource; was returned.
110
+
</entry>
111
+
</row>
112
+
</tbody>
113
+
</tgroup>
114
+
</informaltable>
115
+
</refsect1>
94
116
95
117
<refsect1 role="examples">
96
118
&reftitle.examples;
...
...
@@ -103,7 +125,7 @@
103
125
$pspell_config = pspell_config_create("en");
104
126
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
105
127
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
106
-
$pspell_link = pspell_new_personal($pspell_config, "en");
128
+
$pspell = pspell_new_personal($pspell_config, "en");
107
129
?>
108
130
]]>
109
131
</programlisting>
...
...
@@ -111,7 +133,6 @@ $pspell_link = pspell_new_personal($pspell_config, "en");
111
133
</para>
112
134
</refsect1>
113
135
</refentry>
114
-
115
136
<!-- Keep this comment at the end of the file
116
137
Local variables:
117
138
mode: sgml
118
139