reference/enchant/functions/enchant-broker-get-dict-path.xml
94f2c273f0bb214580b3cba17273f79e8cc2cb25
...
...
@@ -1,18 +1,21 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="function.enchant-broker-get-dict-path" xmlns="http://docbook.org/ns/docbook">
5
4
<refnamediv>
6
5
<refname>enchant_broker_get_dict_path</refname>
7
6
<refpurpose>Get 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
-
<type>bool</type><methodname>enchant_broker_get_dict_path</methodname>
14
-
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
15
-
<methodparam><type>int</type><parameter>dict_type</parameter></methodparam>
16
+
<type class="union"><type>string</type><type>false</type></type><methodname>enchant_broker_get_dict_path</methodname>
17
+
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
18
+
<methodparam><type>int</type><parameter>type</parameter></methodparam>
16
19
</methodsynopsis>
17
20
<para>
18
21
Get the directory path for a given backend.
...
...
@@ -23,16 +26,9 @@
23
26
&reftitle.parameters;
24
27
<para>
25
28
<variablelist>
29
+
&enchant.param.broker;
26
30
<varlistentry>
27
-
<term><parameter>broker</parameter></term>
28
-
<listitem>
29
-
<para>
30
-
Broker resource.
31
-
</para>
32
-
</listitem>
33
-
</varlistentry>
34
-
<varlistentry>
35
-
<term><parameter>dict_type</parameter></term>
31
+
<term><parameter>type</parameter></term>
36
32
<listitem>
37
33
<para>
38
34
The type of the dictionaries, i.e. <constant>ENCHANT_MYSPELL</constant>
...
...
@@ -52,7 +48,33 @@
52
48
</para>
53
49
</refsect1>
54
50

55
-
<refsect1 role="seealso">
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
+
&enchant.changelog.broker-param;
63
+
</tbody>
64
+
</tgroup>
65
+
</informaltable>
66
+
</refsect1>
67
+

68
+
<refsect1 role="notes">
69
+
&reftitle.notes;
70
+
<note>
71
+
<para>
72
+
This function is only available if the extension has been compiled with Enchant v1.
73
+
</para>
74
+
</note>
75
+
</refsect1>
76
+

77
+
<refsect1 role="seealso">
56
78
&reftitle.seealso;
57
79
<para>
58
80
<simplelist>
...
...
@@ -62,7 +84,6 @@
62
84
</refsect1>
63
85

64
86
</refentry>
65
-

66
87
<!-- Keep this comment at the end of the file
67
88
Local variables:
68
89
mode: sgml
69
90