cvs: peardoc /peardoc2/en/authoring/package/categorie mypackage.xml /peardoc2/en/authoring/package/categorie/mypackage myfunction.xml
/peardoc2/en/authoring/package/categorie/mypackage/myclass myfunction.xml
| From: | Alexander Merz | Date: | Fri, 03 Jan 2003 04:20:07 +0000 |
| Subject: | cvs: peardoc /peardoc2/en/authoring/package/categorie mypackage.xml /peardoc2/en/authoring/package/categorie/mypackage myfunction.xml /peardoc2/en/authoring/package/categorie/mypackage/myclass myfunction.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-193@lists.php.net to get a copy of this message | ||
alexmerz Thu Jan 2 23:20:07 2003 EDT
Added files:
/peardoc/peardoc2/en/authoring/package/categorie/mypackage/myclass
myfunction.xml
Removed files:
/peardoc/peardoc2/en/authoring/package/categorie/mypackage
myfunction.xml
Modified files:
/peardoc/peardoc2/en/authoring/package/categorie mypackage.xml
Log:
improved structure
Index: peardoc/peardoc2/en/authoring/package/categorie/mypackage.xml
diff -u peardoc/peardoc2/en/authoring/package/categorie/mypackage.xml:1.1.1.1
peardoc/peardoc2/en/authoring/package/categorie/mypackage.xml:1.2
--- peardoc/peardoc2/en/authoring/package/categorie/mypackage.xml:1.1.1.1 Mon Sep 30 23:23:03 2002
+++ peardoc/peardoc2/en/authoring/package/categorie/mypackage.xml Thu Jan 2 23:20:07 2003
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.1.1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<sect1 id="package.categorie.mypackage">
<title>MyPackage</title>
@@ -9,7 +9,7 @@
&package.categorie.mypackage.intro;
&package.categorie.mypackage.constants;
&package.categorie.mypackage.example;
- &package.categorie.mypackage.myfunction;
+ &package.categorie.mypackage.myclass.myfunction;
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
Index: peardoc/peardoc2/en/authoring/package/categorie/mypackage/myclass/myfunction.xml
+++ peardoc/peardoc2/en/authoring/package/categorie/mypackage/myclass/myfunction.xml
<!-- $Revision: 1.1 $ -->
<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>
<itemizedlist>
<listitem>
<para>
<parameter>string $param1</parameter> - the first parameter of the
function
</para>
</listitem>
<listitem>
<para>
<parameter>int $param2</parameter> - the second parameter
</para>
</listitem>
</itemizedlist>
</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;
¬e.canstatic;
¬e.deprecated;
<simpara>
Function avaible 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
-->