reference/enchant/functions/enchant-broker-set-dict-path.xml
94f2c273f0bb214580b3cba17273f79e8cc2cb25
94f2c273f0bb214580b3cba17273f79e8cc2cb25
...
...
@@ -1,19 +1,22 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="function.enchant-broker-set-dict-path" xmlns="http://docbook.org/ns/docbook">
5
4
<refnamediv>
6
5
<refname>enchant_broker_set_dict_path</refname>
7
6
<refpurpose>Set the directory path for a given backend</refpurpose>
8
7
</refnamediv>
9
8
9
+
<refsynopsisdiv>
10
+
&warn.deprecated.function-8-0-0;
11
+
</refsynopsisdiv>
12
+
10
13
<refsect1 role="description">
11
14
&reftitle.description;
12
15
<methodsynopsis>
13
16
<type>bool</type><methodname>enchant_broker_set_dict_path</methodname>
14
-
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
15
-
<methodparam><type>int</type><parameter>dict_type</parameter></methodparam>
16
-
<methodparam><type>string</type><parameter>value</parameter></methodparam>
17
+
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
18
+
<methodparam><type>int</type><parameter>type</parameter></methodparam>
19
+
<methodparam><type>string</type><parameter>path</parameter></methodparam>
17
20
</methodsynopsis>
18
21
<para>
19
22
Set the directory path for a given backend.
...
...
@@ -24,16 +27,9 @@
24
27
&reftitle.parameters;
25
28
<para>
26
29
<variablelist>
30
+
&enchant.param.broker;
27
31
<varlistentry>
28
-
<term><parameter>broker</parameter></term>
29
-
<listitem>
30
-
<para>
31
-
Broker resource.
32
-
</para>
33
-
</listitem>
34
-
</varlistentry>
35
-
<varlistentry>
36
-
<term><parameter>dict_type</parameter></term>
32
+
<term><parameter>type</parameter></term>
37
33
<listitem>
38
34
<para>
39
35
The type of the dictionaries, i.e. <constant>ENCHANT_MYSPELL</constant>
...
...
@@ -42,7 +38,7 @@
42
38
</listitem>
43
39
</varlistentry>
44
40
<varlistentry>
45
-
<term><parameter>value</parameter></term>
41
+
<term><parameter>path</parameter></term>
46
42
<listitem>
47
43
<para>
48
44
The path of the dictionary directory.
...
...
@@ -60,7 +56,33 @@
60
56
</para>
61
57
</refsect1>
62
58
63
-
<refsect1 role="seealso">
59
+
<refsect1 role="changelog">
60
+
&reftitle.changelog;
61
+
<informaltable>
62
+
<tgroup cols="2">
63
+
<thead>
64
+
<row>
65
+
<entry>&Version;</entry>
66
+
<entry>&Description;</entry>
67
+
</row>
68
+
</thead>
69
+
<tbody>
70
+
&enchant.changelog.broker-param;
71
+
</tbody>
72
+
</tgroup>
73
+
</informaltable>
74
+
</refsect1>
75
+
76
+
<refsect1 role="notes">
77
+
&reftitle.notes;
78
+
<note>
79
+
<para>
80
+
This function is only available if the extension has been compiled with Enchant v1.
81
+
</para>
82
+
</note>
83
+
</refsect1>
84
+
85
+
<refsect1 role="seealso">
64
86
&reftitle.seealso;
65
87
<para>
66
88
<simplelist>
...
...
@@ -70,7 +92,6 @@
70
92
</refsect1>
71
93
72
94
</refentry>
73
-
74
95
<!-- Keep this comment at the end of the file
75
96
Local variables:
76
97
mode: sgml
77
98