doc:scratchpad:pecldocs
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| doc:scratchpad:pecldocs [2008/12/04 23:40] – expand arginfo notes, as per felipe's email philip | doc:scratchpad:pecldocs [2009/03/24 17:14] – added --pecl to example philip | ||
|---|---|---|---|
| Line 14: | Line 14: | ||
| $ cd phpdoc/ | $ cd phpdoc/ | ||
| $ php docgen.php --help | $ php docgen.php --help | ||
| - | $ php docgen.php --output tmp --extension extname | + | $ php docgen.php --output tmp --extension extname |
| </ | </ | ||
| Line 48: | Line 48: | ||
| } | } | ||
| </ | </ | ||
| - | |||
| ==== Other Notes ==== | ==== Other Notes ==== | ||
| * Docgen may be used to generate specific documentation too, like for individual classes and functions | * Docgen may be used to generate specific documentation too, like for individual classes and functions | ||
| + | * Write in third person voice (no " | ||
| + | * XML is single spaced | ||
| + | * Don't commit skeletons and "fill them out later", | ||
| + | * Skeletons generate several sections that you may not use, such as examples and errors... in this case delete them | ||
| + | * Don't commit auto-generated files from build time (like entities.*) | ||
| + | * Feel free to ask phpdoc@lists.php.net for code review, or #php.doc on Efnet | ||
| + | * When testing, be sure to add to manual.xml.in in phpdoc/ otherwise it won't be validated/ | ||
doc/scratchpad/pecldocs.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1