Re: PEAR documentation and PhpDocumentor
| From: | Xavier Noguer | Date: | Wed, 10 Sep 2003 12:50:50 +0000 |
| Subject: | Re: PEAR documentation and PhpDocumentor | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-21355@lists.php.net to get a copy of this message | ||
Jon Parise <jon@php.net> escribió
> On Wed, Sep 10, 2003 at 12:12:05AM -0400, Greg Beaver wrote:
>
> > I'm very confused right now - is there a way that I can more clearly
> > state that you can generate the exact DocBook needed for the
> > pear.php.net manual using phpDocumentor?
> >
> > I keep running into more and more features of phpDocumentor that I've
> > advertised repeatedly which nobody seems to have any idea exists :).
> >
> > This is frustrating, because that is in essence a documentation problem
> > on my part. So, if any of you have any suggestions, I'd like to get
> > that fixed right away.
I think you've done more than enough on this respect. What is left now is for
lazy developers (like me :) to at least create the API docs for their packages
using PhpDocumentor, and for non-developers to contribute to documenting
(maybe a "documentor" package role would be needed?).
> One of the main problems that I have with DocBook (and that can't be
> solve by phpDocumentator) is the goofy toolchain that I need to
> construct in order to render the XML source into a readable format.
> And once the toolchain is in place, I need to wait a few minutes to
> build the complete PEAR Manual in order to verify whether the
> hyperlink I just added actually works.
You might want to try commenting out all sections of the manual you are not
testing in manual.xml.in, there is no need to build the whole manual just for
testing a single package documentation.
Xavier