From 3d45ab8e594e83afed83735ee857e92637f2c50a Mon Sep 17 00:00:00 2001
From: Jeroen van Wolffelaar <jeroen@php.net>
Date: Mon, 13 Aug 2001 19:27:45 +0000
Subject: [PATCH] Fix a few types, and beatifying examples (according to PEAR)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@54604 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/aspell.xml | 36 ++++++++++++++++++++----------------
 1 file changed, 20 insertions(+), 16 deletions(-)

diff --git a/functions/aspell.xml b/functions/aspell.xml
index 3d7869bd8e..d1c241d90b 100644
--- a/functions/aspell.xml
+++ b/functions/aspell.xml
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
  <reference id="ref.aspell">
   <title>Aspell functions</title>
   <titleabbrev>Aspell</titleabbrev>
@@ -33,7 +33,7 @@
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
-      <funcdef>int <function>aspell_new</function></funcdef>
+      <funcdef>resource <function>aspell_new</function></funcdef>
       <paramdef>string <parameter>master</parameter></paramdef>
       <paramdef>string <parameter>personal</parameter></paramdef>
      </funcprototype>
@@ -41,12 +41,13 @@
     <simpara>
      <function>aspell_new</function> opens up a new dictionary and
      returns the dictionary link identifier for use in other aspell
-     functions.</simpara>
+     functions. Returns &false; on error.
+    </simpara>
     <para>
      <example>
       <title><function>aspell_new</function></title>
       <programlisting role="php">
-$aspell_link=aspell_new ("english");
+$aspell_link = aspell_new("english");
       </programlisting>
      </example>
     </para>
@@ -63,7 +64,7 @@ $aspell_link=aspell_new ("english");
     <funcsynopsis>
      <funcprototype>
       <funcdef>bool <function>aspell_check</function></funcdef>
-      <paramdef>int <parameter>dictionary_link</parameter></paramdef>
+      <paramdef>resource <parameter>dictionary_link</parameter></paramdef>
       <paramdef>string <parameter>word</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
@@ -75,8 +76,9 @@ $aspell_link=aspell_new ("english");
      <example>
       <title><function>aspell_check</function></title>
       <programlisting>
-$aspell_link=aspell_new ("english");
-if (aspell_check ($aspell_link, "testt")) {
+$aspell_link = aspell_new("english");
+
+if (aspell_check($aspell_link, "testt")) {
     echo "This is a valid spelling";
 } else {
     echo "Sorry, wrong spelling";
@@ -99,7 +101,7 @@ if (aspell_check ($aspell_link, "testt")) {
     <funcsynopsis>
      <funcprototype>
       <funcdef>bool <function>aspell_check_raw</function></funcdef>
-      <paramdef>int <parameter>dictionary_link</parameter></paramdef>
+      <paramdef>resource <parameter>dictionary_link</parameter></paramdef>
       <paramdef>string <parameter>word</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
@@ -112,8 +114,9 @@ if (aspell_check ($aspell_link, "testt")) {
      <example>
       <title><function>aspell_check_raw</function></title>
       <programlisting role="php">
-$aspell_link=aspell_new ("english");
-if (aspell_check_raw ($aspell_link, "test")) {
+$aspell_link = aspell_new("english");
+
+if (aspell_check_raw($aspell_link, "test")) {
     echo "This is a valid spelling";
 } else {
     echo "Sorry, wrong spelling";
@@ -134,7 +137,7 @@ if (aspell_check_raw ($aspell_link, "test")) {
     <funcsynopsis>
      <funcprototype>
       <funcdef>array <function>aspell_suggest</function></funcdef>
-      <paramdef>int <parameter>dictionary_link</parameter></paramdef>
+      <paramdef>resource <parameter>dictionary_link</parameter></paramdef>
       <paramdef>string <parameter>word</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
@@ -146,13 +149,13 @@ if (aspell_check_raw ($aspell_link, "test")) {
      <example>
       <title><function>aspell_suggest</function></title>
       <programlisting role="php">
-$aspell_link=aspell_new ("english");
+$aspell_link = aspell_new("english");
 
-if (!aspell_check ($aspell_link, "test")) {
-    $suggestions=aspell_suggest ($aspell_link, "test");
+if (!aspell_check($aspell_link, "test")) {
+    $suggestions = aspell_suggest($aspell_link, "test");
 
-    for ($i=0; $i &lt; count ($suggestions); $i++) {
-        echo "Possible spelling: " . $suggestions[$i] . "&lt;br>"; 
+    foreach ($suggestions as $suggestion) {
+        echo "Possible spelling: $suggestion&lt;br>\n"; 
     }
 }
       </programlisting>
@@ -178,4 +181,5 @@ sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
+vi: et:ts=1:sw=1:textwidth=78:syntax=sgml
 -->