Fix a typo

[platform/upstream/glib.git] / glib / gbookmarkfile.h

diff --git a/glib/gbookmarkfile.h b/glib/gbookmarkfile.h
index bdf97c0..f663ebf 100644 (file)
--- a/glib/gbookmarkfile.h
+++ b/glib/gbookmarkfile.h
@@ -29,10 +29,31 @@
 
 G_BEGIN_DECLS
 
-/* GError enumeration
+/**
+ * G_BOOKMARK_FILE_ERROR:
+ *
+ * Error domain for bookmark file parsing.
+ * Errors in this domain will be from the #GBookmarkFileError
+ * enumeration. See #GError for information on error domains.
  */
 #define G_BOOKMARK_FILE_ERROR  (g_bookmark_file_error_quark ())
 
+
+/**
+ * GBookmarkFileError:
+ * @G_BOOKMARK_FILE_ERROR_INVALID_URI: URI was ill-formed
+ * @G_BOOKMARK_FILE_ERROR_INVALID_VALUE: a requested field was not found
+ * @G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED: a requested application did
+ *     not register a bookmark
+ * @G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND: a requested URI was not found
+ * @G_BOOKMARK_FILE_ERROR_READ: document was ill formed
+ * @G_BOOKMARK_FILE_ERROR_UNKNOWN_ENCODING: the text being parsed was
+ *     in an unknown encoding
+ * @G_BOOKMARK_FILE_ERROR_WRITE: an error occurred while writing
+ * @G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND: requested file was not found
+ *
+ * Error codes returned by bookmark file parsing.
+ */
 typedef enum
 {
   G_BOOKMARK_FILE_ERROR_INVALID_URI,
@@ -47,8 +68,11 @@ typedef enum
 
 GQuark g_bookmark_file_error_quark (void);
 
-/*
- * GBookmarkFile
+/**
+ * GBookmarkFile:
+ *
+ * The <structname>GBookmarkFile</structname> struct contains only
+ * private data and should not be directly accessed.
  */
 typedef struct _GBookmarkFile GBookmarkFile;