Re: Step-by-step introduction to PearDoc
| From: | Daniel Convissor | Date: | Wed, 14 Apr 2004 17:59:41 +0000 |
| Subject: | Re: Step-by-step introduction to PearDoc | ||
| References: | 1 2 3 4 5 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3455@lists.php.net to get a copy of this message | ||
Hi Alexander:
On Wed, Apr 14, 2004 at 07:45:42PM +0200, Alexander Wirtz wrote:
> Daniel Convissor wrote:
> >On Wed, Apr 14, 2004 at 04:30:58PM +0200, Alexander Wirtz wrote:
> >
> >>Yes, so there should be a better template...
> >
> >You've said this a few times in this thread but haven't said what's really
> >wrong with the existing templates.
>
> Quoting David Costa:
> > then you really need to add the comments the right way. With the
> > majority of package I tried the outcome is an incomplete API aka
> > you need to manually add description on each function.
>
> And thus I said, the templates for generating the API have to be
> "better" aka improved for fitting the regulations. I have exactly zero
> knowledge about this doc-stuff, but I can see, that the way I was going
> along isn't producing the required output.
Huh? Perhaps we're talking about different things.
http://cvs.php.net/cvs.php/peardoc/en/authoring/
(and all of it's subdirs
and files therein) is a complete set of DocBook files you can copy into
your documentation working directory, rename and then alter the text
therein to suit your purposes. This has nothing to do with phpDocumentor
templates.
In your initial email you said:
> but this isn't good enough, I'd suggest offering a small tar with all
> the needed files for authoring the documentation for a package, a
> "skel", so to say.
So, did you misunderstand what the files in "authoring" are? If so,
please reexamine them.
And/or, did you find them lacking in some fashion? If so, what needs to
be added/changed?
Thanks,
--Dan
--
T H E A N A L Y S I S A N D S O L U T I O N S C O M P A N Y
data intensive web and database programming
http://www.AnalysisAndSolutions.com/
4015 7th Ave #4, Brooklyn NY 11232 v: 718-854-0335 f: 718-854-0409