Re: Automated API documentation for new releases
| From: | Martin Jansen | Date: | Fri, 16 Apr 2004 12:06:04 +0000 |
| Subject: | Re: Automated API documentation for new releases | ||
| References: | 1 2 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3534@lists.php.net to get a copy of this message | ||
On Fri Apr 16, 2004 at 01:4622PM +0200, Stefan Neufeind wrote:
> You are refering to the HTML-based documentation? Hmm, and how about
> the peardoc2-based API-documentation generated by phpDocumentor?
You got me wrong: The HTML-based documentation will also be generated
by phpDocumentor. There will be *no* difference as regards content in
comparison to the peardoc2-based documentation. It's just a different
format. Nothing else.
>I'm
> asking because it might mean that packages which do their best to
> have good and maybe at some point "complete" API-docs in phpdoc-
> format (which is a good thing imho) might be counted as "package
> without doc"?
I guess I already have said this like 20 times in the past: Adding the
full-blown output of phpDocumentor, which contains documentation for all
public methods, classes etc., to the DocBook based manual will increase
the build time exponentially (*). Thus I do not believe that the manual
is the right place for adding phpDocumentor's output.
(*) Well, not _that_ much, but still a lot.
--
- Martin Martin Jansen
http://martinjansen.com/