using the new doc format
| From: | Philip Olson | Date: | Fri, 06 Aug 2004 01:07:05 +0000 |
| Subject: | using the new doc format | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969362733@lists.php.net to get a copy of this message | ||
Hello!
We agreed to use the new format so newly introduced documentation
should use it. Examples of its use can be found in the exif and
mysqli docs; and within the HOWTO. Many of the new entities live
within language-defs.ent For functions, the order should be:
Description
Return Values
CHANGELOG
Examples
See Also
All documentation moved from peardoc into phpdoc should use this
new format.
Conversion of the current phpdocs should wait until it's figured
out how it'll be done. How about we implement a checkout system
where one person works on an entire extension one at a time and
during this process the following could also take place:
- Implement newly introduced entities, like &example.output;
- Implement the CHANGELOG
- Rewrite all examples to meet our coding standards (CS)
- Fix whitespace (WS)
- Anything else?
If doing all of this together is difficult for translators then
it could be split up but it seems like a prime time to update
everything.
Regards,
Philip