Attached is a tarball with documentation for the SVN extension.
configure.xml, constants.xml and reference.xml are complete, but only
one function is documented. I'll be working on finishing the rest
later.
If someone could review these and commit them into the repository (or
give me a CVS account to do it myself), I'd be deeply grateful. The
docs
were tested using Livedocs (thanks Hannes for helping me get it set
up).
Hello Edward,
Welcome to the documentation team! I went through your patch and
nitpicked every little detail in an effort to help you (and others)
write almost perfect commit worthy documentation. Most are small
problems that come with experience:
- Use example.com for all example urls
- Whitespace is always one space, not two
- Put all URLs in global.ent before commit
- functions.xml is autogenerated, do not create/commit it
- First use scripts/xml_proto.php to generate skeletons for all
functions
- Fix <title>Subversion &Functions;</title>
- Remove comments like <!-- Example: Optional parameter -->
- In theory, new documentation is formal (no 'you')
The part about formal (not conversational) text is a bit idealistic
as few follow this but slowly we're talking about it, and trying.
Regards,
Philip Olson
Ref: http://doc.php.net/php/dochowto/
