RE: [PEAR-DOC] phpDocumentor tutorials/extended documentation imp lementation
| From: | LIMBOURG Arnaud | Date: | Wed, 11 Dec 2002 17:58:25 +0000 |
| Subject: | RE: [PEAR-DOC] phpDocumentor tutorials/extended documentation imp lementation | ||
| Groups: | php.pear.dev php.pear.doc | ||
| Request: | Send a blank email to pear-dev+get-11559@lists.php.net to get a copy of this message | ||
Alex is alive !!
For the moment peardoc is very API oriented as i see it.
What is your in-between API doc and tutorials then ? What do you mean by
end-user doc ?
Arnaud.
> Greg Beaver wrote:
>
> > put tutorials in a special directory
> > tutorials/packagename/[subpackagename/]. tutorials is a
> subdirectory of
> > any directory parsed.
> - file role="doc" in package.xml
> - peardoc (intro-section is exaktly dedicated for this)
>
> The problem is not to make tutorials public, the problem is the force
> programmers to write real docs. Tutorials and an API-Doc are a good
> excuse for programmers not to write end user docs like
> peardoc want to
> be. Tutorials are often superficially, the auto-generated API-Doc
> contains to much stuff for the end user.
>
> You propose for a docbook-styled markup for tutorial was already
> discussed months ago and gets no real feedback.