From 742458d8429853ef54ff810c653ff71640e38e4e Mon Sep 17 00:00:00 2001
From: Anatol Belski <ab@php.net>
Date: Thu, 4 Apr 2013 18:20:09 +0000
Subject: [PATCH] documented the new gender methods

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330005 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/gender/gender/isnick.xml       | 82 ++++++++++++++++++++++++
 reference/gender/gender/similarnames.xml | 73 +++++++++++++++++++++
 reference/gender/versions.xml            |  2 +
 3 files changed, 157 insertions(+)
 create mode 100644 reference/gender/gender/isnick.xml
 create mode 100644 reference/gender/gender/similarnames.xml

diff --git a/reference/gender/gender/isnick.xml b/reference/gender/gender/isnick.xml
new file mode 100644
index 0000000000..8f3a9d3ee6
--- /dev/null
+++ b/reference/gender/gender/isnick.xml
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="gender-gender.isnick" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Gender\Gender::isNick</refname>
+  <refpurpose>Check if the name0 is an alias of the name1.</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>array</type><methodname>Gender\Gender::isNick</methodname>
+   <methodparam><type>string</type><parameter>name0</parameter></methodparam>
+   <methodparam><type>string</type><parameter>name1</parameter></methodparam>
+   <methodparam choice="opt"><type>integer</type><parameter>country</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+    Check whether the name0 is a nick of the name1.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+    <varlistentry>
+      <term><parameter>name0</parameter></term>
+        <listitem>
+          <para>
+            Name to check.
+          </para>
+       </listitem>
+     </varlistentry>
+    <varlistentry>
+      <term><parameter>name1</parameter></term>
+        <listitem>
+          <para>
+            Name to check.
+          </para>
+       </listitem>
+     </varlistentry>
+    <varlistentry>
+      <term><parameter>country</parameter></term>
+        <listitem>
+          <para>
+            Country id identified by Gender class constant. If ommited ANY_COUNTRY is used.
+          </para>
+       </listitem>
+     </varlistentry>
+   </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/gender/gender/similarnames.xml b/reference/gender/gender/similarnames.xml
new file mode 100644
index 0000000000..f0ae7f5551
--- /dev/null
+++ b/reference/gender/gender/similarnames.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="gender-gender.similarnames" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Gender\Gender::similarNames</refname>
+  <refpurpose>Get similar names.</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>array</type><methodname>Gender\Gender::similarNames</methodname>
+   <methodparam><type>string</type><parameter>name</parameter></methodparam>
+   <methodparam choice="opt"><type>integer</type><parameter>country</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+    Get similar names for the given name and country.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+    <varlistentry>
+      <term><parameter>name</parameter></term>
+        <listitem>
+          <para>
+            Name to check.
+          </para>
+       </listitem>
+     </varlistentry>
+    <varlistentry>
+      <term><parameter>country</parameter></term>
+        <listitem>
+          <para>
+            Country id identified by Gender class constant. If ommited ANY_COUNTRY is used.
+          </para>
+       </listitem>
+     </varlistentry>
+   </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+    Returns an array with the similar names found.
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/gender/versions.xml b/reference/gender/versions.xml
index 490eb04cae..ad5a784b90 100644
--- a/reference/gender/versions.xml
+++ b/reference/gender/versions.xml
@@ -10,6 +10,8 @@
  <function name='gender\gender::get' from='PECL gender &gt;= 0.6.0'/>
  <function name='gender\gender::connect' from='PECL gender &gt;= 0.6.0'/>
  <function name='gender\gender::country' from='PECL gender &gt;= 0.8.0'/>
+ <function name='gender\gender::similarNames' from='PECL gender &gt;= 0.9.0'/>
+ <function name='gender\gender::isNick' from='PECL gender &gt;= 0.9.0'/>
 </versions>
 
 <!-- Keep this comment at the end of the file