Re: Finding API documentation by function name

[Murray Cumming <murrayc murrayc com>]

On Tue, 2007-11-27 at 23:24 +0000, Raja Mukherji wrote:
> Hi all,
> 
> I'm writing a binding generator for my language to Gtk and want the
> generator to be able to insert documentation into the generated code
> automatically. Is there any existing program/script for getting the
> documentation associated with a specific api function? For example:
> 
> <program> gtk_about_dialog_new
> 
> could print out the lines (as copied from devhelp):
> 
> Creates a new GtkAboutDialog.
> 
> Returns :
> 	a newly created GtkAboutDialog
> 
> Or it could (preferably) print them out in XML, or some other structured format.
> 
> I could probably fashion something myself, possibly from the files
> that devhelp generates, but I was wondering if anyone has already done
> so, or knows of any existing solution.

gtkmm does this, and does some transformation of the text to make it
more suitable for our API. It's perl in our gmmproc tool, and uses this
XML:
http://svn.gnome.org/viewvc/gtkmm/trunk/gtk/src/gtk_docs.xml?view=markup
which is generated by this script:
http://svn.gnome.org/viewvc/pygtk/trunk/codegen/docextract_to_xml.py?view=markup

Our gmmproc tool allows us to override this automatically-generated
documentation where necessary.

I CCed the language-binding mailing list.

-- 
murrayc murrayc com
www.murrayc.com
www.openismus.com