Re: Writing Documentation
| From: | (Alexander Merz) | Date: | Sat, 02 Nov 2002 18:33:08 +0000 |
| Subject: | Re: Writing Documentation | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-10450@lists.php.net to get a copy of this message | ||
Tony Leake wrote:
What is the situation with PECL extensions and peardoc2. I have an extension I'm starting to write docs for but the whole of the pecl section has been commented out in the manual.xml.in file. I'm assuming also that you can't use pd2pm for pecl as they don't use phpdoc comments. I notice there is a what seems to be a template in en/authoring/package is that the way to start?The docs for pecl goes the same way. Pd2pm is just a tool to avoid writing docs twice (API docs + Manual). As you said, it is not possible to run pd2pm/phpdoc over C code, thats no problem, so you have the write the function doc pages manually instead of generating them automatically. The templates are the way to start - also for pecl, take care of the id -> "pecl" instead of "package". I will make some small changes to the current templates when i release pd2pm. Also, I will create PECL specific templates - but they will not big differ from PEAR-PHP Packages.