[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/_appendices/resources.xml_language-snippets.ent_reference/
From: Christoph_Michael_Becker <cmb () php ! net>
Date: 2020-11-30 22:27:10
Message-ID: svn-cmb-1606775230-351794-41214017 () svn ! php ! net
[Download RAW message or body]
cmb Mon, 30 Nov 2020 22:27:10 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=351794
Log:
Generate enchant methodsynopses based on stubs
Closes GH-232.
Changed paths:
U phpdoc/en/trunk/appendices/resources.xml
U phpdoc/en/trunk/language-snippets.ent
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-describe.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-dict-exists.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-free-dict.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-free.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-get-dict-path.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-get-error.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-init.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-list-dicts.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-dict.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-pwl-dict.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-set-dict-path.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-broker-set-ordering.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-add-to-personal.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-add-to-session.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-check.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-describe.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-get-error.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-is-in-session.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-quick-check.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-store-replacement.xml
U phpdoc/en/trunk/reference/enchant/functions/enchant-dict-suggest.xml
U phpdoc/en/trunk/reference/enchant/setup.xml
["svn-diffs-351794.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/appendices/resources.xml
===================================================================
--- phpdoc/en/trunk/appendices/resources.xml 2020-11-30 20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/appendices/resources.xml 2020-11-30 22:27:10 UTC (rev 351794)
@@ -388,6 +388,46 @@
<entry>dbx result</entry>
</row>
<row>
+ <entry>enchant_broker</entry>
+ <entry>
+ <function>enchant_broker_init</function>
+ </entry>
+ <entry>
+ <function>enchant_broker_describe</function>,
+ <function>enchant_broker_dict_exists</function>,
+ <function>enchant_broker_get_dict_path</function>,
+ <function>enchant_broker_get_error</function>,
+ <function>enchant_broker_list_dicts</function>,
+ <function>enchant_broker_set_dict_path</function>,
+ <function>enchant_broker_set_ordering</function>
+ </entry>
+ <entry>
+ <function>enchant_broker_free</function>
+ </entry>
+ <entry>Enchant broker (prior to PHP 8.0.0)</entry>
+ </row>
+ <row>
+ <entry>enchant_dict</entry>
+ <entry>
+ <function>enchant_broker_request_dict</function>
+ <function>enchant_broker_request_pwl_dict</function>
+ </entry>
+ <entry>
+ <function>enchant_dict_add_to_personal</function>,
+ <function>enchant_dict_add_to_session</function>,
+ <function>enchant_dict_check</function>,
+ <function>enchant_dict_describe</function>,
+ <function>enchant_dict_get_error</function>,
+ <function>enchant_dict_is_in_session</function>,
+ <function>enchant_dict_store_replacement</function>,
+ <function>enchant_dict_suggest</function>
+ </entry>
+ <entry>
+ <function>enchant_broker_free_dict</function>
+ </entry>
+ <entry>Enchant dictionary (prior to PHP 8.0.0)</entry>
+ </row>
+ <row>
<entry>fbsql link</entry>
<entry>
<function>fbsql_change_user</function>,
Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent 2020-11-30 20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/language-snippets.ent 2020-11-30 22:27:10 UTC (rev 351794)
@@ -863,6 +863,43 @@
</itemizedlist>
</para>'>
+<!-- enchant entities -->
+
+<!ENTITY enchant.param.broker '<varlistentry xmlns="http://docbook.org/ns/docbook">
+ <term><parameter>broker</parameter></term>
+ <listitem>
+ <para>
+ An Enchant broker returned by <function>enchant_broker_init</function>.
+ </para>
+ </listitem>
+ </varlistentry>'>
+
+<!ENTITY enchant.param.dictionary '<varlistentry \
xmlns="http://docbook.org/ns/docbook"> + \
<term><parameter>dictionary</parameter></term> + <listitem>
+ <para>
+ An Enchant dictionary returned by \
<function>enchant_broker_request_dict</function> + or \
<function>enchant_broker_request_pwl_dict</function>. + </para>
+ </listitem>
+ </varlistentry>'>
+
+<!ENTITY enchant.changelog.broker-param '<row xmlns="http://docbook.org/ns/docbook">
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>broker</parameter> expects an <classname>EnchantBroker</classname> \
instance now; + previoulsy, a &resource; was expected.
+ </entry>
+</row>'>
+
+<!ENTITY enchant.changelog.dictionary-param '<row \
xmlns="http://docbook.org/ns/docbook"> + <entry>8.0.0</entry>
+ <entry>
+ <parameter>dictionary</parameter> expects an \
<classname>EnchantDictionary</classname> instance now; + previoulsy, a &resource; \
was expected. + </entry>
+</row>'>
+
<!-- IMAP notes -->
<!ENTITY imap.imap-stream.description '<varlistentry \
xmlns="http://docbook.org/ns/docbook"><term><parameter>
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-describe.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-describe.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-describe.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type class="union"><type>array</type><type>false</type></type><methodname>enchant_broker_describe</methodname>
- <methodparam><type>resource</type><parameter>broker</parameter></methodparam>
+ <type>array</type><methodname>enchant_broker_describe</methodname>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
Enumerates the Enchant providers and tells you some rudimentary
@@ -21,14 +21,7 @@
&reftitle.parameters;
<para>
<variablelist>
- <varlistentry>
- <term><parameter>broker</parameter></term>
- <listitem>
- <para>
- Broker resource
- </para>
- </listitem>
- </varlistentry>
+ &enchant.param.broker;
</variablelist>
</para>
</refsect1>
@@ -36,10 +29,33 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns an &array; of available Enchant providers with their details, \
&return.falseforfailure;. + Returns an &array; of available Enchant providers with \
their details. </para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ Prior to this version, the function returned &false; on failure.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -113,7 +129,6 @@
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-dict-exists.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-dict-exists.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-dict-exists.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_dict_exists</methodname>
- <methodparam><type>resource</type><parameter>broker</parameter></methodparam>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
</methodsynopsis>
<para>
@@ -20,15 +20,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.broker;
<varlistentry>
- <term><parameter>broker</parameter></term>
- <listitem>
- <para>
- Broker resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
@@ -47,6 +40,23 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -77,7 +87,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-free-dict.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-free-dict.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-free-dict.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_free_dict</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
Free a dictionary resource.
@@ -19,14 +19,7 @@
&reftitle.parameters;
<para>
<variablelist>
- <varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictionary resource.
- </para>
- </listitem>
- </varlistentry>
+ &enchant.param.dictionary;
</variablelist>
</para>
</refsect1>
@@ -38,7 +31,30 @@
</para>
</refsect1>
- <refsect1 role="seealso">
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>dictionary</parameter> expects a \
<classname>EnchantDictionary</classname> now; + previoulsy, a &resource; was \
expected. + </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
+ <refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
@@ -50,7 +66,6 @@
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-free.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-free.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-free.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_free</methodname>
- <methodparam><type>resource</type><parameter>broker</parameter></methodparam>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
Free a broker resource with all its dictionaries.
@@ -20,14 +20,7 @@
&reftitle.parameters;
<para>
<variablelist>
- <varlistentry>
- <term><parameter>broker</parameter></term>
- <listitem>
- <para>
- Broker resource
- </para>
- </listitem>
- </varlistentry>
+ &enchant.param.broker;
</variablelist>
</para>
</refsect1>
@@ -39,6 +32,23 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -48,7 +58,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-get-dict-path.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-get-dict-path.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-get-dict-path.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -1,6 +1,5 @@
<?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>
@@ -10,9 +9,9 @@
<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>
+ <type class="union"><type>string</type><type>false</type></type><methodname>enchant_broker_get_dict_path</methodname>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
+ <methodparam><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
Get the directory path for a given backend.
@@ -23,18 +22,11 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.broker;
<varlistentry>
- <term><parameter>broker</parameter></term>
+ <term><parameter>type</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>
@@ -52,7 +44,24 @@
</para>
</refsect1>
- <refsect1 role="seealso">
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
+ <refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
@@ -62,7 +71,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-get-error.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-get-error.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-get-error.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>enchant_broker_get_error</methodname>
- <methodparam><type>resource</type><parameter>broker</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>enchant_broker_get_error</methodname>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error which occurred in this broker.
@@ -20,14 +20,7 @@
&reftitle.parameters;
<para>
<variablelist>
- <varlistentry>
- <term><parameter>broker</parameter></term>
- <listitem>
- <para>
- Broker resource.
- </para>
- </listitem>
- </varlistentry>
+ &enchant.param.broker;
</variablelist>
</para>
</refsect1>
@@ -38,8 +31,24 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-init.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-init.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-init.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>resource</type><methodname>enchant_broker_init</methodname>
+ <type class="union"><type>EnchantBroker</type><type>false</type></type><methodname>enchant_broker_init</methodname>
<void/>
</methodsynopsis>
@@ -25,6 +25,29 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ On success, this function returns an <classname>EnchantBroker</classname> \
instance now; + previoulsy, a &resource; was retured.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -34,7 +57,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-list-dicts.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-list-dicts.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-list-dicts.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>mixed</type><methodname>enchant_broker_list_dicts</methodname>
- <methodparam><type>resource</type><parameter>broker</parameter></methodparam>
+ <type>array</type><methodname>enchant_broker_list_dicts</methodname>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
Returns a list of available dictionaries with their details.
@@ -20,14 +20,7 @@
&reftitle.parameters;
<para>
<variablelist>
- <varlistentry>
- <term><parameter>broker</parameter></term>
- <listitem>
- <para>
- Broker resource
- </para>
- </listitem>
- </varlistentry>
+ &enchant.param.broker;
</variablelist>
</para>
</refsect1>
@@ -35,10 +28,33 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns an &array; of available dictionaries with their details, \
&return.falseforfailure;. + Returns an &array; of available dictionaries with their \
details. </para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ Prior to this version, the function returned &false; on failure.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -123,7 +139,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-dict.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-dict.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-dict.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type class="union"><type>resource</type><type>false</type></type><methodname>enchant_broker_request_dict</methodname>
- <methodparam><type>resource</type><parameter>broker</parameter></methodparam>
+ <type class="union"><type>EnchantDictionary</type><type>false</type></type><methodname>enchant_broker_request_dict</methodname>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
</methodsynopsis>
<para>
@@ -21,15 +21,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.broker;
<varlistentry>
- <term><parameter>broker</parameter></term>
- <listitem>
- <para>
- Broker resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
@@ -48,6 +41,30 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ On success, this function returns an <classname>EnchantDictionary</classname> \
instance now; + previoulsy, a &resource; was retured.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -84,7 +101,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-pwl-dict.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-pwl-dict.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-pwl-dict.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type class="union"><type>resource</type><type>false</type></type><methodname>enchant_broker_request_pwl_dict</methodname>
- <methodparam><type>resource</type><parameter>broker</parameter></methodparam>
+ <type class="union"><type>EnchantDictionary</type><type>false</type></type><methodname>enchant_broker_request_pwl_dict</methodname>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
@@ -21,15 +21,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.broker;
<varlistentry>
- <term><parameter>broker</parameter></term>
- <listitem>
- <para>
- Broker resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
@@ -49,6 +42,30 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ On success, this function returns an <classname>EnchantDictionary</classname> \
instance now; + previoulsy, a &resource; was retured.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -60,7 +77,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-set-dict-path.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-set-dict-path.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-set-dict-path.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -1,6 +1,5 @@
<?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>
@@ -11,9 +10,9 @@
&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>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
+ <methodparam><type>int</type><parameter>type</parameter></methodparam>
+ <methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
Set the directory path for a given backend.
@@ -24,18 +23,11 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.broker;
<varlistentry>
- <term><parameter>broker</parameter></term>
+ <term><parameter>type</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>
@@ -42,7 +34,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>value</parameter></term>
+ <term><parameter>path</parameter></term>
<listitem>
<para>
The path of the dictionary directory.
@@ -60,7 +52,24 @@
</para>
</refsect1>
- <refsect1 role="seealso">
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
+ <refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
@@ -70,7 +79,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-broker-set-ordering.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-broker-set-ordering.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-broker-set-ordering.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_set_ordering</methodname>
- <methodparam><type>resource</type><parameter>broker</parameter></methodparam>
+ <methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
<methodparam><type>string</type><parameter>ordering</parameter></methodparam>
</methodsynopsis>
@@ -26,15 +26,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.broker;
<varlistentry>
- <term><parameter>broker</parameter></term>
- <listitem>
- <para>
- Broker resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
@@ -62,8 +55,24 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.broker-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-add-to-personal.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-add-to-personal.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-add-to-personal.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>enchant_dict_add_to_personal</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
@@ -20,15 +20,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.dictionary;
<varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictionary resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
@@ -46,6 +39,23 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
<example>
<title>Adding a word to a PWL</title>
@@ -79,7 +89,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-add-to-session.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-add-to-session.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-add-to-session.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>enchant_dict_add_to_session</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
@@ -22,15 +22,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.dictionary;
<varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictionary resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
@@ -48,6 +41,24 @@
&return.void;
</para>
</refsect1>
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -57,7 +68,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-check.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-check.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-check.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_dict_check</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
@@ -21,15 +21,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.dictionary;
<varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictionary resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
@@ -46,8 +39,25 @@
Returns &true; if the word is spelled correctly, &false; if not.
</para>
</refsect1>
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-describe.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-describe.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-describe.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>mixed</type><methodname>enchant_dict_describe</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <type>array</type><methodname>enchant_dict_describe</methodname>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
Returns the details of the dictionary.
@@ -20,14 +20,7 @@
&reftitle.parameters;
<para>
<variablelist>
- <varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictionary resource
- </para>
- </listitem>
- </varlistentry>
+ &enchant.param.dictionary;
</variablelist>
</para>
</refsect1>
@@ -39,6 +32,29 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ Prior to this version, the function returned &false; on failure.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -92,7 +108,6 @@
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-get-error.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-get-error.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-get-error.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>enchant_dict_get_error</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>enchant_dict_get_error</methodname>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error of the current spelling-session
@@ -20,14 +20,7 @@
&reftitle.parameters;
<para>
<variablelist>
- <varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictinaray resource
- </para>
- </listitem>
- </varlistentry>
+ &enchant.param.dictionary;
</variablelist>
</para>
</refsect1>
@@ -38,8 +31,24 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-is-in-session.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-is-in-session.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-is-in-session.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_dict_is_in_session</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
@@ -20,15 +20,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.dictionary;
<varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictionary resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
@@ -46,6 +39,23 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -56,7 +66,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-quick-check.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-quick-check.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-quick-check.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,9 +9,9 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_dict_quick_check</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
- <methodparam choice="opt"><type>array</type><parameter \
role="reference">suggestions</parameter></methodparam> + <methodparam \
choice="opt"><type>array</type><parameter \
role="reference">suggestions</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
If the word is correctly spelled return &true;, otherwise return &false;, if \
suggestions variable @@ -22,15 +22,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.dictionary;
<varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictionary resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
@@ -57,6 +50,23 @@
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -123,7 +133,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-store-replacement.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-store-replacement.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-store-replacement.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,9 +9,9 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>enchant_dict_store_replacement</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
- <methodparam><type>string</type><parameter>mis</parameter></methodparam>
- <methodparam><type>string</type><parameter>cor</parameter></methodparam>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
+ <methodparam><type>string</type><parameter>misspelled</parameter></methodparam>
+ <methodparam><type>string</type><parameter>correct</parameter></methodparam>
</methodsynopsis>
<para>
Add a correction for 'mis' using 'cor'.
@@ -24,24 +24,17 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.dictionary;
<varlistentry>
- <term><parameter>dict</parameter></term>
+ <term><parameter>misspelled</parameter></term>
<listitem>
<para>
- Dictionary resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mis</parameter></term>
- <listitem>
- <para>
The work to fix
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>cor</parameter></term>
+ <term><parameter>correct</parameter></term>
<listitem>
<para>
The correct word
@@ -57,8 +50,25 @@
&return.success;
</para>
</refsect1>
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/functions/enchant-dict-suggest.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/functions/enchant-dict-suggest.xml 2020-11-30 \
20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/functions/enchant-dict-suggest.xml 2020-11-30 \
22:27:10 UTC (rev 351794) @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>enchant_dict_suggest</methodname>
- <methodparam><type>resource</type><parameter>dict</parameter></methodparam>
+ <methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
@@ -19,15 +19,8 @@
&reftitle.parameters;
<para>
<variablelist>
+ &enchant.param.dictionary;
<varlistentry>
- <term><parameter>dict</parameter></term>
- <listitem>
- <para>
- Dictionary resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
@@ -46,6 +39,23 @@
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ &enchant.changelog.dictionary-param;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -85,7 +95,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/en/trunk/reference/enchant/setup.xml
===================================================================
--- phpdoc/en/trunk/reference/enchant/setup.xml 2020-11-30 20:39:29 UTC (rev 351793)
+++ phpdoc/en/trunk/reference/enchant/setup.xml 2020-11-30 22:27:10 UTC (rev 351794)
@@ -36,7 +36,7 @@
<section xml:id="enchant.resources">
&reftitle.resources;
<para>
- There are two types of resources in this extension. The first
+ Prior to PHP 8.0.0, there are two types of resources in this extension. The first
one is the broker (backends manager) and the second is for the
dictionary.
</para>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic