hholzgra Sat Feb 2 09:14:23 2002 EDT
Modified files:
/phpdoc/howto working.xml
Log:
changing description to docbook4 style function prototypes
Index: phpdoc/howto/working.xml
diff -u phpdoc/howto/working.xml:1.13 phpdoc/howto/working.xml:1.14
--- phpdoc/howto/working.xml:1.13 Wed Jan 9 04:44:42 2002
+++ phpdoc/howto/working.xml Sat Feb 2 09:14:22 2002
@@ -224,7 +224,7 @@
<listitem><simpara>
Aliases: in refpurpose, put:
<literal>Alias of <function>realfunc</function></literal>.
- <emphasis>Do not specify a funcsynopsis, and
+ <emphasis>Do not specify a function prototype synopsis, and
nothing but simply the text:</emphasis>
<literal>This function is an alias of
<function>realfunc</function></literal>.
@@ -384,16 +384,13 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>RETURNTYPE <function>FUNCTIONNAME</function></funcdef>
- <paramdef>ARGTYPE1 <parameter>ARGNAME1</parameter></paramdef>
- <paramdef>ARGTYPE2 <parameter>ARGNAME2</parameter></paramdef>
- <paramdef>ARGTYPE3
- <parameter><optional>ARGNAME3</optional></parameter>
- </paramdef>
- </funcprototype>
- </funcsynopsis>
+ <methodsynopsis>
+ <type>RETURNTYPE</type> <methodname>FUNCTIONNAME</methodname>
+ <methodparam><type>ARGTYPE1</type> <parameter>ARGNAME1</parameter></methodparam>
+ <methodparam><type>ARGTYPE2</type> <parameter>ARGNAME2</parameter></methodparam>
+ <methodparam choice='opt'><type>ARGTYPE3</type>
+<parameter>ARGNAME3</parameter></methodparam>
+ <!-- use <void /> if you have no parameters at all -->
+ </methodsynopsis>
<simpara>
A simple paragraph that can not contain anything that requires
fancy layout.