reference/enchant/functions/enchant-dict-add-to-personal.xml
94f2c273f0bb214580b3cba17273f79e8cc2cb25
...
...
@@ -3,83 +3,21 @@
3
3
<refentry xml:id="function.enchant-dict-add-to-personal" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>enchant_dict_add_to_personal</refname>
6
-
<refpurpose>Add a word to personal word list</refpurpose>
6
+
<refpurpose>&Alias; <function>enchant_dict_add</function></refpurpose>
7
7
</refnamediv>
8
-
<refsect1 role="description">
9
-
&reftitle.description;
10
-
<methodsynopsis>
11
-
<type>void</type><methodname>enchant_dict_add_to_personal</methodname>
12
-
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
13
-
<methodparam><type>string</type><parameter>word</parameter></methodparam>
14
-
</methodsynopsis>
15
-
<para>
16
-
Add a word to personal word list of the given dictionary.
17
-
</para>
18
-
</refsect1>
19
-
<refsect1 role="parameters">
20
-
&reftitle.parameters;
21
-
<para>
22
-
<variablelist>
23
-
<varlistentry>
24
-
<term><parameter>dict</parameter></term>
25
-
<listitem>
26
-
<para>
27
-
Dictionary resource
28
-
</para>
29
-
</listitem>
30
-
</varlistentry>
31
-
<varlistentry>
32
-
<term><parameter>word</parameter></term>
33
-
<listitem>
34
-
<para>
35
-
The word to add
36
-
</para>
37
-
</listitem>
38
-
</varlistentry>
39
-
</variablelist>
40
-
</para>
41
-
</refsect1>
42
-
<refsect1 role="returnvalues">
43
-
&reftitle.returnvalues;
44
-
<para>
45
-
&return.success;
46
-
</para>
47
-
</refsect1>
48
-
49
-
<refsect1 role="examples">
50
-
<example>
51
-
<title>Adding a word to a PWL</title>
52
-
<programlisting role="php">
53
-
<![CDATA[
54
-
<?php
55
-

56
-
$filename = './my_word_list.pwl';
57
-
$word = 'Supercalifragilisticexpialidocious';
58
8

59
-
$broker = enchant_broker_init();
60
-
$dict = enchant_broker_request_pwl_dict($broker, $filename);
9
+
<refsynopsisdiv>
10
+
&warn.deprecated.alias-8-0-0;
11
+
</refsynopsisdiv>
61
12

62
-
enchant_dict_add_to_personal($dict, $word);
63
-

64
-
enchant_broker_free($broker);
65
-

66
-
?>
67
-
]]>
68
-
</programlisting>
69
-
</example>
70
-
</refsect1>
71
-

72
-
<refsect1 role="seealso">
73
-
&reftitle.seealso;
74
-
<para>
75
-
<simplelist>
76
-
<member><function>enchant_broker_request_pwl_dict</function></member>
77
-
<member><function>enchant_broker_request_dict</function></member>
78
-
</simplelist>
79
-
</para>
13
+
<refsect1 role="description">
14
+
&reftitle.description;
15
+
<simpara>
16
+
&info.function.alias;
17
+
<function>enchant_dict_add</function>.
18
+
</simpara>
80
19
</refsect1>
81
20
</refentry>
82
-

83
21
<!-- Keep this comment at the end of the file
84
22
Local variables:
85
23
mode: sgml
86
24