luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

g_file_info_get/set_attribute_string*(): Document the UTF-8ness.

Browse Source 
* gio/gfileattribute.c: (_g_file_attribute_value_get_string,
_g_file_attribute_value_set_string): These use
G_FILE_ATTRIBUTE_TYPE_STRING, which is documented as UTF-8, so
document these private functions as using UTF-8.
* gio/gfileinfo.c: (g_file_info_get_attribute_string,
g_file_info_set_attribute_string, and stringv versions):
Document that the strings are UTF-8 because the implementation uses
those private functions, that use UTF-8.

This helps language bindings (such as glibmm) whose API
distinguishes between known and unknown encodings.
This commit is contained in:
Murray Cumming 2011-03-11 09:59:09 +01:00
parent 9505ad05ee
commit c1a75ca783
2 changed files with 343 additions and 343 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
gio/gfileattribute.c
View File

@ -466,7 +466,7 @@ _g_file_attribute_value_as_string (const GFileAttributeValue *attr)
* Gets the string from a file attribute value. If the value is not the * Gets the string from a file attribute value. If the value is not the
* right type then %NULL will be returned. * right type then %NULL will be returned.
* *
* Returns: the string value contained within the attribute, or %NULL. * Returns: the UTF-8 string value contained within the attribute, or %NULL.
*/ */
const char * const char *
_g_file_attribute_value_get_string (const GFileAttributeValue *attr) _g_file_attribute_value_get_string (const GFileAttributeValue *attr)
@ -695,9 +695,9 @@ _g_file_attribute_value_set_from_pointer (GFileAttributeValue *value,
/* /*
* _g_file_attribute_value_set_string: * _g_file_attribute_value_set_string:
* @attr: a #GFileAttributeValue. * @attr: a #GFileAttributeValue.
* @string: a string to set within the type. * @string: a UTF-8 string to set within the type.
* *
* Sets the attribute value to a given string. * Sets the attribute value to a given UTF-8 string.
*/ */
void void
_g_file_attribute_value_set_string (GFileAttributeValue *attr, _g_file_attribute_value_set_string (GFileAttributeValue *attr,

10
gio/gfileinfo.c
View File

@ -873,7 +873,7 @@ g_file_info_get_attribute_object (GFileInfo *info,
* Gets the value of a string attribute. If the attribute does * Gets the value of a string attribute. If the attribute does
* not contain a string, %NULL will be returned. * not contain a string, %NULL will be returned.
* *
* Returns: the contents of the @attribute value as a string, or * Returns: the contents of the @attribute value as a UTF-8 string, or
* %NULL otherwise. * %NULL otherwise.
**/ **/
const char * const char *
@ -922,7 +922,7 @@ g_file_info_get_attribute_byte_string (GFileInfo *info,
* not contain a stringv, %NULL will be returned. * not contain a stringv, %NULL will be returned.
* *
* Returns: (transfer none): the contents of the @attribute value as a stringv, or * Returns: (transfer none): the contents of the @attribute value as a stringv, or
* %NULL otherwise. Do not free. * %NULL otherwise. Do not free. These returned strings are UTF-8.
* *
* Since: 2.22 * Since: 2.22
**/ **/
@ -1171,8 +1171,8 @@ _g_file_info_set_attribute_stringv_by_id (GFileInfo *info,
/** /**
* g_file_info_set_attribute_stringv: * g_file_info_set_attribute_stringv:
* @info: a #GFileInfo. * @info: a #GFileInfo.
* @attribute: a file attribute key. * @attribute: a file attribute key
* @attr_value: a %NULL terminated string array * @attr_value: a %NULL terminated array of UTF-8 strings.
* *
* Sets the @attribute to contain the given @attr_value, * Sets the @attribute to contain the given @attr_value,
* if possible. * if possible.
@ -1209,7 +1209,7 @@ _g_file_info_set_attribute_string_by_id (GFileInfo *info,
* g_file_info_set_attribute_string: * g_file_info_set_attribute_string:
* @info: a #GFileInfo. * @info: a #GFileInfo.
* @attribute: a file attribute key. * @attribute: a file attribute key.
* @attr_value: a string. * @attr_value: a UTF-8 string.
* *
* Sets the @attribute to contain the given @attr_value, * Sets the @attribute to contain the given @attr_value,
* if possible. * if possible.