Re: Problems with generation of hildonmm API reference documentation

[Murray Cumming <murrayc openismus com>]

On Thu, 2009-06-18 at 14:23 +0200, David King wrote:
> Once I extracted the documentation from the C API reference using the
> instructions at
> 
> http://www.gtkmm.org/docs/gtkmm-2.4/docs/tutorial/html/sec-wrapping-documentation.html
> 
> the new documentation was successfully copied into the C++ API
> reference. However, function documentation in the C++ API reference has
> lots of C function names, in the format
> "hildon_button_add_image_size_group()", even though these should be
> converted by gmmproc, in my understanding. See the link below for an
> example.
> 
> http://maemomm.garage.maemo.org/docs_unstable/reference/hildonmm/html/classHildon_1_1Button.html#f4084e64e69f3890988c63cd802a42d9
> 
> The class documentation seems to have been copied without a problem,
> except for the Hildon::Button example above, which is missing. I'm going
> through and adding overrides now, where necessary.

I fixed this in pygobject/codegen/h2defs.py in git and regenerated the
files for hildonmm (committed in svn). I also added a debug hint in
gmmproc in glibmm in git but you don't need that.

The problem was that h2defs.py could not handle anything other than one
space after the struct keyword when parsing the C header file.

This was a simple fix in the end but an important one. It should be very
helpful for many other *mm modules. CCing gtkmm-list so that other
people know that it might be worth regenerating the .defs and docs.xml
files to get better generated documentation.

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