Tizen 2.1 base

[platform/upstream/glib2.0.git] / glib / gconvert.h

diff --git a/glib/gconvert.h b/glib/gconvert.h
index c4f274f..7fd16c8 100644 (file)
--- a/glib/gconvert.h
+++ b/glib/gconvert.h
@@ -24,7 +24,7 @@
  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
+#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
 #error "Only <glib.h> can be included directly."
 #endif
 
@@ -35,7 +35,19 @@
 
 G_BEGIN_DECLS
 
-typedef enum 
+/**
+ * GConvertError:
+ * @G_CONVERT_ERROR_NO_CONVERSION: Conversion between the requested character
+ *     sets is not supported.
+ * @G_CONVERT_ERROR_ILLEGAL_SEQUENCE: Invalid byte sequence in conversion input.
+ * @G_CONVERT_ERROR_FAILED: Conversion failed for some reason.
+ * @G_CONVERT_ERROR_PARTIAL_INPUT: Partial character sequence at end of input.
+ * @G_CONVERT_ERROR_BAD_URI: URI is invalid.
+ * @G_CONVERT_ERROR_NOT_ABSOLUTE_PATH: Pathname is not an absolute path.
+ *
+ * Error codes returned by character set conversion routines.
+ */
+typedef enum
 {
   G_CONVERT_ERROR_NO_CONVERSION,
   G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
@@ -45,10 +57,22 @@ typedef enum
   G_CONVERT_ERROR_NOT_ABSOLUTE_PATH
 } GConvertError;
 
+/**
+ * G_CONVERT_ERROR:
+ *
+ * Error domain for character set conversions. Errors in this domain will
+ * be from the #GConvertError enumeration. See #GError for information on
+ * error domains.
+ */
 #define G_CONVERT_ERROR g_convert_error_quark()
 GQuark g_convert_error_quark (void);
 
-/* Thin wrappers around iconv
+/**
+ * GIconv:
+ *
+ * The <structname>GIConv</structname> struct wraps an
+ * iconv() conversion descriptor. It contains private data
+ * and should only be accessed using the following functions.
  */
 typedef struct _GIConv *GIConv;
 
@@ -101,12 +125,14 @@ gchar* g_locale_from_utf8 (const gchar  *utf8string,
 /* Convert between the operating system (or C runtime)
  * representation of file names and UTF-8.
  */
+#ifndef __GTK_DOC_IGNORE__
 #ifdef G_OS_WIN32
 #define g_filename_to_utf8 g_filename_to_utf8_utf8
 #define g_filename_from_utf8 g_filename_from_utf8_utf8
 #define g_filename_from_uri g_filename_from_uri_utf8
 #define g_filename_to_uri g_filename_to_uri_utf8 
 #endif
+#endif
 
 gchar* g_filename_to_utf8   (const gchar  *opsysstring,
                             gssize        len,            
@@ -127,7 +153,7 @@ gchar *g_filename_to_uri   (const gchar *filename,
                            const gchar *hostname,
                            GError     **error) G_GNUC_MALLOC;
 gchar *g_filename_display_name (const gchar *filename) G_GNUC_MALLOC;
-gboolean g_get_filename_charsets (G_CONST_RETURN gchar ***charsets);
+gboolean g_get_filename_charsets (const gchar ***charsets);
 
 gchar *g_filename_display_basename (const gchar *filename) G_GNUC_MALLOC;