Generate ext/intl methodsynopses from stubs (Spoofchecker, Transliterator)

Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-907.
This commit is contained in:
Máté Kocsis 2021-09-05 13:14:59 +02:00 committed by Christoph M. Becker
parent 4aff696ed0
commit c67537e2d4
No known key found for this signature in database
GPG key ID: D66C9593118BCCB6
13 changed files with 73 additions and 96 deletions

View file

@ -120,6 +120,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spoofchecker')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spoofchecker')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="spoofchecker.areconfusable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Spoofchecker::areConfusable</refname>
@ -11,9 +10,9 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Spoofchecker::areConfusable</methodname>
<methodparam><type>string</type><parameter>str1</parameter></methodparam>
<methodparam><type>string</type><parameter>str2</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam>
<methodparam><type>string</type><parameter>string1</parameter></methodparam>
<methodparam><type>string</type><parameter>string2</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">errorCode</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Checks whether two given strings can easily be mistaken.
@ -24,7 +23,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>str1</parameter></term>
<term><parameter>string1</parameter></term>
<listitem>
<para>
First string to check.
@ -32,7 +31,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>str2</parameter></term>
<term><parameter>string2</parameter></term>
<listitem>
<para>
Second string to check.
@ -40,11 +39,11 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error</parameter></term>
<term><parameter>errorCode</parameter></term>
<listitem>
<para>
This variable is set by-reference to string containing an error, if there
were any.
This variable is set by-reference to &integer; containing an error, if there
was any.
</para>
</listitem>
</varlistentry>
@ -79,7 +78,6 @@ $checker->areConfusable('google.com', 'g00g1e.com'); // false
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="spoofchecker.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Spoofchecker::__construct</refname>
@ -9,10 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>Spoofchecker::__construct</methodname>
<void />
</methodsynopsis>
<void/>
</constructorsynopsis>
<para>
Creates new instance of Spoofchecker.
</para>
@ -30,7 +29,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="spoofchecker.issuspicious" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Spoofchecker::isSuspicious</refname>
@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Spoofchecker::isSuspicious</methodname>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">errorCode</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Checks if given string contains any suspicious characters like letters which
@ -24,7 +23,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>text</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
String to test.
@ -32,11 +31,11 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error</parameter></term>
<term><parameter>errorCode</parameter></term>
<listitem>
<para>
This variable is set by-reference to string containing an error, if there
were any.
This variable is set by-reference to &integer; containing an error, if there
was any.
</para>
</listitem>
</varlistentry>
@ -70,7 +69,6 @@ $checker->isSuspicious('Рaypal.com'); // TRUE
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="spoofchecker.setallowedlocales" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Spoofchecker::setAllowedLocales</refname>
@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Spoofchecker::setAllowedLocales</methodname>
<methodparam><type>string</type><parameter>locale_list</parameter></methodparam>
<methodparam><type>string</type><parameter>locales</parameter></methodparam>
</methodsynopsis>
<para>
@ -25,7 +24,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>locale_list</parameter></term>
<term><parameter>locales</parameter></term>
<listitem>
<para>
@ -44,7 +43,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Transliterator::__construct</refname>
@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis>
<modifier>private</modifier> <methodname>Transliterator::__construct</methodname>
<void />
<modifier>final</modifier> <modifier>private</modifier> <methodname>Transliterator::__construct</methodname>
<void/>
</constructorsynopsis>
<para>
This method should not be called. Its only purpose is to deny instantiation
@ -48,7 +47,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Transliterator::create</refname>
@ -11,16 +10,16 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>Transliterator</type><methodname>Transliterator::create</methodname>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>Transliterator</type><type>null</type></type><methodname>Transliterator::create</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>direction</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>direction</parameter><initializer>Transliterator::FORWARD</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>Transliterator</type><methodname>transliterator_create</methodname>
<methodsynopsis role="procedural">
<type class="union"><type>Transliterator</type><type>null</type></type><methodname>transliterator_create</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>direction</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>direction</parameter><initializer>Transliterator::FORWARD</initializer></methodparam>
</methodsynopsis>
<para>
Opens a Transliterator by ID.
@ -75,7 +74,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.createfromrules" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Transliterator::createFromRules</refname>
@ -11,16 +10,16 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>Transliterator</type><methodname>Transliterator::createFromRules</methodname>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>Transliterator</type><type>null</type></type><methodname>Transliterator::createFromRules</methodname>
<methodparam><type>string</type><parameter>rules</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>direction</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>direction</parameter><initializer>Transliterator::FORWARD</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>Transliterator</type><methodname>transliterator_create_from_rules</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>direction</parameter></methodparam>
<methodsynopsis role="procedural">
<type class="union"><type>Transliterator</type><type>null</type></type><methodname>transliterator_create_from_rules</methodname>
<methodparam><type>string</type><parameter>rules</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>direction</parameter><initializer>Transliterator::FORWARD</initializer></methodparam>
</methodsynopsis>
<para>
Creates a Transliterator from rules.
@ -46,7 +45,7 @@
<listitem>
<para>
The direction, defaults to
<link linkend="transliterator.constants.forward">>Transliterator::FORWARD</link>.
<link linkend="transliterator.constants.forward">&gt;Transliterator::FORWARD</link>.
May also be set to
<link linkend="transliterator.constants.reverse">Transliterator::REVERSE</link>.
</para>
@ -74,7 +73,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.createinverse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Transliterator::createInverse</refname>
@ -11,14 +10,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<modifier>public</modifier> <type>Transliterator</type><methodname>Transliterator::createInverse</methodname>
<void />
<methodsynopsis role="oop">
<modifier>public</modifier> <type class="union"><type>Transliterator</type><type>null</type></type><methodname>Transliterator::createInverse</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>Transliterator</type><methodname>transliterator_create_inverse</methodname>
<void />
<methodsynopsis role="procedural">
<type class="union"><type>Transliterator</type><type>null</type></type><methodname>transliterator_create_inverse</methodname>
<methodparam><type>Transliterator</type><parameter>transliterator</parameter></methodparam>
</methodsynopsis>
<para>
Opens the inverse transliterator.
@ -52,7 +51,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.geterrorcode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Transliterator::getErrorCode</refname>
@ -11,14 +10,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Transliterator::getErrorCode</methodname>
<void />
</methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>Transliterator::getErrorCode</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>int</type><methodname>transliterator_get_error_code</methodname>
<methodparam><type>Transliterator</type><parameter>trans</parameter></methodparam>
<methodsynopsis role="procedural">
<type class="union"><type>int</type><type>false</type></type><methodname>transliterator_get_error_code</methodname>
<methodparam><type>Transliterator</type><parameter>transliterator</parameter></methodparam>
</methodsynopsis>
<para>
Gets the last error code for this transliterator.
@ -32,7 +31,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>trans</parameter></term>
<term><parameter>transliterator</parameter></term>
<listitem>
<para>
</para>
@ -60,7 +59,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.geterrormessage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Transliterator::getErrorMessage</refname>
@ -11,14 +10,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Transliterator::getErrorMessage</methodname>
<void />
</methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Transliterator::getErrorMessage</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>string</type><methodname>transliterator_get_error_message</methodname>
<methodparam><type>Transliterator</type><parameter>trans</parameter></methodparam>
<methodsynopsis role="procedural">
<type class="union"><type>string</type><type>false</type></type><methodname>transliterator_get_error_message</methodname>
<methodparam><type>Transliterator</type><parameter>transliterator</parameter></methodparam>
</methodsynopsis>
<para>
Gets the last error message for this transliterator.
@ -32,7 +31,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>trans</parameter></term>
<term><parameter>transliterator</parameter></term>
<listitem>
<para>
</para>
@ -60,7 +59,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.listids" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Transliterator::listIDs</refname>
@ -11,14 +10,14 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>Transliterator::listIDs</methodname>
<void />
<void/>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<methodsynopsis role="procedural">
<type class="union"><type>array</type><type>false</type></type><methodname>transliterator_list_ids</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns an array with the registered transliterator IDs.
@ -82,7 +81,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.transliterate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Transliterator::transliterate</refname>
@ -11,19 +10,19 @@
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<methodsynopsis role="oop">
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Transliterator::transliterate</methodname>
<methodparam><type>string</type><parameter>subject</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<methodname>transliterator_transliterate</methodname>
<methodparam><type>mixed</type><parameter>transliterator</parameter></methodparam>
<methodparam><type>string</type><parameter>subject</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end</parameter></methodparam>
<methodsynopsis role="procedural">
<type class="union"><type>string</type><type>false</type></type><methodname>transliterator_transliterate</methodname>
<methodparam><type class="union"><type>Transliterator</type><type>string</type></type><parameter>transliterator</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
Transforms a string or part thereof using an ICU transliterator.
@ -44,7 +43,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>subject</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The string to be transformed.
@ -128,7 +127,6 @@ echo transliterator_transliterate("Hex-Any/Java", $encSupplChar), "\n";
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml