Re: Documentation, DocBock and PHPDoc
| From: | Pierre-Alain Joye | Date: | Mon, 29 Jul 2002 15:05:50 +0000 |
| Subject: | Re: Documentation, DocBock and PHPDoc | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-8067@lists.php.net to get a copy of this message | ||
On Mon, 29 Jul 2002 17:00:53 +0200
Pierre-Alain Joye <pajoye@inbox.lv> wrote:
> On Mon, 29 Jul 2002 16:27:13 +0200
> "Lukas Smith" <smith@dybnet.de> wrote:
That sounds nice :).
That matches what Martin said a few days ago. I can add a 3rd documentation type, introduction or
tutorials or call it how you want :).
I m afraid this can be very difficult and unreadable to insert these docs in a phpdoc format.
A good example of this type is the phplib documentation (http://www.sanisoft.com/phplib/manual/),
not really a tutorail but provide all necessary informations to only work with phplib.
The goals here is to provide to external people (means persons are not the developers) a easy way to
write docs. Good developers (as far as they got time to do it) are not necessary good docs writers.
pa