Re: PHPDoc question
| From: | Alexander Merz | Date: | Fri, 28 Mar 2003 11:34:37 +0000 |
| Subject: | Re: PHPDoc question | ||
| References: | 1 2 3 4 5 6 7 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-4493@lists.php.net to get a copy of this message | ||
Drago Bokal wrote:
What is the problem? How does PHPDoc distinguish among module and class comments?A module comment is a comment in a file with functions ie: ------- <? /*********************************************************************** Copyright (c) 2001-2002 XYZ All the legal stuff. */ /** * module comment * @module myModule */ /** * my nice function * @param ... * ... */ function myFunction ... ------- If you have a class inside this file, the file is interpreted as class file - module comments are not allowed. I think you you are looking for the @package-Tag: ie. in a module file with functions only /** * module comment * @module myModule * @package myPackage */ and in a second file with a class only /** * class comment * @class myClass * @package myPackage */