Re: [PHP-GTK-DOC] Writing Documentation
[email protected] (Anant Narayanan) Fri, 13 Apr 2007 04:24:02 +0530
| Newsgroups | php.gtk.doc |
|---|---|
| Message-ID | <[email protected]> |
Hi Jake, > I would be happy to help fill in the english documentation. As I'm > learning the framework by developing an application, I already find > myself > using mis/undocumented features. I know both PHP and C so I'm able to > examine the source when necessary. If someone could get me started > with > how documentation changes are handled for the project and maybe a > list of > implemented-but-undocumented functions/methods/etc I will fill in > where I > can. That's wonderful! Start by checking out the CVS sources for PHP-GTK documentation: cvs -d :pserver:[email protected]:/repository login cvs -d :pserver:[email protected]:/repository co php-gtk-doc (use `phpfi' as password). There's a nice documentation tutorial available: http://gtk.php.net/ manual/en/tutorials.doccing.php, which should give you enough information to get started. Have a look at: http://php-gtk2.de/manual/ coverage.htm to know what needs completion. Of course, learning by example is the best; so do have a look at the existing XML files to get an idea of how things are done (We use a modified version of Docbook). When you're done documenting a few classes, upload them somewhere and ping the list. Someone will review and commit them for you. Don't hesitate to ask if you run into some trouble. Cheers, -- Anant