X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=glib%2Fgconvert.c;h=1d55fda1342e892ac3a32beae5c5ea923e61a192;hb=1cbdbef77209fe82239bd10f062425491cf256ae;hp=62518c0f3f2ef76c990ebe37000a46cc18126a27;hpb=0cc20b7e0b8376a1b7c14a1a712d1f22a8c0eac0;p=platform%2Fupstream%2Fglib.git
diff --git a/glib/gconvert.c b/glib/gconvert.c
index 62518c0..1d55fda 100644
--- a/glib/gconvert.c
+++ b/glib/gconvert.c
@@ -78,16 +78,16 @@
* set in which the application operates. Consider the Spanish file name
* "Presentación.sxi". If the application which created it uses
* ISO-8859-1 for its encoding,
- *
+ * |[
* Character: P r e s e n t a c i ó n . s x i
* Hex code: 50 72 65 73 65 6e 74 61 63 69 f3 6e 2e 73 78 69
- *
+ * ]|
* However, if the application use UTF-8, the actual file name on
* disk would look like this:
- *
+ * |[
* Character: P r e s e n t a c i ó n . s x i
* Hex code: 50 72 65 73 65 6e 74 61 63 69 c3 b3 6e 2e 73 78 69
- *
+ * ]|
* Glib uses UTF-8 for its strings, and GUI toolkits like GTK+ that use
* Glib do the same thing. If you get a file name from the file system,
* for example, from readdir() or from g_dir_read_name(), and you wish
@@ -104,28 +104,26 @@
* encoding for their strings, and that is also what they use for
* the file names they create. However, older file systems may
* still contain file names created in "older" encodings, such as
- * ISO-8859-1. In this case, for compatibility reasons, you may
- * want to instruct Glib to use that particular encoding for file
- * names rather than UTF-8. You can do this by specifying the
- * encoding for file names in the `G_FILENAME_ENCODING`
+ * ISO-8859-1. In this case, for compatibility reasons, you may want
+ * to instruct Glib to use that particular encoding for file names
+ * rather than UTF-8. You can do this by specifying the encoding for
+ * file names in the [`G_FILENAME_ENCODING`][G_FILENAME_ENCODING]
* environment variable. For example, if your installation uses
* ISO-8859-1 for file names, you can put this in your `~/.profile`
- *
+ * |[
* export G_FILENAME_ENCODING=ISO-8859-1
- *
+ * ]|
* Glib provides the functions g_filename_to_utf8() and
* g_filename_from_utf8() to perform the necessary conversions.
* These functions convert file names from the encoding specified
- * in `G_FILENAME_ENCODING` to UTF-8 and vice-versa.
- * illustrates how
+ * in `G_FILENAME_ENCODING` to UTF-8 and vice-versa. This
+ * [diagram][file-name-encodings-diagram] illustrates how
* these functions are used to convert between UTF-8 and the
* encoding for file names in the file system.
*
- *
- * Conversion between File Name Encodings
- *
- *
+ * ## Conversion between file name encodings # {#file-name-encodings-diagram)
+ *
+ * ![](file-name-encodings.png)
*
* ## Checklist for Application Writers
*
@@ -158,8 +156,8 @@
* the file system by using g_filename_from_utf8(). Pass the converted
* file name to functions like fopen(). If conversion fails, ask the
* user to enter a different file name. This can happen if the user
- * types Japanese characters when `G_FILENAME_ENCODING`
- * is set to ISO-8859-1, for example.
+ * types Japanese characters when `G_FILENAME_ENCODING` is set to
+ * `ISO-8859-1`, for example.
*/
/* We try to terminate strings in unknown charsets with this many zero bytes
@@ -215,7 +213,7 @@ try_to_aliases (const char **to_aliases,
* GLib provides g_convert() and g_locale_to_utf8() which are likely
* more convenient than the raw iconv wrappers.
*
- * Return value: a "conversion descriptor", or (GIConv)-1 if
+ * Returns: a "conversion descriptor", or (GIConv)-1 if
* opening the converter failed.
**/
GIConv
@@ -267,7 +265,7 @@ g_iconv_open (const gchar *to_codeset,
* GLib provides g_convert() and g_locale_to_utf8() which are likely
* more convenient than the raw iconv wrappers.
*
- * Return value: count of non-reversible conversions, or -1 on error
+ * Returns: count of non-reversible conversions, or -1 on error
**/
gsize
g_iconv (GIConv converter,
@@ -294,7 +292,7 @@ g_iconv (GIConv converter,
* GLib provides g_convert() and g_locale_to_utf8() which are likely
* more convenient than the raw iconv wrappers.
*
- * Return value: -1 on error, 0 on success
+ * Returns: -1 on error, 0 on success
**/
gint
g_iconv_close (GIConv converter)
@@ -344,7 +342,7 @@ close_converter (GIConv cd)
/**
* g_convert_with_iconv:
* @str: the string to convert
- * @len: the length of the string, or -1 if the string is
+ * @len: the length of the string in bytes, or -1 if the string is
* nul-terminated (Note that some encodings may allow nul
* bytes to occur inside strings. In that case, using -1
* for the @len parameter is unsafe)
@@ -374,7 +372,7 @@ close_converter (GIConv cd)
* character until it knows that the next character is not a mark that
* could combine with the base character.)
*
- * Return value: If the conversion was successful, a newly allocated
+ * Returns: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with
* g_free(). Otherwise %NULL and @error will be set.
**/
@@ -497,7 +495,7 @@ g_convert_with_iconv (const gchar *str,
/**
* g_convert:
* @str: the string to convert
- * @len: the length of the string, or -1 if the string is
+ * @len: the length of the string in bytes, or -1 if the string is
* nul-terminated (Note that some encodings may allow nul
* bytes to occur inside strings. In that case, using -1
* for the @len parameter is unsafe)
@@ -528,7 +526,10 @@ g_convert_with_iconv (const gchar *str,
* character until it knows that the next character is not a mark that
* could combine with the base character.)
*
- * Return value: If the conversion was successful, a newly allocated
+ * Using extensions such as "//TRANSLIT" may not work (or may not work
+ * well) on many platforms. Consider using g_str_to_ascii() instead.
+ *
+ * Returns: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with
* g_free(). Otherwise %NULL and @error will be set.
**/
@@ -573,7 +574,7 @@ g_convert (const gchar *str,
/**
* g_convert_with_fallback:
* @str: the string to convert
- * @len: the length of the string, or -1 if the string is
+ * @len: the length of the string in bytes, or -1 if the string is
* nul-terminated (Note that some encodings may allow nul
* bytes to occur inside strings. In that case, using -1
* for the @len parameter is unsafe)
@@ -612,7 +613,7 @@ g_convert (const gchar *str,
* character until it knows that the next character is not a mark that
* could combine with the base character.)
*
- * Return value: If the conversion was successful, a newly allocated
+ * Returns: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with
* g_free(). Otherwise %NULL and @error will be set.
**/
@@ -886,10 +887,9 @@ strdup_len (const gchar *string,
*
* Converts a string which is in the encoding used for strings by
* the C runtime (usually the same as that used by the operating
- * system) in the current locale into a
- * UTF-8 string.
+ * system) in the [current locale][setlocale] into a UTF-8 string.
*
- * Return value: A newly-allocated buffer containing the converted string,
+ * Returns: A newly-allocated buffer containing the converted string,
* or %NULL on an error, and error will be set.
**/
gchar *
@@ -930,10 +930,10 @@ g_locale_to_utf8 (const gchar *opsysstring,
*
* Converts a string from UTF-8 to the encoding used for strings by
* the C runtime (usually the same as that used by the operating
- * system) in the current locale. On
- * Windows this means the system codepage.
+ * system) in the [current locale][setlocale]. On Windows this means
+ * the system codepage.
*
- * Return value: A newly-allocated buffer containing the converted string,
+ * Returns: A newly-allocated buffer containing the converted string,
* or %NULL on an error, and error will be set.
**/
gchar *
@@ -987,12 +987,12 @@ filename_charset_cache_free (gpointer data)
*
* `G_FILENAME_ENCODING` may be set to a comma-separated list of
* character set names. The special token "@locale" is taken
- * to mean the character set for the current
- * locale. If `G_FILENAME_ENCODING` is not set, but
- * `G_BROKEN_FILENAMES` is, the character set of the current locale
- * is taken as the filename encoding. If neither environment variable
- * is set, UTF-8 is taken as the filename encoding, but the character
- * set of the current locale is also put in the list of encodings.
+ * to mean the character set for the [current locale][setlocale].
+ * If `G_FILENAME_ENCODING` is not set, but `G_BROKEN_FILENAMES` is,
+ * the character set of the current locale is taken as the filename
+ * encoding. If neither environment variable is set, UTF-8 is taken
+ * as the filename encoding, but the character set of the current locale
+ * is also put in the list of encodings.
*
* The returned @charsets belong to GLib and must not be freed.
*
@@ -1000,7 +1000,7 @@ filename_charset_cache_free (gpointer data)
* `G_FILENAME_ENCODING` value, the actual file names present
* on a system might be in any random encoding or just gibberish.
*
- * Return value: %TRUE if the filename encoding is UTF-8.
+ * Returns: %TRUE if the filename encoding is UTF-8.
*
* Since: 2.6
*/
@@ -1135,9 +1135,9 @@ get_filename_charset (const gchar **filename_charset)
* Converts a string which is in the encoding used by GLib for
* filenames into a UTF-8 string. Note that on Windows GLib uses UTF-8
* for filenames; on other platforms, this function indirectly depends on
- * the current locale.
+ * the [current locale][setlocale].
*
- * Return value: The converted string, or %NULL on an error.
+ * Returns: The converted string, or %NULL on an error.
**/
gchar*
g_filename_to_utf8 (const gchar *opsysstring,
@@ -1207,9 +1207,9 @@ g_filename_to_utf8 (const gchar *opsysstring,
* Converts a string from UTF-8 to the encoding GLib uses for
* filenames. Note that on Windows GLib uses UTF-8 for filenames;
* on other platforms, this function indirectly depends on the
- * current locale.
+ * [current locale][setlocale].
*
- * Return value: (array length=bytes_written) (element-type guint8) (transfer full):
+ * Returns: (array length=bytes_written) (element-type guint8) (transfer full):
* The converted string, or %NULL on an error.
**/
gchar*
@@ -1539,7 +1539,7 @@ hostname_validate (const char *hostname)
* Converts an escaped ASCII-encoded URI to a local filename in the
* encoding used for filenames.
*
- * Return value: (type filename): a newly-allocated string holding
+ * Returns: (type filename): a newly-allocated string holding
* the resulting filename, or %NULL on an error.
**/
gchar *
@@ -1698,7 +1698,7 @@ g_filename_from_uri (const gchar *uri,
* Converts an absolute filename to an escaped ASCII-encoded URI, with the path
* component following Section 3.3. of RFC 2396.
*
- * Return value: a newly-allocated string holding the resulting
+ * Returns: a newly-allocated string holding the resulting
* URI, or %NULL on an error.
**/
gchar *
@@ -1857,7 +1857,7 @@ g_uri_list_extract_uris (const gchar *uri_list)
* This function is preferred over g_filename_display_name() if you know the
* whole path, as it allows translation.
*
- * Return value: a newly allocated string containing
+ * Returns: a newly allocated string containing
* a rendition of the basename of the filename in valid UTF-8
*
* Since: 2.6
@@ -1896,7 +1896,7 @@ g_filename_display_basename (const gchar *filename)
* g_filename_display_basename(), since that allows location-based
* translation of filenames.
*
- * Return value: a newly allocated string containing
+ * Returns: a newly allocated string containing
* a rendition of the filename in valid UTF-8
*
* Since: 2.6