documented enchant_broker_(g|s)et_dict_path() and related constants

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337544 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2015-08-18 21:58:44 +00:00
parent 5098c06cdd
commit b166dc655c
4 changed files with 210 additions and 3 deletions

View file

@ -3,7 +3,36 @@
<appendix xml:id="enchant.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&no.constants;
<para>
<variablelist>
<varlistentry xml:id="constant.enchant-myspell">
<term>
<constant>ENCHANT_MYSPELL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Dictionary type for MySpell. Used with
<function>enchant_broker_get_dict_path</function> and
<function>enchant_broker_set_dict_path</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.enchant-ispell">
<term>
<constant>ENCHANT_ISPELL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Dictionary type for Ispell. Used with
<function>enchant_broker_get_dict_path</function> and
<function>enchant_broker_set_dict_path</function>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</appendix>
<!-- Keep this comment at the end of the file

View file

@ -0,0 +1,85 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.enchant-broker-get-dict-path" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>enchant_broker_get_dict_path</refname>
<refpurpose>Get the directory path for a given backend</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_get_dict_path</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
<methodparam><type>int</type><parameter>dict_type</parameter></methodparam>
</methodsynopsis>
<para>
Get the directory path for a given backend.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dict_type</parameter></term>
<listitem>
<para>
The type of the dictionaries, i.e. <constant>ENCHANT_MYSPELL</constant>
or <constant>ENCHANT_ISPELL</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the path of the dictionary directory on
success&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_set_dict_path</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -0,0 +1,93 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.enchant-broker-set-dict-path" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>enchant_broker_set_dict_path</refname>
<refpurpose>Set the directory path for a given backend</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_set_dict_path</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
<methodparam><type>int</type><parameter>dict_type</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Set the directory path for a given backend.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dict_type</parameter></term>
<listitem>
<para>
The type of the dictionaries, i.e. <constant>ENCHANT_MYSPELL</constant>
or <constant>ENCHANT_ISPELL</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The path of the dictionary directory.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_get_dict_path</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -8,13 +8,13 @@
<function name='enchant_broker_dict_exists' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_broker_free' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_broker_free_dict' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_broker_get_dict_path' from='PHP 5 &gt;= 5.3.1 '/>
<function name='enchant_broker_get_dict_path' from='PHP 5 &gt;= 5.3.1, PECL enchant &gt;= 1.0.1'/>
<function name='enchant_broker_get_error' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_broker_init' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_broker_list_dicts' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 1.0.1'/>
<function name='enchant_broker_request_dict' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_broker_request_pwl_dict' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_broker_set_dict_path' from='PHP 5 &gt;= 5.3.1 '/>
<function name='enchant_broker_set_dict_path' from='PHP 5 &gt;= 5.3.1, PECL enchant &gt;= 1.0.1'/>
<function name='enchant_broker_set_ordering' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_dict_add_to_personal' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>
<function name='enchant_dict_add_to_session' from='PHP 5 &gt;= 5.3.0, PECL enchant &gt;= 0.1.0 '/>