Thanks for the swift answer, didn't know the need was that
desperate ;)
:)
Any way I can have a look at what you've done so far so I can get
some inspiration ?
A lot of SPL is already documented in CVS so you can look at its XML.
And as far as creating a nice base to work from, I recommend using
docgen to generate and then go from there:
A short [SPL centric] summary:
$ cvs -d :pserver:cvsr...@cvs.php.net:/repository checkout phpdoc
$ cd phpdoc
$ php configure.php (test to show how to validate)
$ cd scripts/docgen
$ php docgen.php -e spl -o myspl
That'll create a directory named myspl with skeletons for all of SPL.
You'll then work on one undocumented class at a time, so I'll randomly
choose splfixedarray. For this class docgen created:
- splfixedarray/ (directory with all methods)
- splfixedarray.xml (class file, not much to change in here)
You then open up these splfixedarray files and write documentation.
Now, in order to validate these documents (make sure you didn't blow
up the docs) you'll need the documentation to reference this new class
and in the case of splfixedarray:
- Open en/reference/spl/book.xml
- Add &reference.spl.splfixedarray;
After this splfixedarray has successfully been added to your local
checkout of the PHP documentation, so it becomes part of the build.
However, does it validate? This again tells us:
$ php configure.php
Hope that helps the SPL crew. Also, a lot of SPL is already [sorta]
documented but needs more content so in these cases it's just a matter
of adding text. Also, feel free to edit other parts of the
documentation and not just SPL :)
Regards,
Philip
