[glibmm] Repair Glib::KeyFile docs with regard to exceptions. Bug# 587766.
- From: José Alburquerque <jaalburqu src gnome org>
- To: svn-commits-list gnome org
- Subject: [glibmm] Repair Glib::KeyFile docs with regard to exceptions. Bug# 587766.
- Date: Tue, 14 Jul 2009 21:02:28 +0000 (UTC)
commit e6a28c0bb2a126c08c3cfe4bd05def778382fadb
Author: José Alburquerque <jaalburqu svn gnome org>
Date: Tue Jul 14 16:53:13 2009 -0400
Repair Glib::KeyFile docs with regard to exceptions. Bug# 587766.
ChangeLog | 9 +
glib/src/glib_docs_override.xml | 351 ++++++++++++++++++++++++++++++++++++++-
glib/src/keyfile.ccg | 91 ++++++++---
glib/src/keyfile.hg | 54 +++++--
4 files changed, 458 insertions(+), 47 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 9ace033..f7ddece 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2009-07-14 José Alburquerque <jaalburqu svn gnome org>
+
+ * glib/src/glib_docs_override.xml:
+ * glib/src/keyfile.ccg:
+ * glib/src/keyfile.hg: Repair Glib::KeyFile docs with regard to
+ exceptions. Make sure that the methods that throw exceptions are
+ implemented correctly if GLIBMM_EXCEPTIONS_ENABLED is not defined.
+ Bug #587766 (Tomasz Jankowski).
+
2.21.2:
2009-07-13 Jonathon Jongsma <jonathon quotidian org>
diff --git a/glib/src/glib_docs_override.xml b/glib/src/glib_docs_override.xml
index 13bf35d..38f3afc 100644
--- a/glib/src/glib_docs_override.xml
+++ b/glib/src/glib_docs_override.xml
@@ -88,8 +88,9 @@
<function name="g_key_file_get_double">
<description>
-Return value: the value associated with the key as a double, or
+Return value: the value associated with the key as a double.
+\throw Glib::KeyFileError
</description>
<parameters>
<parameter name="key_file">
@@ -152,8 +153,8 @@ Since: 2.14
Loads a key file into an empty KeyFile instance.
If the file could not be loaded then a FileError or KeyFileError exception is thrown.
- throw Glib::FileError
- throw Glib::KeyFileError
+\throw Glib::FileError
+\throw Glib::KeyFileError
</description>
<parameters>
<parameter name="key_file">
@@ -183,8 +184,8 @@ Since: 2.6
<description>
Returns the value associated with @key under @group_name.
- throw Glib::FileError in the event the key cannot be found (with the Glib::KEY_FILE_ERROR_KEY_NOT_FOUND code).
- throw Glib::KeyFileError in the event that the @group_name cannot be found (with the Glib::KEY_FILE_ERROR_GROUP_NOT_FOUND).
+\throw Glib::FileError in the event the key cannot be found (with the Glib::KEY_FILE_ERROR_KEY_NOT_FOUND code).
+\throw Glib::KeyFileError in the event that the @group_name cannot be found (with the Glib::KEY_FILE_ERROR_GROUP_NOT_FOUND).
</description>
<parameters>
<parameter name="key_file">
@@ -210,6 +211,344 @@ Since: 2.6
</return>
</function>
+<function name="g_key_file_get_comment">
+<description>
+Retrieves a comment above @key from @group_name.
+If @key is %NULL then @comment will be read from above
+ group_name If both @key and @group_name are %NULL, then
+ comment will be read from above the first group in the file.
+Use the overrides for a %NULL @key or @group.
-</root>
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> The comment
+
+Since: 2.6
+</return>
+</function>
+
+<function name="g_key_file_set_comment">
+<description>
+Places a comment above @key from @group_name.
+If @key is %NULL then @comment will be written above @group_name.
+If both @key and @group_name are %NULL, then @comment will be
+written above the first group in the file.
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="comment">
+<parameter_description> a comment
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_key_file_remove_comment">
+<description>
+Removes a comment above @key from @group_name.
+If @key is %NULL then @comment will be removed above @group_name.
+If both @key and @group_name are %NULL, then @comment will
+be removed above the first group in the file.
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_key_file_has_key">
+<description>
+Looks whether the key file has the key @key in the group
+ group_name
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key name
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @key is a part of @group_name, %FALSE
+otherwise.
+
+Since: 2.6
+</return>
+</function>
+
+<function name="g_key_file_get_value">
+<description>
+Return value: a newly allocated string or %NULL.
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string or %NULL if the specified
+key cannot be found.
+
+Since: 2.6
+</return>
+</function>
+
+<function name="g_key_file_get_string">
+<description>
+Return value: a newly allocated string or %NULL.
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string or %NULL if the specified
+key cannot be found.
+
+Since: 2.6
+</return>
+</function>
+
+<function name="g_key_file_get_locale_string">
+<description>
+Return value: a newly allocated string or %NULL.
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="locale">
+<parameter_description> a locale identifier or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string or %NULL if the specified
+key cannot be found.
+
+Since: 2.6
+</return>
+</function>
+
+<function name="g_key_file_get_boolean">
+<description>
+Return value: the value associated with the key as a boolean.
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value associated with the key as a boolean,
+or %FALSE if the key was not found or could not be parsed.
+
+Since: 2.6
+</return>
+</function>
+
+<function name="g_key_file_get_integer">
+<description>
+Return value: the value associated with the key as an integer.
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value associated with the key as an integer, or
+0 if the key was not found or could not be parsed.
+
+Since: 2.6
+</return>
+</function>
+
+<function name="g_key_file_remove_group">
+<description>
+Removes the specified group, @group_name,
+from the key file.
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_key_file_remove_key">
+<description>
+Removes @key in @group_name from the key file.
+
+\throw Glib::KeyFileError
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key name to remove
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+</root>
diff --git a/glib/src/keyfile.ccg b/glib/src/keyfile.ccg
index b42ffaf..db4a6c5 100644
--- a/glib/src/keyfile.ccg
+++ b/glib/src/keyfile.ccg
@@ -38,34 +38,49 @@ KeyFile::~KeyFile()
g_key_file_free(gobject_);
}
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
bool KeyFile::load_from_data(const Glib::ustring& data, KeyFileFlags flags)
+#else
+bool KeyFile::load_from_data(const Glib::ustring& data, KeyFileFlags flags, std:auto_ptr<Glib::Error>& error)
+#endif
{
- GError* error = 0;
+ GError* gerror = 0;
const gboolean result = g_key_file_load_from_data(
gobj(), data.c_str(), data.bytes(),
static_cast<GKeyFileFlags>(unsigned(flags)),
- &error);
+ &gerror);
- if(error)
- Glib::Error::throw_exception(error);
+ if(gerror)
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
+ Glib::Error::throw_exception(gerror);
+#else
+ error = Glib::Error::throw_exception(gerror);
+#endif
return (result != 0);
}
-bool KeyFile::load_from_data_dirs(const std::string& file, std::string& full_path,
- KeyFileFlags flags)
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
+bool KeyFile::load_from_data_dirs(const std::string& file, std::string& full_path, KeyFileFlags flags)
+#else
+bool KeyFile::load_from_data_dirs(const std::string& file, std::string& full_path, KeyFileFlags flags, std:auto_ptr<Glib::Error>& error)
+#endif
{
- GError* error = 0;
+ GError* gerror = 0;
char* full_path_c = 0;
const gboolean result = g_key_file_load_from_data_dirs(
gobj(), file.c_str(), &full_path_c,
static_cast<GKeyFileFlags>(unsigned(flags)),
- &error);
+ &gerror);
- if(error)
- Glib::Error::throw_exception(error);
+ if(gerror)
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
+ Glib::Error::throw_exception(gerror);
+#else
+ error = Glib::Error::throw_exception(gerror);
+#endif
if(full_path_c)
full_path = Glib::ScopedPtr<char>(full_path_c).get();
@@ -75,13 +90,21 @@ bool KeyFile::load_from_data_dirs(const std::string& file, std::string& full_pat
return (result != 0);
}
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ustring KeyFile::to_data()
+#else
+Glib::ustring KeyFile::to_data(std:auto_ptr<Glib::Error>& error)
+#endif
{
- GError* error = 0;
- char *const str = g_key_file_to_data(gobj(), 0, &error);
+ GError* gerror = 0;
+ char *const str = g_key_file_to_data(gobj(), 0, &gerror);
- if(error)
- Glib::Error::throw_exception(error);
+ if(gerror)
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
+ Glib::Error::throw_exception(gerror);
+#else
+ error = Glib::Error::throw_exception(gerror);
+#endif
return Glib::convert_return_gchar_ptr_to_ustring(str);
}
@@ -94,33 +117,50 @@ Glib::ArrayHandle<Glib::ustring> KeyFile::get_groups() const
return Glib::ArrayHandle<Glib::ustring>(array, length, Glib::OWNERSHIP_DEEP);
}
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ArrayHandle<Glib::ustring> KeyFile::get_keys(const Glib::ustring& group_name) const
+#else
+Glib::ArrayHandle<Glib::ustring> KeyFile::get_keys(const Glib::ustring& group_name, std:auto_ptr<Glib::Error>& error) const
+#endif
{
gsize length = 0;
- GError* error = 0;
+ GError* gerror = 0;
char** const array = g_key_file_get_keys(
const_cast<GKeyFile*>(gobj()),
(group_name.empty()) ? 0 : group_name.c_str(),
- &length, &error);
+ &length, &gerror);
- if(error)
- Glib::Error::throw_exception(error);
+ if(gerror)
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
+ Glib::Error::throw_exception(gerror);
+#else
+ error = Glib::Error::throw_exception(gerror);
+#endif
return Glib::ArrayHandle<Glib::ustring>(array, length, Glib::OWNERSHIP_DEEP);
}
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
+Glib::ustring KeyFile::get_locale_string(const Glib::ustring& group_name,
+ const Glib::ustring& key) const
+#else
Glib::ustring KeyFile::get_locale_string(const Glib::ustring& group_name,
- const Glib::ustring& key) const
+ const Glib::ustring& key, std:auto_ptr<Glib::Error>& error) const
+#endif
{
- GError* error = 0;
+ GError* gerror = 0;
char *const str = g_key_file_get_locale_string(
const_cast<GKeyFile*>(gobj()),
(group_name.empty()) ? 0 : group_name.c_str(),
- key.c_str(), 0, &error);
+ key.c_str(), 0, &gerror);
- if(error)
- Glib::Error::throw_exception(error);
+ if(gerror)
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
+ Glib::Error::throw_exception(gerror);
+#else
+ error = Glib::Error::throw_exception(gerror);
+#endif
return Glib::convert_return_gchar_ptr_to_ustring(str);
}
@@ -140,6 +180,7 @@ int KeyFile::get_integer(const Glib::ustring& key, std::auto_ptr<Glib::Error>& e
#else
error = Glib::Error::throw_exception(gerror);
#endif
+
return value;
}
@@ -151,11 +192,11 @@ double KeyFile::get_double(const Glib::ustring& key, std::auto_ptr<Glib::Error>&
{
GError* gerror = 0;
double retvalue = g_key_file_get_double(const_cast<GKeyFile*>(gobj()), NULL, key.c_str(), &(gerror));
-#ifdef GLIBMM_EXCEPTIONS_ENABLED
+
if(gerror)
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
::Glib::Error::throw_exception(gerror);
#else
- if(gerror)
error = ::Glib::Error::throw_exception(gerror);
#endif //GLIBMM_EXCEPTIONS_ENABLED
diff --git a/glib/src/keyfile.hg b/glib/src/keyfile.hg
index c374e1d..8377974 100644
--- a/glib/src/keyfile.hg
+++ b/glib/src/keyfile.hg
@@ -116,7 +116,6 @@ public:
KeyFile(GKeyFile* castitem, bool takes_ownership = false);
public:
-
_WRAP_METHOD(bool load_from_file(const std::string& filename, KeyFileFlags flags = Glib::KEY_FILE_NONE), g_key_file_load_from_file, errthrow)
/** Loads a KeyFile from memory
@@ -125,8 +124,11 @@ public:
* @return true if the KeyFile was successfully loaded, false otherwise
* @throw Glib::KeyFileError
*/
-
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
bool load_from_data(const Glib::ustring& data, KeyFileFlags flags = Glib::KEY_FILE_NONE);
+#else
+ bool load_from_data(const Glib::ustring& data, KeyFileFlags flags = Glib::KEY_FILE_NONE, std:auto_ptr<Glib::Error>& error);
+#endif
_IGNORE(g_key_file_load_from_data)
//TODO:
@@ -150,13 +152,22 @@ public:
* @throw Glib::KeyFileError
* @throw Glib::FileError
*/
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
bool load_from_data_dirs(const std::string& file, std::string& full_path, KeyFileFlags flags = Glib::KEY_FILE_NONE);
+#else
+ bool load_from_data_dirs(const std::string& file, std::string& full_path, KeyFileFlags flags = Glib::KEY_FILE_NONE, std:auto_ptr<Glib::Error>& error);
+#endif
_IGNORE(g_key_file_load_from_data_dirs)
/** Outputs the KeyFile as a string
* @return A string object holding the contents of KeyFile
+ * @throw Glib::KeyFileError
*/
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ustring to_data();
+#else
+ Glib::ustring to_data(std:auto_ptr<Glib::Error>& error);
+#endif
_IGNORE(g_key_file_to_data)
_WRAP_METHOD(Glib::ustring get_start_group() const, g_key_file_get_start_group)
@@ -170,8 +181,13 @@ public:
/** Gets a list of all keys from the group @a group_name.
* @param group_name The name of a group
* @returns A list containing the names of the keys in @a group_name
+ * @throw Glib::KeyFileError
*/
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ArrayHandle<Glib::ustring> get_keys(const Glib::ustring& group_name) const;
+#else
+ Glib::ArrayHandle<Glib::ustring> get_keys(const Glib::ustring& group_name, std:auto_ptr<Glib::Error>& error) const;
+#endif
_IGNORE(g_key_file_get_keys)
_WRAP_METHOD(bool has_group(const Glib::ustring& group_name) const, g_key_file_has_group)
@@ -181,9 +197,16 @@ public:
_WRAP_METHOD(Glib::ustring get_string(const Glib::ustring& group_name, const Glib::ustring& key) const, g_key_file_get_string, errthrow)
/** Gets the value associated with @a key under @a group_name translated
- * into the current locale.
+ * into the current locale.
+ * @return the value as a Glib::ustring
+ * @throw Glib::KeyFileError
*/
+#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ustring get_locale_string(const Glib::ustring& group_name, const Glib::ustring& key) const;
+#else
+ Glib::ustring get_locale_string(const Glib::ustring& group_name, const Glib::ustring& key, std:auto_ptr<Glib::Error>& error) const;
+#endif
+ _IGNORE(g_key_file_get_locale_string)
_WRAP_METHOD(Glib::ustring get_locale_string(const Glib::ustring& group_name, const Glib::ustring& key, const Glib::ustring& locale) const, g_key_file_get_locale_string, errthrow)
_WRAP_METHOD(bool get_boolean(const Glib::ustring& group_name, const Glib::ustring& key) const, g_key_file_get_boolean, errthrow)
@@ -192,7 +215,7 @@ public:
* an integer.
* @param key The name of the key
* @return The value of @a key as an integer
- * @throws Glib::KeyFileError
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
int get_integer(const Glib::ustring& key) const;
@@ -205,7 +228,7 @@ public:
* a double.
* @param key The name of the key
* @return The value of @a key as an double
- * @throws Glib::KeyFileError
+ * @throw Glib::KeyFileError
*
* @newin2p14
*/
@@ -231,7 +254,7 @@ public:
* @param group_name The name of a group
* @param key The name of a key
* @return A list containing the values requested
- * @throws Glib::KeyFileError
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ArrayHandle<Glib::ustring> get_string_list(const Glib::ustring& group_name, const Glib::ustring& key) const;
@@ -245,7 +268,7 @@ public:
* @param group_name The name of a group
* @param key The name of a key
* @return A list containing the values requested
- * @throws Glib::KeyFileError
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ArrayHandle<Glib::ustring> get_locale_string_list(const Glib::ustring& group_name, const Glib::ustring& key) const;
@@ -259,7 +282,7 @@ public:
* @param key The name of a key
* @param locale The name of a locale
* @return A list containing the values requested
- * @throws Glib::KeyFileError
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ArrayHandle<Glib::ustring> get_locale_string_list(const Glib::ustring& group_name, const Glib::ustring& key, const Glib::ustring& locale) const;
@@ -272,7 +295,7 @@ public:
* @param group_name The name of a group
* @param key The name of a key
* @return A list of booleans
- * @throws Glib::KeyFileError
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ArrayHandle<bool> get_boolean_list(const Glib::ustring& group_name, const Glib::ustring& key) const;
@@ -286,7 +309,7 @@ public:
* @param group_name The name of a group
* @param key The name of a key
* @return A list of integers
- * @throws Glib::KeyFileError
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ArrayHandle<int> get_integer_list(const Glib::ustring& group_name, const Glib::ustring& key) const;
@@ -300,7 +323,7 @@ public:
* @param group_name The name of a group
* @param key The name of a key
* @return A list of doubles
- * @throws Glib::KeyFileError
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ArrayHandle<double> get_double_list(const Glib::ustring& group_name, const Glib::ustring& key) const;
@@ -312,6 +335,7 @@ public:
/** Get comment from top of file
* @return The comment
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ustring get_comment() const;
@@ -322,6 +346,7 @@ public:
/** Get comment from above a group
* @param group_name The group
* @return The comment
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
Glib::ustring get_comment(const Glib::ustring& group_name) const;
@@ -391,6 +416,7 @@ public:
/** Places @a comment at the start of the file, before the first group.
* @param comment The Comment
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
void set_comment(const Glib::ustring& comment);
@@ -401,6 +427,7 @@ public:
/** Places @a comment above @a group_name.
* @param group_name The Group the comment should be above
* @param comment The comment
+ * @throw Glib::KeyFileError
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
void set_comment(const Glib::ustring& group_name, const Glib::ustring& comment);
@@ -409,11 +436,6 @@ public:
std::auto_ptr<Glib::Error>& error);
#endif
- /** Places a comment above @a key from @a group_name.
- * @param key Key comment should be above
- * @param group_name Group comment is in
- * @param comment The comment
- */
_WRAP_METHOD(void set_comment(const Glib::ustring& group_name, const Glib::ustring& key, const Glib::ustring& comment), g_key_file_set_comment, errthrow)
_WRAP_METHOD(void remove_comment(const Glib::ustring& group_name, const Glib::ustring& key), g_key_file_remove_comment, errthrow)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
