luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-23 16:10:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document the error return values rather than calling them undefined.

Browse Source 
* glib/gkeyfile.c (g_key_file_get_boolean)
	(g_key_file_get_boolean_list, g_key_file_get_integer)
	(g_key_file_get_integer_list, g_key_file_get_double)
	(g_key_file_get_double_list): Document the error return values
	rather than calling them undefined. #435885.

svn path=/trunk/; revision=5484
This commit is contained in:
Dan Winship 2007-05-04 19:14:47 +00:00
parent f2cfe19d15
commit 4b6a5ee2e0
2 changed files with 45 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ChangeLog
View File

@ -1,3 +1,11 @@
2007-05-04 Dan Winship <danw@novell.com>
* glib/gkeyfile.c (g_key_file_get_boolean)
(g_key_file_get_boolean_list, g_key_file_get_integer)
(g_key_file_get_integer_list, g_key_file_get_double)
(g_key_file_get_double_list): Document the error return values
rather than calling them undefined. #435885.
2007-05-03 Behdad Esfahbod <behdad@gnome.org> 2007-05-03 Behdad Esfahbod <behdad@gnome.org>
* glib/glib.symbols: * glib/glib.symbols:

73
glib/gkeyfile.c
View File

@ -1819,13 +1819,14 @@ g_key_file_set_locale_string_list (GKeyFile *key_file,
* Returns the value associated with @key under @group_name as a * Returns the value associated with @key under @group_name as a
* boolean. * boolean.
* *
* If @key cannot be found then the return value is undefined and * If @key cannot be found then %FALSE is returned and @error is set
* @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value
* the value associated with @key cannot be interpreted as a boolean * associated with @key cannot be interpreted as a boolean then %FALSE
* then the return value is also undefined and @error is set to * is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
* #G_KEY_FILE_ERROR_INVALID_VALUE. *
* Return value: the value associated with the key as a boolean, or
* %FALSE if the key was not found or could not be parsed.
* *
* Return value: the value associated with the key as a boolean
* Since: 2.6 * Since: 2.6
**/ **/
gboolean gboolean
@ -1912,13 +1913,13 @@ g_key_file_set_boolean (GKeyFile *key_file,
* Returns the values associated with @key under @group_name as * Returns the values associated with @key under @group_name as
* booleans. If @group_name is %NULL, the start_group is used. * booleans. If @group_name is %NULL, the start_group is used.
* *
* If @key cannot be found then the return value is undefined and * If @key cannot be found then %NULL is returned and @error is set to
* @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
* the values associated with @key cannot be interpreted as booleans * with @key cannot be interpreted as booleans then %NULL is returned
* then the return value is also undefined and @error is set to * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
* #G_KEY_FILE_ERROR_INVALID_VALUE.
* *
* Return value: the values associated with the key as a boolean * Return value: the values associated with the key as a list of
* booleans, or %NULL if the key was not found or could not be parsed.
* *
* Since: 2.6 * Since: 2.6
**/ **/
@ -2028,13 +2029,13 @@ g_key_file_set_boolean_list (GKeyFile *key_file,
* Returns the value associated with @key under @group_name as an * Returns the value associated with @key under @group_name as an
* integer. If @group_name is %NULL, the start_group is used. * integer. If @group_name is %NULL, the start_group is used.
* *
* If @key cannot be found then the return value is undefined and * If @key cannot be found then 0 is returned and @error is set to
* @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
* the value associated with @key cannot be interpreted as an integer * with @key cannot be interpreted as an integer then 0 is returned
* then the return value is also undefined and @error is set to * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
* #G_KEY_FILE_ERROR_INVALID_VALUE.
* *
* Return value: the value associated with the key as an integer. * Return value: 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 * Since: 2.6
**/ **/
@ -2124,13 +2125,13 @@ g_key_file_set_integer (GKeyFile *key_file,
* Returns the values associated with @key under @group_name as * Returns the values associated with @key under @group_name as
* integers. * integers.
* *
* If @key cannot be found then the return value is undefined and * If @key cannot be found then %NULL is returned and @error is set to
* @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
* the values associated with @key cannot be interpreted as integers * with @key cannot be interpreted as integers then %NULL is returned
* then the return value is also undefined and @error is set to * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
* #G_KEY_FILE_ERROR_INVALID_VALUE.
* *
* Return value: the values associated with the key as a integer * Return value: the values associated with the key as a list of
* integers, or %NULL if the key was not found or could not be parsed.
* *
* Since: 2.6 * Since: 2.6
**/ **/
@ -2237,13 +2238,13 @@ g_key_file_set_integer_list (GKeyFile *key_file,
* Returns the value associated with @key under @group_name as a * Returns the value associated with @key under @group_name as a
* double. If @group_name is %NULL, the start_group is used. * double. If @group_name is %NULL, the start_group is used.
* *
* If @key cannot be found then the return value is undefined and * If @key cannot be found then 0.0 is returned and @error is set to
* @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
* the value associated with @key cannot be interpreted as a double * with @key cannot be interpreted as a double then 0.0 is returned
* then the return value is also undefined and @error is set to * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
* #G_KEY_FILE_ERROR_INVALID_VALUE.
* *
* Return value: the value associated with the key as a double. * Return value: the value associated with the key as a double, or
* 0.0 if the key was not found or could not be parsed.
* *
* Since: 2.12 * Since: 2.12
**/ **/
@ -2333,13 +2334,13 @@ g_key_file_set_double (GKeyFile *key_file,
* Returns the values associated with @key under @group_name as * Returns the values associated with @key under @group_name as
* doubles. If @group_name is %NULL, the start group is used. * doubles. If @group_name is %NULL, the start group is used.
* *
* If @key cannot be found then the return value is undefined and * If @key cannot be found then %NULL is returned and @error is set to
* @error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if * #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
* the values associated with @key cannot be interpreted as doubles * with @key cannot be interpreted as doubles then %NULL is returned
* then the return value is also undefined and @error is set to * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
* #G_KEY_FILE_ERROR_INVALID_VALUE.
* *
* Return value: the values associated with the key as a double * Return value: the values associated with the key as a list of
* doubles, or %NULL if the key was not found or could not be parsed.
* *
* Since: 2.12 * Since: 2.12
**/ **/