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 587766 - Bugs in KeyFile documentation
Bugs in KeyFile documentation
Status: RESOLVED FIXED
Product: glibmm
Classification: Bindings
Component: documentation
unspecified
Other All
: Normal normal
: ---
Assigned To: gtkmm-forge
gtkmm-forge
Depends on:
Blocks:
 
 
Reported: 2009-07-04 19:03 UTC by Tomasz Jankowski
Modified: 2009-07-17 12:19 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Patch to fix exception comments in docs (23.71 KB, patch)
2009-07-06 06:09 UTC, José Alburquerque
committed Details | Review

Description Tomasz Jankowski 2009-07-04 19:03:53 UTC
Hello!

I found some minor bugs while reading documentation for Glib::KeyFile. I have no idea how can I create patch for documentation (because it's auto-generated, right?), so I'll list what I found:

Missing note about throwing exceptions:
1. Glib::KeyFile::get_keys ()
2. Glib::KeyFile::has_key ()
3. Glib::KeyFile::get_string ()
4. Glib::KeyFile::get_boolean ()
5. Glib::KeyFile::get_integer ()
6. Glib::KeyFile::get_double ()
7. Glib::KeyFile::get_comment ()
8. Glib::KeyFile::set_comment ()   	
9. Glib::KeyFile::remove_comment ()
10. Glib::KeyFile::remove_comment()
11. Glib::KeyFile::remove_key()
12. Glib::KeyFile::remove_comment()

Invalid description of return value:
1. Glib::KeyFile::get_comment ()
2. void Glib::KeyFile::set_comment (const Glib::ustring &group_name, const Glib::ustring& key, const Glib::ustring& comment)
3. Glib::KeyFile::remove_comment()
4. Glib::KeyFile::remove_key()
5. Glib::KeyFile::remove_comment()

I found similar bugs in other sections of API reference. In many places documentation doesn't mention about exceptions (e.g. bool Gtk::Builder::add_from_file (const std::string &filename)).

Sometimes, when function is overloaded (like Gtk::Builder::add_from_file() ) only under one version documentation mentions about exceptions.
Comment 1 José Alburquerque 2009-07-06 06:09:38 UTC
Created attachment 137904 [details] [review]
Patch to fix exception comments in docs

This patch fixes the exception and return comments in the docs.
Comment 2 José Alburquerque 2009-07-14 21:02:34 UTC
Pushed to master so no one else has to re-implement the fixes.  I can revert it if it should not be committed.
Comment 3 Murray Cumming 2009-07-17 12:19:49 UTC
Thanks. Sorry for missing this.