After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 416218 - Documentation error in Gtk::IconTheme::get_example_icon_name
Documentation error in Gtk::IconTheme::get_example_icon_name
Status: RESOLVED FIXED
Product: gtkmm
Classification: Bindings
Component: documentation
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtkmm-forge
Depends on:
Blocks:
 
 
Reported: 2007-03-08 21:16 UTC by Jonathon Jongsma
Modified: 2007-03-09 18:23 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Jonathon Jongsma 2007-03-08 21:16:36 UTC 
the documentation for Gtk::IconTheme::get_example_icon_name()[1] says the following:

Returns:
    The name of an example icon or 0. Free with Glib::free().

I assume this is just copied over from the Glib docs, and that the returned Glib::ustring doesn't have to be handled specially.

[1] http://gtkmm.org/docs/gtkmm-2.4/docs/reference/html/classGtk_1_1IconTheme.html#a2a1cca16c9b048e5b023d2212579d1a
Comment 1 Jonathon Jongsma 2007-03-08 23:42:10 UTC 
I tried copying this function from gtk_docs.xml to gtk_docs_override.xml and removing the part about the return, but that didn't seem to do the trick.  What's the proper way to fix this?
Comment 2 Jonathon Jongsma 2007-03-09 04:19:43 UTC 
OK, I guess it did work, it's just that the documentation wasn't being rebuilt correctly.  But before I commit this, I want to know: is this the correct way to do this?
Comment 3 Murray Cumming 2007-03-09 17:15:26 UTC 
Yes, that's absolutely correct.
Comment 4 Jonathon Jongsma 2007-03-09 17:28:43 UTC 
Ok, thanks.  committed.
Comment 5 Jonathon Jongsma 2007-03-09 18:23:57 UTC 
I committed this to the 2-6 and 2-8 branches as well, I don't know if it was really necessary or not...