Author: Derick Rethans
Date: 2005-12-12 16:47:38 +0100 (Mon, 12 Dec 2005)
New Revision: 1340
Log:
- Clarify a bit.
Modified:
docs/guidelines/source_documentation.txt
Modified: docs/guidelines/source_documentation.txt
===================================================================
--- docs/guidelines/source_documentation.txt 2005-12-12 15:46:07 UTC (rev
1339)
+++ docs/guidelines/source_documentation.txt 2005-12-12 15:47:38 UTC (rev
1340)
@@ -461,6 +461,16 @@
Required for all class variables. The only allowed syntax is: ::
/**
+ * Short description
+ * Longer description that can also span multiple lines, like
+ * this.
+ * @var type
+ */
+ private $variableName;
+
+An example: ::
+
+ /**
* ezcPhpGenerator writes to the file with this name during execution.
* When [EMAIL PROTECTED] finish()} is called this file is moved to
* $resultFileName.
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
