Re: Requirements for Documentation System
| From: | Paul M Jones | Date: | Tue, 13 Apr 2004 13:49:40 +0000 |
| Subject: | Re: Requirements for Documentation System | ||
| References: | 1 2 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3314@lists.php.net to get a copy of this message | ||
Stefan,
Dude, that is a fantastic idea. I think that can be covered by the requirement as it is ("method and purposes to be determined") but that is definitely the right kind of thing to shoot for. Do you think we need to rephrase the requirement and make it more specific?Add new requirement: a way to integrate inline phpDocumentor tags from source code (method and purposes to be determined).And maybe in that connection: Allow for completely auto-generated API doc from source (like the one generated by phpDoc currently) and optionally add additional pages.
So maybe even some currently present docs could be refactored in phpdoc, and only some parts which don't fit into phpdoc nicely or which are too extensive to be part of the source, should imho be added to the doc directly.Now that I think about it: if there are inline phpDoc tags for the classes in a package, there is *no good reason* for them not to show up automatically in the online documentation. Great idea, good contribution. Thanks. -- Paul M. Jones Savant: the simple alternative to Smarty. http://phpsavant.com/