Re: documentation generation question
| From: | Greg Beaver | Date: | Thu, 03 Apr 2003 19:07:47 +0000 |
| Subject: | Re: documentation generation question | ||
| References: | 1 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-4633@lists.php.net to get a copy of this message | ||
Hi Demian,
Um, install phpDocumentor :)
Seriously, the time it takes to install will be justified by the time saved trying to work around the oddities of phpdoc.de's PHPDoc. Installation involves unzipping the archive into any directory, and running ./phpdoc. It's not really complicated. Of course, you could also sync from anonymous cvs, as it is MUCH more stable and feature-full than the 1.2.0beta3 release (we'll be doing a 1.2.0rc1 release in about 2 weeks, when I have time to finish the docs and wrap up a few other loose ends)
Once you're installed, use @package tags in the inherited classes to specify a different package.
http://www.phpdoc.org/docs/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.package.pkg.html
Greg
--
phpDocumentor
http://www.phpdoc.org
Demian Turner wrote:
Hi, I have a general question about document generation in PHP. Currently I'm using PHPdoc from http://www.phpdoc.de and am trying to sort my docs into packages to follow the class structure. I know I should be using PHPdocumentor, haven't had time to install it yet ;-) But following the logic PHPdoc uses, any class that inherits from a class belonging to package A becomes part of package A. This can't be right, and as I'm using a java-style Object base class, I cannot 'force' anything into separate packages. Anyone come up with a solution to this problem? cheers, Demian