Re: API documentation

[Ross McFarland <rwmcfa1 neces com>]

On Sep 20, 2005, at 6:30 AM, James Muir wrote:

> Hi All,
>
> I've been fiddling with the Gnome2::Canvas for several weeks and  
> there are a few bits of API information I'd like to document  
> somewhere so that the next person who looks at this API has an  
> easier time. I'm wondering what the best approach is. It's my  
> impression that the API documentation is derived from other sources  
> (POD? Glib::ParamSpec?), and the wiki immediately directs you to  
> API pages that cannot be revised.  :-(
>
> 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.

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