Re: phpDocumentor with PEAR layout
| From: | Stig S. Bakken | Date: | Thu, 09 Jan 2003 23:55:14 +0000 |
| Subject: | Re: phpDocumentor with PEAR layout | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-12204@lists.php.net to get a copy of this message | ||
On Sun, 2003-01-05 at 16:28, Martin Jansen wrote:
> On Sat Jan 04, 2003 at 09:5405PM +0100, Christian Dickmann wrote:
> > I created a new phpDocumentor Template based on
> > PHPEdit and PEAR. Results can be found here:
> > http://dickmann.homeunix.org/pear/phpdoc/PEAR/
>
> FYI: As soon as the stuff is ready, we'll place Christian's
> code somewhere on pear.php.net and there will be a
> automated build-system for all packages in pear/.
Christian's template is excellent!
I definitely agree this should be automated on pear.php.net, but we need
to figure out how to deal with different releases of each package. We
can not expect code maintainers to keep a full change history in every
phpdoc block, and besides that would not work at all if the API changes
enough to warrant a new major version.
There should be a default release (newest stable) whose docs you get
when selecting the package, and then you should be able to pick older
releases, for example with a "Releases" tree below the "Package" tree.
If docs are generated as part of (or immediately following) release
uploads, we can make documentation tarballs available for download too.
If doc-generation is _part_ of the release upload, it could even refuse
the package until the phpdoc is valid. :-)
- Stig