On Wed, Aug 6, 2008 at 10:11, morgue1 at free dot fr <[EMAIL PROTECTED]> wrote: > > Yes, I can help you documenting SPL's exceptions.
Thats awesome! The first thing you should do is getting your environment set up to build the documentations locally; On *nix; cvs -d:pserver:[EMAIL PROTECTED]/repository login # password is "phpfi", see http://php.net/anoncvs cvs -d:pserver:[EMAIL PROTECTED]/repository co phpdoc cd phpdoc pear channel-discover doc.php.net pear install doc.php.net/phd-beta php configure.php phd -d .manual.xml -t chunkedhtml Now you should get a "html/" directory containing the documentations. Feel free to open up couple of files in your browser to make sure everything is fine. Now we get to the fun part. Copy RFC/skeletons/exceptionname.xml to en/reference/spl/splexceptionname.xml (replacing "splexceptionname" with the actual exception name (all lowercased)). open the file in your favorite text editor and read through the file. It contains some comments to guide you through what will need to change. Feel free to compare it to en/language/predefined/errorexception.xml to get a better feeling of what you need to change. If the exception you are documenting doesn't define any properties (most don't) then you can ignore that part of errorexception.xml obviously :) If the exception introduces new methods, not documented by the core Exception class, then you'll need to document those too. Create a folder (in en/reference/spl/) with the same name as the "splexceptionname" xml file you created. Into that file, copy RFC/skeletons/method.xml into the folder. The filename should be the same as the methodname (all lowercased). This file also contains lots of comments that should help you through the process. Feel free to compare it to en/language/predefined/errorexception/getseverity.xml for instance. When you are finished editing the template and writing the docs open en/language/predefined/errorexception/getseverity.xml and add "&reference.spl.exceptionname;" to the bottom of the list (replacing "exceptionname" with the same name as you named the "splexceptionname" file). Now its time to test the new docs! php configure.php If everything worked out you should see "All good. Saving .manual.xml... done.", if not; please check the error messages and fix them :) Now its time to build the docs: phd -d .manual.xml -t chunkedhtml And open your new documentations (html/splexceptionname.html (replace "splexceptionname" with the name you called the XML file). That should be it. Now its time to send these new docs to this list (phpdoc@lists.php.net) so we can verify it. If you are interested in continue helping us out writing more documentations we can even hook you up with an php.net CVS account so you can commit the new docs yourself :D For further information, see: http://php.net/dochowto/ If you have any questions, feel free to ask (preferably the mailinglist, [EMAIL PROTECTED]). Note: All the instructions/commands above work perfectly on windows, with the exception of the ones starting with "cvs ". You'll have to download and install some CVS client for windows. Note2: This was mostly written up blindly, so I apologize if there are some typos in the commands or filenames -Hannes
