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
This commit is contained in:
Mehdi Achour 2007-01-08 00:00:56 +00:00
parent 6b8ee90a41
commit beaea6bb7d
4 changed files with 191 additions and 33 deletions

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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