doc:scratchpad:pecldocs
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:scratchpad:pecldocs [2008/12/04 23:40] – expand arginfo notes, as per felipe's email philip | doc:scratchpad:pecldocs [2017/09/22 13:28] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
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 |
</ | </ | ||
- | This will create a directory named ' | + | This will create a directory named ' |
* Read the Validating Changes section of the [[doc: | * Read the Validating Changes section of the [[doc: | ||
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.1228434048.txt.gz · Last modified: 2017/09/22 13:28 (external edit)