Writing Documentation
| From: | (Alexander Merz) | Date: | Fri, 01 Nov 2002 20:37:41 +0000 |
| Subject: | Writing Documentation | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-10436@lists.php.net to get a copy of this message | ||
Bertrand Mansion asked about how to write docs for the manual.
Here is a short description:
1.) Ensure your PHPDoc comments are correct as possible (makes writing easier)
2.) run the pd2pm over the code - do not use the old version, i rewrote it completely. I will provide an standalone pd2pm-archive after the conference. (just be on the conf for a live demonstration :-)
3.) Now you have a set of docbook templates and basical documentated functions. This can be directly added to the pearman2 source.
4.) Edit the templates (includes introduction and examples) and the function docs.
If you want to start already now, take a look on the HTML_Table docs i commited this week - they are build after the notes above.