Re: Bug 626

From: Date: Tue, 03 Feb 2004 19:39:12 +0000
Subject: Re: Bug 626
References: 1 2  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-2377@lists.php.net to get a copy of this message
The only change is on line 97 (typo) On Feb 3, 2004, at 8:25 PM, Olivier Hill wrote: > David Costa wrote: >> Bug 626 >> I corrected the typo, the file is at >> http://php.gurugeek.org/pear/myfunction.xml.zip > > Please provide an unified diff file, attached as .txt (so the list > will let it through) > > Olivier > > -- > PEAR Documentation List Mailing List (http://pear.php.net/) > To unsubscribe, visit: http://www.php.net/unsub.php >

<!-- $Revision: 1.4 $ --> <refentry id="package.categorie.mypackage.myclass.myfunction"> <refnamediv> <refname>My_Class::myFunction()</refname> <refpurpose>a sample function</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'category/Package.php'; </funcsynopsisinfo> <funcprototype> <funcdef>string <function>My_Package::myFunction</function></funcdef> <paramdef> string <parameter>$param1</parameter> </paramdef> <paramdef> int <parameter><optional>$param2 = defaultvalue</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.categorie.mypackage.myclass.myfunction.desc"> &title.desc; <para> The function is self-descriptive </para> </refsect1> <refsect1 id="package.categorie.mypackage.myclass.myfunction.parameter"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$param1</parameter> </term> <listitem> <para> the first parameter of the function </para> </listitem> </varlistentry> <varlistentry> <term> &type.int; <parameter>$param2</parameter> <term> <listitem> <para> the second parameter </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.categorie.mypackage.myclass.myfunction.return"> &title.returns; <para> <parameter>string</parameter> - this function returns foo-bar encrypted data or throws &class.pear-error; incase of failure </para> </refsect1> <refsect1 id="packages.categorie.mypackage.myclass.myfunction.throws"> &title.throws; <para> <table> <tgroup cols="4"> <title>&title.throws.tablename</title> <thead> <row> <entry>Error code</entry> <entry>Error value</entry> <entry>Meaning</entry> <entry>Solution</entry> </row> </thead> <tbody> <row> <entry>1000</entry> <entry><quote>Guru Meditation</quote></entry> <entry>Your computer was overtaken by Jay Miner</entry> <entry>Use Kickstart 2.04 and ask Denise for a date</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="packages.categorie.mypackage.myclass.myfunction.note"> &title.note; &note.canstatic; &note.deprecated; <simpara> Function available since: Release 1.12 </simpara> <para> This function works only on a ZX 81. </para> </refsect1> <refsect1 id="packages.categorie.mypackage.myclass.myfunction.see"> &title.see; <!-- Additional links go here --> </refsect1> <refsect1 id="packages.categorie.mypackage.myclass.myfunction.example"> &title.example; <example> <title>Using <function>myFunction</function></title> <programlisting role="php"> <![CDATA[ <?php require_once "My/Package.php" $data = My_Package::myFunction( "foo", 1024) ; echo $data ; ?> ]]> </programlisting> </example> </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../../../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 -->
« previous php.pear.doc (#2377) next »