cvs: phpdoc /howto working.xml
| From: | Hartmut Holzgraefe | Date: | Thu, 19 Jun 2003 20:23:19 +0000 |
| Subject: | cvs: phpdoc /howto working.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969354645@lists.php.net to get a copy of this message | ||
hholzgra Thu Jun 19 16:23:19 2003 EDT
Modified files:
/phpdoc/howto working.xml
Log:
parameter default values explained
Index: phpdoc/howto/working.xml
diff -u phpdoc/howto/working.xml:1.31 phpdoc/howto/working.xml:1.32
--- phpdoc/howto/working.xml:1.31 Wed May 14 21:21:08 2003
+++ phpdoc/howto/working.xml Thu Jun 19 16:23:18 2003
@@ -435,7 +435,16 @@
<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>
+ <!-- optional parameter -->
+ <methodparam choice='opt'>
+ <type>ARGTYPE3</type> <parameter>ARGNAME3</parameter>
+ </methodparam>
+ <!-- optional parameter with default value, choice='opt' is default in this case
-->
+ <methodparam>
+ <type>ARGTYPE3</type>
+ <parameter>ARGNAME3</parameter>
+ <initializer>default-value</initializter>
+ </methodparam>
<!-- use <void /> if you have no parameters at all -->
</methodsynopsis>
<simpara>