Re: [gtkmm] Overriding/correcting automatically generated API documentation

[Murray Cumming <murrayc murrayc com>]

On Tue, 2004-02-10 at 15:00, Matthew Walton wrote:
> I've managed to fix Gtk::FileChooser so that get_uris() returns an 
> SListHandle<Glib::ustring> instead of a GSList *, and this appears to 
> work quite nicely. However, the documentation generated for it refers to 
> it returning a G::SList * - as does the documentation for 
> FileChooser::get_filenames(), which also returns an SListHandle. How 
> should I go about persuading gmmproc to give me the right documentation? 
> Do I have to abandon use of _WRAP_METHOD and write these methods 
> manually, or is there another way to do it?
> 
> I looked in the hg files this morning and couldn't find any examples of 
> anything that looked like documentation being altered for methods 
> wrapped with _WRAP_METHOD, only for ones which were wrapped by hand.

You need to copy the documentation's XML node from gtk_docs.xml to
gtk_docs_override.xml and edit it. If that is not documented in
docs/internals, then it should be.

Thanks for thinking about documentation - not everybody does.

-- 
Murray Cumming
www.murrayc.com
murrayc murrayc com