cvs: peardoc /en/authoring/package categorie.xml /en/authoring/package/categorie mypackage.xml /en/authoring/package/categorie/mypackage
constants.xml example.xml intro.xml /en/authoring/package/categorie/mypackage/myclass myfunction.xml

danielc Fri Apr 9 12:48:53 2004 EDT Modified files: /peardoc/en/authoring/package categorie.xml /peardoc/en/authoring/package/categorie mypackage.xml /peardoc/en/authoring/package/categorie/mypackage constants.xml example.xml intro.xml /peardoc/en/authoring/package/categorie/mypackage/myclass myfunction.xml Log: Clean up leading whitespace and nesting.

http://cvs.php.net/diff.php/peardoc/en/authoring/package/categorie.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/authoring/package/categorie.xml diff -u peardoc/en/authoring/package/categorie.xml:1.3 peardoc/en/authoring/package/categorie.xml:1.4 --- peardoc/en/authoring/package/categorie.xml:1.3 Wed Feb 4 19:11:37 2004 +++ peardoc/en/authoring/package/categorie.xml Fri Apr 9 12:48:52 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <chapter id="package.categorie"> <title>Categorie</title> @@ -10,6 +10,7 @@ &package.categorie.mypackage; </chapter> + <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/diff.php/peardoc/en/authoring/package/categorie/mypackage.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/authoring/package/categorie/mypackage.xml diff -u peardoc/en/authoring/package/categorie/mypackage.xml:1.3 peardoc/en/authoring/package/categorie/mypackage.xml:1.4 --- peardoc/en/authoring/package/categorie/mypackage.xml:1.3 Wed Feb 4 19:11:39 2004 +++ peardoc/en/authoring/package/categorie/mypackage.xml Fri Apr 9 12:48:52 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <sect1 id="package.categorie.mypackage"> <title>MyPackage</title> @@ -10,7 +10,8 @@ &package.categorie.mypackage.constants; &package.categorie.mypackage.example; &package.categorie.mypackage.myclass.myfunction; - </sect1> +</sect1> + <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/diff.php/peardoc/en/authoring/package/categorie/mypackage/constants.xml?r1=1.4&r2=1.5&ty=u Index: peardoc/en/authoring/package/categorie/mypackage/constants.xml diff -u peardoc/en/authoring/package/categorie/mypackage/constants.xml:1.4 peardoc/en/authoring/package/categorie/mypackage/constants.xml:1.5 --- peardoc/en/authoring/package/categorie/mypackage/constants.xml:1.4 Wed Feb 4 19:06:47 2004 +++ peardoc/en/authoring/package/categorie/mypackage/constants.xml Fri Apr 9 12:48:52 2004 @@ -1,24 +1,28 @@ -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="packages.categorie.mypackage.constants"> - <refnamediv> - <refname>Constants</refname> - <refpurpose>Predefined Constants</refpurpose> - </refnamediv> - <refsect1 id="packages.categorie.mypackage.constants.my-constant"> - <title><constant>MY_CONSTANT</constant></title> - <para> - Just a constant which is never used. - </para> - <refsect2 id="packages.categorie.mypackage.constants.my-constant.used"> - <title>Used in</title> - <para> - <link linkend="packages.categorie.mypackage.myfunction"> - <function>MyPackage::myFunction</function> - </link> - </para> - </refsect2> - </refsect1> - </refentry> + <refnamediv> + <refname>Constants</refname> + <refpurpose>Predefined Constants</refpurpose> + </refnamediv> + + <refsect1 id="packages.categorie.mypackage.constants.my-constant"> + <title><constant>MY_CONSTANT</constant></title> + <para> + Just a constant which is never used. + </para> + + <refsect2 id="packages.categorie.mypackage.constants.my-constant.used"> + <title>Used in</title> + <para> + <link linkend="packages.categorie.mypackage.myfunction"> + <function>MyPackage::myFunction</function> + </link> + </para> + </refsect2> + + </refsect1> +</refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/diff.php/peardoc/en/authoring/package/categorie/mypackage/example.xml?r1=1.5&r2=1.6&ty=u Index: peardoc/en/authoring/package/categorie/mypackage/example.xml diff -u peardoc/en/authoring/package/categorie/mypackage/example.xml:1.5 peardoc/en/authoring/package/categorie/mypackage/example.xml:1.6 --- peardoc/en/authoring/package/categorie/mypackage/example.xml:1.5 Wed Mar 17 09:13:10 2004 +++ peardoc/en/authoring/package/categorie/mypackage/example.xml Fri Apr 9 12:48:52 2004 @@ -1,30 +1,33 @@ -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="packages.categorie.mypackage.example"> - <refnamediv> - <refname>Example</refname> - <refpurpose> - Examples for the masses - </refpurpose> - </refnamediv> - <refsect1> - <example> - <title>The first killer application</title> - <programlisting role="php"> - <![CDATA[ - // My killer application - ]]> - </programlisting> - </example> - <example> - <title>How to earn a lot of money</title> - <programlisting role="php"> - <![CDATA[ - // a script to send 10.000 spam mails in 1 min - ]]> - </programlisting> - </example> - </refsect1> - </refentry> + <refnamediv> + <refname>Example</refname> + <refpurpose> + Examples for the masses + </refpurpose> + </refnamediv> + + <refsect1> + <example> + <title>The first killer application</title> + <programlisting role="php"> + <![CDATA[ +// My killer application + ]]> + </programlisting> + </example> + + <example> + <title>How to earn a lot of money</title> + <programlisting role="php"> + <![CDATA[ +// a script to send 10.000 spam mails in 1 min + ]]> + </programlisting> + </example> + </refsect1> + +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/authoring/package/categorie/mypackage/intro.xml?r1=1.5&r2=1.6&ty=u Index: peardoc/en/authoring/package/categorie/mypackage/intro.xml diff -u peardoc/en/authoring/package/categorie/mypackage/intro.xml:1.5 peardoc/en/authoring/package/categorie/mypackage/intro.xml:1.6 --- peardoc/en/authoring/package/categorie/mypackage/intro.xml:1.5 Wed Feb 4 19:06:47 2004 +++ peardoc/en/authoring/package/categorie/mypackage/intro.xml Fri Apr 9 12:48:52 2004 @@ -1,38 +1,42 @@ -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="packages.categorie.mypackage.intro"> - <refnamediv> - <refname>Introduction</refname> - <refpurpose> - How to use My_Package - </refpurpose> - </refnamediv> - <refsect1 id="packages.categorie.mypackage.intro.contrib"> - <title>Contributers</title> - <para> - <itemizedlist> - <listitem><simpara>Alexander Merz</simpara></listitem> - </itemizedlist> - </para> - </refsect1> - <refsect1 id="packages.categorie.mypackage.intro.desc"> - <title>Description</title> - <para> - <classname>My_Package</classname> provides a lot of non-usefull - functions... Bla bla Bla bla Bla bla Bla bla - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - </para> - <para> - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla - </para> - </refsect1> - </refentry> + <refnamediv> + <refname>Introduction</refname> + <refpurpose> + How to use My_Package + </refpurpose> + </refnamediv> + + <refsect1 id="packages.categorie.mypackage.intro.contrib"> + <title>Contributers</title> + <para> + <itemizedlist> + <listitem><simpara>Alexander Merz</simpara></listitem> + </itemizedlist> + </para> + </refsect1> + + <refsect1 id="packages.categorie.mypackage.intro.desc"> + <title>Description</title> + <para> + <classname>My_Package</classname> provides a lot of non-usefull + functions... Bla bla Bla bla Bla bla Bla bla + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + </para> + + <para> + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + Bla bla Bla bla Bla bla Bla bla Bla bla Bla bla + </para> + </refsect1> + +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml?r1=1.7&r2=1.8&ty=u Index: peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml diff -u peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml:1.7 peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml:1.8 --- peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml:1.7 Wed Mar 17 09:12:20 2004 +++ peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml Fri Apr 9 12:48:53 2004 @@ -1,127 +1,136 @@ -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <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[ + <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> + ]]> + </programlisting> + </example> + </refsect1> + +</refentry> + <!-- Keep this comment at the end of the file Local variables: mode: sgml