Re:
| From: | Greg Beaver | Date: | Wed, 10 Sep 2003 21:20:04 +0000 |
| Subject: | Re: | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-21379@lists.php.net to get a copy of this message | ||
Hi,
Zeev Suraski wrote:
/** * @return unknown * @param $params unknown * @param $smarty unknown * @desc Enter description here... */ I don't know why. It was often demanded. But zend uses to not listen to the userbase too much. Daniel, Can you explain how it is incompatible? I know that @desc is not in the PHPDoc standard, but how does this break compatibility? A PHPDoc parser should still be able to figure it out, and ignore @desc.phpDocumentor will actually replace the summary description with @desc if it is encountered. No user will also duplicate the short description outside of @desc, that requires valuable keystrokes leading to carpal tunnel ;). The main compatibility problem is the @param tag has a reverse ordering as Stephan pointed out, as in @param varname type instead of @param type [$varname] [description of parameter] phpDocumentor allows an optional variable name, and an optional description of the parameter, so the variable name has to be prepended with $ to be recognized as a variable name. I'm happy to work with ZDE people if there are technical demands, it would be very nice if phpDocumentor/ZDE had cross-compatibility. Greg