X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=glib%2Fgkeyfile.c;h=cc51eda690eaf9afea04a3475e4bb10e7cc9f580;hb=904ec5534cdc45d9b90e86a467e97af3b1bdd66d;hp=d8c01bbff60626f54adf6479303e602054053277;hpb=c575d24dfb78d956e66a522524c7b1d82d0adde7;p=platform%2Fupstream%2Fglib.git diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c index d8c01bb..cc51eda 100644 --- a/glib/gkeyfile.c +++ b/glib/gkeyfile.c @@ -74,17 +74,15 @@ * @short_description: parses .ini-like config files * * #GKeyFile lets you parse, edit or create files containing groups of - * key-value pairs, which we call key files for - * lack of a better name. Several freedesktop.org specifications use - * key files now, e.g the - * Desktop - * Entry Specification and the - * Icon - * Theme Specification. + * key-value pairs, which we call "key files" for lack of a better name. + * Several freedesktop.org specifications use key files now, e.g the + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) + * and the + * [Icon Theme Specification](http://freedesktop.org/Standards/icon-theme-spec). * * The syntax of key files is described in detail in the - * Desktop - * Entry Specification, here is a quick summary: Key files + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec), + * here is a quick summary: Key files * consists of groups of key-value pairs, interspersed with comments. * * |[ @@ -115,11 +113,11 @@ * in '[' and ']', and ended implicitly by the start of the next group or * the end of the file. Each key-value pair must be contained in a group. * - * Key-value pairs generally have the form key=value, - * with the exception of localized strings, which have the form - * key[locale]=value, with a locale identifier of the - * form lang_COUNTRY@MODIFIER where - * COUNTRY and MODIFIER are optional. + * Key-value pairs generally have the form `key=value`, with the + * exception of localized strings, which have the form + * `key[locale]=value`, with a locale identifier of the + * form `lang_COUNTRY@MODIFIER` where `COUNTRY` and `MODIFIER` + * are optional. * Space before and after the '=' character are ignored. Newline, tab, * carriage return and backslash characters in value are escaped as \n, * \t, \r, and \\, respectively. To preserve leading spaces in values, @@ -132,24 +130,25 @@ * * This syntax is obviously inspired by the .ini files commonly met * on Windows, but there are some important differences: - * - * .ini files use the ';' character to begin comments, - * key files use the '#' character. - * Key files do not allow for ungrouped keys meaning only - * comments can precede the first group. - * Key files are always encoded in UTF-8. - * Key and Group names are case-sensitive. For example, a - * group called [GROUP] is a different from - * [group]. - * .ini files don't have a strongly typed boolean entry type, - * they only have GetProfileInt(). In key files, only - * true and false (in lower case) - * are allowed. - * + * + * - .ini files use the ';' character to begin comments, + * key files use the '#' character. + * + * - Key files do not allow for ungrouped keys meaning only + * comments can precede the first group. + * + * - Key files are always encoded in UTF-8. + * + * - Key and Group names are case-sensitive. For example, a group called + * [GROUP] is a different from [group]. + * + * - .ini files don't have a strongly typed boolean entry type, + * they only have GetProfileInt(). In key files, only + * true and false (in lower case) are allowed. * * Note that in contrast to the - * Desktop - * Entry Specification, groups in key files may contain the same + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec), + * groups in key files may contain the same * key multiple times; the last entry wins. Key files may also contain * multiple groups with the same name; they are merged together. * Another difference is that keys and group names in key files are not @@ -197,8 +196,8 @@ * G_KEY_FILE_DESKTOP_GROUP: * * The name of the main group of a desktop entry file, as defined in the - * Desktop - * Entry Specification. Consult the specification for more + * [Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec). + * Consult the specification for more * details about the meanings of the keys below. * * Since: 2.14 @@ -307,7 +306,7 @@ * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * giving the file name of a binary on disk used to determine if the * program is actually installed. It is only valid for desktop entries - * with the Application type. + * with the `Application` type. * * Since: 2.14 */ @@ -317,7 +316,7 @@ * * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * giving the command line to execute. It is only valid for desktop - * entries with the Application type. + * entries with the `Application` type. * * Since: 2.14 */ @@ -327,7 +326,7 @@ * * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * containing the working directory to run the program in. It is only - * valid for desktop entries with the Application type. + * valid for desktop entries with the `Application` type. * * Since: 2.14 */ @@ -338,7 +337,7 @@ * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean * stating whether the program should be run in a terminal window. * It is only valid for desktop entries with the - * Application type. + * `Application` type. * * Since: 2.14 */ @@ -366,9 +365,8 @@ * G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY: * * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean - * stating whether the application supports the Startup - * Notification Protocol Specification. + * stating whether the application supports the + * [Startup Notification Protocol Specification](http://www.freedesktop.org/Standards/startup-notification-spec). * * Since: 2.14 */ @@ -389,7 +387,7 @@ * * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * giving the URL to access. It is only valid for desktop entries - * with the Link type. + * with the `Link` type. * * Since: 2.14 */ @@ -613,7 +611,7 @@ g_key_file_clear (GKeyFile *key_file) * g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to * read an existing key file. * - * Return value: (transfer full): an empty #GKeyFile. + * Returns: (transfer full): an empty #GKeyFile. * * Since: 2.6 **/ @@ -816,7 +814,7 @@ g_key_file_load_from_fd (GKeyFile *key_file, * If the file could not be loaded then @error is set to * either a #GFileError or #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE otherwise + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise * * Since: 2.6 **/ @@ -865,7 +863,7 @@ g_key_file_load_from_file (GKeyFile *key_file, * Loads a key file from memory into an empty #GKeyFile structure. * If the object cannot be created then %error is set to a #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE otherwise + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise * * Since: 2.6 **/ @@ -926,7 +924,7 @@ g_key_file_load_from_data (GKeyFile *key_file, * be loaded then an %error is set to either a #GFileError or * #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE otherwise + * Returns: %TRUE if a key file could be loaded, %FALSE otherwise * * Since: 2.14 **/ @@ -999,7 +997,7 @@ g_key_file_load_from_dirs (GKeyFile *key_file, * @full_path. If the file could not be loaded then an %error is * set to either a #GFileError or #GKeyFileError. * - * Return value: %TRUE if a key file could be loaded, %FALSE othewise + * Returns: %TRUE if a key file could be loaded, %FALSE othewise * Since: 2.6 **/ gboolean @@ -1434,7 +1432,7 @@ g_key_file_flush_parse_buffer (GKeyFile *key_file, * Note that this function never reports an error, * so it is safe to pass %NULL as @error. * - * Return value: a newly allocated string holding + * Returns: a newly allocated string holding * the contents of the #GKeyFile * * Since: 2.6 @@ -1504,7 +1502,7 @@ g_key_file_to_data (GKeyFile *key_file, * be found, %NULL is returned and @error is set to * #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. + * Returns: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. * Use g_strfreev() to free it. * * Since: 2.6 @@ -1575,7 +1573,7 @@ g_key_file_get_keys (GKeyFile *key_file, * * Returns the name of the start group of the file. * - * Return value: The start group of the key file. + * Returns: The start group of the key file. * * Since: 2.6 **/ @@ -1599,7 +1597,7 @@ g_key_file_get_start_group (GKeyFile *key_file) * The array of returned groups will be %NULL-terminated, so * @length may optionally be %NULL. * - * Return value: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. + * Returns: (array zero-terminated=1) (transfer full): a newly-allocated %NULL-terminated array of strings. * Use g_strfreev() to free it. * Since: 2.6 **/ @@ -1666,7 +1664,7 @@ g_key_file_get_groups (GKeyFile *key_file, * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -1777,7 +1775,7 @@ g_key_file_set_value (GKeyFile *key_file, * event that the @group_name cannot be found, %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -1888,7 +1886,7 @@ g_key_file_set_string (GKeyFile *key_file, * event that the @group_name cannot be found, %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND. * - * Return value: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): + * Returns: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): * a %NULL-terminated string array or %NULL if the specified * key cannot be found. The array should be freed with g_strfreev(). * @@ -2066,7 +2064,7 @@ g_key_file_set_locale_string (GKeyFile *key_file, * with @key cannot be interpreted or no suitable translation can * be found then the untranslated value is returned. * - * Return value: a newly allocated string or %NULL if the specified + * Returns: a newly allocated string or %NULL if the specified * key cannot be found. * * Since: 2.6 @@ -2156,7 +2154,7 @@ g_key_file_get_locale_string (GKeyFile *key_file, * returned array is %NULL-terminated, so @length may optionally * be %NULL. * - * Return value: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): a newly allocated %NULL-terminated string array + * Returns: (array zero-terminated=1 length=length) (element-type utf8) (transfer full): a newly allocated %NULL-terminated string array * or %NULL if the key isn't found. The string array should be freed * with g_strfreev(). * @@ -2276,7 +2274,7 @@ g_key_file_set_locale_string_list (GKeyFile *key_file, * associated with @key cannot be interpreted as a boolean then %FALSE * is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the value associated with the key as a boolean, + * Returns: 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 @@ -2370,7 +2368,7 @@ g_key_file_set_boolean (GKeyFile *key_file, * with @key cannot be interpreted as booleans then %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: (array length=length) (element-type gboolean) (transfer container): + * Returns: (array length=length) (element-type gboolean) (transfer container): * the values associated with the key as a list of booleans, or %NULL if the * key was not found or could not be parsed. The returned list of booleans * should be freed with g_free() when no longer needed. @@ -2491,7 +2489,7 @@ g_key_file_set_boolean_list (GKeyFile *key_file, * with @key cannot be interpreted as an integer then 0 is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the value associated with the key as an integer, or + * Returns: 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 @@ -2741,7 +2739,7 @@ g_key_file_set_uint64 (GKeyFile *key_file, * with @key cannot be interpreted as integers then %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: (array length=length) (element-type gint) (transfer container): + * Returns: (array length=length) (element-type gint) (transfer container): * the values associated with the key as a list of integers, or %NULL if * the key was not found or could not be parsed. The returned list of * integers should be freed with g_free() when no longer needed. @@ -2859,7 +2857,7 @@ g_key_file_set_integer_list (GKeyFile *key_file, * with @key cannot be interpreted as a double then 0.0 is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: the value associated with the key as a double, or + * Returns: 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 @@ -2954,7 +2952,7 @@ g_key_file_set_double (GKeyFile *key_file, * with @key cannot be interpreted as doubles then %NULL is returned * and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE. * - * Return value: (array length=length) (element-type gdouble) (transfer container): + * Returns: (array length=length) (element-type gdouble) (transfer container): * the values associated with the key as a list of doubles, or %NULL if the * key was not found or could not be parsed. The returned list of doubles * should be freed with g_free() when no longer needed. @@ -3501,7 +3499,7 @@ g_key_file_remove_comment (GKeyFile *key_file, * * Looks whether the key file has the group @group_name. * - * Return value: %TRUE if @group_name is a part of @key_file, %FALSE + * Returns: %TRUE if @group_name is a part of @key_file, %FALSE * otherwise. * Since: 2.6 **/ @@ -3569,7 +3567,7 @@ g_key_file_has_key_full (GKeyFile *key_file, * Language bindings should use g_key_file_get_value() to test whether * or not a key exists. * - * Return value: %TRUE if @key is a part of @group_name, %FALSE otherwise + * Returns: %TRUE if @key is a part of @group_name, %FALSE otherwise * * Since: 2.6 **/