philip Fri Apr 1 17:46:59 2005 EDT
Modified files:
/phpdoc/en/reference/mail/functions ezmlm-hash.xml
Log:
Implemented the new doc style.
http://cvs.php.net/diff.php/phpdoc/en/reference/mail/functions/ezmlm-hash.xml?r1=1.17&r2=1.18&ty=u
Index: phpdoc/en/reference/mail/functions/ezmlm-hash.xml
diff -u phpdoc/en/reference/mail/functions/ezmlm-hash.xml:1.17
phpdoc/en/reference/mail/functions/ezmlm-hash.xml:1.18
--- phpdoc/en/reference/mail/functions/ezmlm-hash.xml:1.17 Fri Apr 1
17:37:48 2005
+++ phpdoc/en/reference/mail/functions/ezmlm-hash.xml Fri Apr 1 17:46:58 2005
@@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.17 $ -->
+<!-- $Revision: 1.18 $ -->
<!-- splitted from ./en/functions/mail.xml, last change in rev 1.6 -->
<refentry id="function.ezmlm-hash">
<refnamediv>
<refname>ezmlm_hash</refname>
<refpurpose>Calculate the hash value needed by EZMLM</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ezmlm_hash</methodname>
<methodparam><type>string</type><parameter>addr</parameter></methodparam>
@@ -16,6 +17,33 @@
<function>ezmlm_hash</function> calculates the hash value needed
when keeping EZMLM mailing lists in a MySQL database.
</simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>addr</parameter></term>
+ <listitem>
+ <para>
+ The email address that's being hashed.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The hash value of <parameter>addr</parameter>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>Calculating the hash and subscribing a user</title>