From beaea6bb7d7c441e692429a047a80742cf0f9fc5 Mon Sep 17 00:00:00 2001
From: Mehdi Achour <didou@php.net>
Date: Mon, 8 Jan 2007 00:00:56 +0000
Subject: [PATCH] Rewrite to match new format # yup, I know that this extension
 is dead

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@226696 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../aspell/functions/aspell-check-raw.xml     | 60 ++++++++++++++++---
 reference/aspell/functions/aspell-check.xml   | 60 ++++++++++++++++---
 reference/aspell/functions/aspell-new.xml     | 52 +++++++++++++---
 reference/aspell/functions/aspell-suggest.xml | 52 +++++++++++++---
 4 files changed, 191 insertions(+), 33 deletions(-)

diff --git a/reference/aspell/functions/aspell-check-raw.xml b/reference/aspell/functions/aspell-check-raw.xml
index 32b53da8b9..06f7386ae7 100644
--- a/reference/aspell/functions/aspell-check-raw.xml
+++ b/reference/aspell/functions/aspell-check-raw.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <refentry id="function.aspell-check-raw">
  <refnamediv>
   <refname>aspell_check_raw</refname> 
@@ -7,21 +7,56 @@
    Check a word without changing its case or trying to trim it [deprecated]
   </refpurpose>
  </refnamediv>
- <refsect1>
-  <title>Description</title>
+ <refsect1 role="description">
+  &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>aspell_check_raw</methodname>
    <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam>
    <methodparam><type>string</type><parameter>word</parameter></methodparam>
   </methodsynopsis>
-  <simpara>
+  <para>
    <function>aspell_check_raw</function> checks the spelling of a
-   word, without changing its case or trying to trim it in any way
-   and returns &true; if the spelling is correct, &false; if not.
-  </simpara>
+   word, without changing its case or trying to trim it in any way.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>dictionary_link</parameter></term>
+     <listitem>
+      <para>
+       The dictionnary link identifier returned by 
+       <function>aspell_new</function>.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>word</parameter></term>
+     <listitem>
+      <para>
+       The tested word.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the spelling is correct, &false; if not.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
   <para>
    <example>
-    <title><function>aspell_check_raw</function></title>
+    <title><function>aspell_check_raw</function> Example</title>
     <programlisting role="php">
 <![CDATA[
 <?php
@@ -40,6 +75,15 @@ if (aspell_check_raw($aspell_link, "test")) {
    </example>
   </para>
  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>aspell_check</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/aspell/functions/aspell-check.xml b/reference/aspell/functions/aspell-check.xml
index 75a1d6d23e..cc9f8aa8b0 100644
--- a/reference/aspell/functions/aspell-check.xml
+++ b/reference/aspell/functions/aspell-check.xml
@@ -1,24 +1,59 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <refentry id="function.aspell-check">
  <refnamediv>
   <refname>aspell_check</refname>
   <refpurpose>Check a word [deprecated]</refpurpose>
  </refnamediv>
- <refsect1>
-  <title>Description</title>
+ <refsect1 role="description">
+  &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>aspell_check</methodname>
    <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam>
    <methodparam><type>string</type><parameter>word</parameter></methodparam>
   </methodsynopsis>
-  <simpara>
-   <function>aspell_check</function> checks the spelling of a word
-   and returns &true; if the spelling is correct, &false; if not.
-  </simpara>
+  <para>
+   <function>aspell_check</function> checks the spelling of a word.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>dictionary_link</parameter></term>
+     <listitem>
+      <para>
+       The dictionnary link identifier returned by 
+       <function>aspell_new</function>.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>word</parameter></term>
+     <listitem>
+      <para>
+       The tested word.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the spelling is correct, &false; if not.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
   <para>
    <example>
-    <title><function>aspell_check</function></title>
+    <title><function>aspell_check</function> Example</title>
     <programlisting role="php">
 <![CDATA[
 <?php
@@ -37,6 +72,15 @@ if (aspell_check($aspell_link, "testt")) {
    </example>
   </para>
  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>aspell_check_raw</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/aspell/functions/aspell-new.xml b/reference/aspell/functions/aspell-new.xml
index d5a643edb0..d1506fbce3 100644
--- a/reference/aspell/functions/aspell-new.xml
+++ b/reference/aspell/functions/aspell-new.xml
@@ -1,25 +1,59 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <refentry id="function.aspell-new">
  <refnamediv>
   <refname>aspell_new</refname>
   <refpurpose>Load a new dictionary [deprecated]</refpurpose>
  </refnamediv>
- <refsect1>
-  <title>Description</title>
+ <refsect1 role="description">
+  &reftitle.description;
   <methodsynopsis>
    <type>int</type><methodname>aspell_new</methodname>
    <methodparam><type>string</type><parameter>master</parameter></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>personal</parameter></methodparam>
   </methodsynopsis>
-  <simpara>
-   <function>aspell_new</function> opens up a new dictionary and
-   returns the dictionary link identifier for use in other aspell
-   functions. Returns &false; on error.
-  </simpara>
+  <para>
+   <function>aspell_new</function> opens up a new dictionary for use with the
+   other aspell functions.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>master</parameter></term>
+     <listitem>
+      <para>
+       Language.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>personal</parameter></term>
+     <listitem>
+      <para>
+       Default to empty string.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns a dictionary link identifier or &false; on error.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
   <para>
    <example>
-    <title><function>aspell_new</function></title>
+    <title><function>aspell_new</function> Example</title>
     <programlisting role="php">
 <![CDATA[
 <?php
diff --git a/reference/aspell/functions/aspell-suggest.xml b/reference/aspell/functions/aspell-suggest.xml
index 3ba66f672d..2fd9735990 100644
--- a/reference/aspell/functions/aspell-suggest.xml
+++ b/reference/aspell/functions/aspell-suggest.xml
@@ -1,24 +1,60 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <refentry id="function.aspell-suggest">
  <refnamediv>
   <refname>aspell_suggest</refname>
   <refpurpose>Suggest spellings of a word [deprecated]</refpurpose>
  </refnamediv>
- <refsect1>
-  <title>Description</title>
+ <refsect1 role="description">
+  &reftitle.description;
   <methodsynopsis>
    <type>array</type><methodname>aspell_suggest</methodname>
    <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam>
    <methodparam><type>string</type><parameter>word</parameter></methodparam>
   </methodsynopsis>
-  <simpara>
-   <function>aspell_suggest</function> returns an array of possible
-   spellings for the given word.
-  </simpara>
+  <para>
+   <function>aspell_suggest</function> suggest spellings for the given
+   <parameter>word</parameter>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>dictionary_link</parameter></term>
+     <listitem>
+      <para>
+       The dictionnary link identifier returned by 
+       <function>aspell_new</function>.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>word</parameter></term>
+     <listitem>
+      <para>
+       The tested word.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an array of suggestions.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
   <para>
    <example>
-    <title><function>aspell_suggest</function></title>
+    <title><function>aspell_suggest</function> Example</title>
     <programlisting role="php">
 <![CDATA[
 <?php