GNOME Bugzilla – Bug 587766
Bugs in KeyFile documentation
Last modified: 2009-07-17 12:19:49 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.
Created attachment 137904 [details] [review] Patch to fix exception comments in docs This patch fixes the exception and return comments in the docs.
Pushed to master so no one else has to re-implement the fixes. I can revert it if it should not be committed.
Thanks. Sorry for missing this.