doc:scratchpad:pecldocs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
doc:scratchpad:pecldocs [2008/12/04 23:40]
philip expand arginfo notes, as per felipe's email
doc:scratchpad:pecldocs [2009/04/25 16:41]
philip minor rewording
Line 14: Line 14:
 $ cd phpdoc/scripts/docgen $ cd phpdoc/scripts/docgen
 $ php docgen.php --help $ php docgen.php --help
-$ php docgen.php --output tmp --extension extname+$ php docgen.php --output tmp --extension extname --pecl
 </code> </code>
  
-This will create a directory named 'tmp' for the extension named 'extname' which will be full of documentation skeletons. Reflection is used to make guesses about the extension, like for classes, methods, functions, constants, parameters, version information, etc. but this information will not be fully correct. Please go through and edit each XML file by updating this information and adding documentation.+This will create a directory named 'tmp' that will contain documentation skeletons for the 'pecl' extension named 'extname'. Reflection is used to make guesses about the extension, like for classes, methods, functions, constants, parameters, version information, etc. but this information will not be fully correct. Please go through and edit each XML file by updating this information and adding documentation.
  
   * Read the Validating Changes section of the [[doc:scratchpad:howto|PHP Documentation HOWTO]].   * Read the Validating Changes section of the [[doc:scratchpad:howto|PHP Documentation HOWTO]].
Line 48: Line 48:
 } }
 </code> </code>
- 
 ==== 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 "You"
 +  * XML is single spaced 
 +  * Don't commit skeletons and "fill them out later", commit them when they are filled out 
 +  * 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/tested/built
doc/scratchpad/pecldocs.txt · Last modified: 2017/09/22 13:28 (external edit)