Re: PHPod documentation
| From: | Alexander Merz | Date: | Tue, 31 Jul 2001 11:28:27 +0000 |
| Subject: | Re: PHPod documentation | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-1179@lists.php.net to get a copy of this message | ||
> How does everyone feel about maybe replacing Javadoc with something like
> "DocPHPOD" for PEAR?
PHPDoc is good for API-Documention, it shows dependencies between the classes
etc..
PHPod would be seen technical, a bad replace for it. But, it could out-play its
advantage however within tutorial similar areas.
Take a look at a perl-package, you often see examples and explanations on the
top followed by the source. But, the API-Doc is also in this part, separated
from the source.
So we should combine PHPod and PHPDoc.
PHPod - for explanations and examples at the top of the srcfile
PHPDoc - for the API-Doc
I don't like the idea of using DocBook for this stuff - DocBook is to
heavyweight. Not really easily to learn (I learn it at the moment). The POD
commands are easy to understand and its possible to convert them to DocBook,
because the POD commands seems to be a 'subset' of the DocBook markup.