Author: dr
Date: Wed Jan 2 10:16:57 2008
New Revision: 7049
Log:
- Document that we don't do @return void.
Modified:
docs/guidelines/implementation.txt
Modified: docs/guidelines/implementation.txt
==============================================================================
--- docs/guidelines/implementation.txt [iso-8859-1] (original)
+++ docs/guidelines/implementation.txt [iso-8859-1] Wed Jan 2 10:16:57 2008
@@ -1363,7 +1363,7 @@
* cannot be used for storage.
- @param
-- @return
+- @return, but only if there is something returned from the method.
The following fields are optional:
@@ -1490,7 +1490,6 @@
* @throws ezcBaseFileNotFoundException when setting the property with an
invalid filename.
* @param string $name
* @param mixed $value
- * @return void
* @ignore
*/
public function __set( $name, $value )
@@ -1628,9 +1627,9 @@
@return
-----------
-Required for all methods. The type parameter is required and should be set to
-void for non-returning methods. The description should be used if the purpose
-of the return value is not mentioned in the method description.
+Required for all methods, and the type parameter is required. This tag should
+not exist for non-returning methods. The description should be used if the
+purpose of the return value is not mentioned in the method description.
@see
----------
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
