Re: API documentation

["muppet" <scott asofyet org>]

Ross McFarland said:
> On Sep 20, 2005, at 6:30 AM, James Muir wrote:
>
> > What is the best approach to documenting the Gnome2::Canvas API so
> > that the additions are not lost the next time the API is derived
> > from its original sources?
>
> Gtk2-Perl documentation is done as POD in the XS files. the best way
> to contribute API documentation would be to check out the source from
> cvs and add it in to the appropriate places. then cvs diff >
> api_doc.patch and send that off to the list.

Btw, please send patches as unified diffs --- "cvs diff -u".

> if you have any problems with the above just ask questions here.

For starters, in the XS file we use a custom dialect of POD with some special
keys understood by our documentation generator.  The Glib::GenPod manpage will
have more info, but for the most part, just follow the lead of whatever's
there, and if necessary, we'll clean up your patch.  (Actually, i probably
will, because i've been maintaining Gnome2::Canvas.)


-- 
muppet <scott at asofyet dot org>