Documentation, DocBock and PHPDoc
| From: | Lukas Smith | Date: | Mon, 29 Jul 2002 14:27:13 +0000 |
| Subject: | Documentation, DocBock and PHPDoc | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-8066@lists.php.net to get a copy of this message | ||
Hi,
Obviously, developer documentation needs to include other information
versus user documentation.
I briefly talked with Alan about this on IRC.
Anyways for the user it only matters what methods he should call.
Private data, methods dont matter to him.
Classes that only work in the background also dont matter.
Inheritance as well etc...
But all of this information is pretty easy to just leave out.
What would be nice is to be able to have a separate file where you could
define samples that would then also be included in the docs (both
developer and user) but that would just clutter the source.
I think it would be a great leap forward if it were possible to generate
useable user documentation from PHPDoc comments.
Anyone that then wants to spend more time on it can then manually
improve the docs (allthough here it would be nice to have a system that
could "merge" changes in the PHPDoc comments into the manually edited
DocBock documentation).
Best regards,
Lukas Smith
smith@dybnet.de
_______________________________
DybNet Internet Solutions GbR
Reuchlinstr. 10-11
Gebäude 4 1.OG Raum 6 (4.1.6)
10553 Berlin
Germany
Tel. : +49 30 83 22 50 00
Fax : +49 30 83 22 50 07
www.dybnet.de info@dybnet.de