Re: reStructuredText
| From: | Mika Tuupola | Date: | Fri, 13 Jun 2003 08:02:41 +0000 |
| Subject: | Re: reStructuredText | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-17375@lists.php.net to get a copy of this message | ||
On Thu, 12 Jun 2003, Pierre-Alain Joye wrote:
> > I guess everybody agrees with you that phpDocumentor is great for API
> > documentation. But why do you fail to see that API documentation and
> > end-user documentation are different things? I don't think that
> > "controlling" the end-user documentation in the API documentation is a
> > good thing.
>
> Please, *read* the phpdocumentor documentation and come back :)
I'm not sure where you are refering to. _But_ IMO API
documentation is not a substitute for proper end user
documentation either. That is why I think the phpdoc ->
peardoc2 converter is a bit scary. It is a great tool
for making skeletons for user documentation. It should
not, however, be used by lazy programmers as substitute
for writing proper documentation.
--
Mika Tuupola http://www.appelsiini.net/~tuupola/