[PHP-DOC] cvs: phpdoc /en/reference/mcrypt/functions mcrypt-module-self-test.xml

[Nuno Lopes]

nlopess         Fri Dec 19 05:36:23 2003 EDT

  Modified files:              
    /phpdoc/en/reference/mcrypt/functions       mcrypt-module-self-test.xml 
  Log:
  added example
  
Index: phpdoc/en/reference/mcrypt/functions/mcrypt-module-self-test.xml
diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-module-self-test.xml:1.3 
phpdoc/en/reference/mcrypt/functions/mcrypt-module-self-test.xml:1.4
--- phpdoc/en/reference/mcrypt/functions/mcrypt-module-self-test.xml:1.3        Sun 
May 12 17:00:20 2002
+++ phpdoc/en/reference/mcrypt/functions/mcrypt-module-self-test.xml    Fri Dec 19 
05:36:22 2003
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
   <refentry id="function.mcrypt-module-self-test">
    <refnamediv>
@@ -22,6 +22,28 @@
      The function returns &true; if the self test succeeds, or &false; when if
      fails.
     </para>
+    <para>
+     <example>
+      <title><function>mcrypt_module_self_test</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+var_dump(mcrypt_module_self_test(MCRYPT_RIJNDAEL_128)) . "\n";
+var_dump(mcrypt_module_self_test(MCRYPT_BOGUS_CYPHER));
+?>
+]]>
+      </programlisting>
+      <para>
+       The above example will output:
+      </para>
+      <screen>
+<![CDATA[
+bool(true)
+bool(false)
+]]>
+      </screen>
+     </example>
+    </para>
    </refsect1>
   </refentry>