RE: [PEAR] PHPDoc question
| From: | LIMBOURG Arnaud | Date: | Fri, 28 Mar 2003 12:21:50 +0000 |
| Subject: | RE: [PEAR] PHPDoc question | ||
| Groups: | php.pear.general | ||
| Request: | Send a blank email to pear-general+get-4495@lists.php.net to get a copy of this message | ||
The "module" comment is called "page-level comment" in phpdocumentor doc.
Alex: i don't know of any @module tag.
Anyway, phpdoc.org has pretty detailed documentation.
Arnaud.
> 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
> */