cvs: phpdoc / README
| From: | Jeroen van Wolffelaar | Date: | Sun, 12 Aug 2001 15:52:05 +0000 |
| Subject: | cvs: phpdoc / README | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969337022@lists.php.net to get a copy of this message | ||
jeroen Sun Aug 12 11:52:05 2001 EDT
Modified files:
/phpdoc README
Log:
More conventions (about how the types should be named in the docs)
Index: phpdoc/README
diff -u phpdoc/README:1.15 phpdoc/README:1.16
--- phpdoc/README:1.15 Thu Aug 9 21:10:28 2001
+++ phpdoc/README Sun Aug 12 11:52:05 2001
@@ -96,6 +96,10 @@
listings. XML should be indented with one space character
for each level of indentation; example code uses four spaces.
+ 13. Types: In the docs, the types are denoted as: boolean (also in
+ paramdefs), integer (int in paramdefs), float (not: double),
+ array, object (not: class), resource and null (lowercase).
+
WHAT TO DOCUMENT
1. Only major functions should be documented; functions which are