[gtksourceview/wip/loader-saver] Resolve some TODO items



commit f2bc79704c0953324c279a7d469701668f18d666
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Thu Apr 3 19:07:03 2014 +0200

    Resolve some TODO items

 docs/reference/gtksourceview-3.0-sections.txt |    2 ++
 gtksourceview/gtksourcebuffer.h               |    6 ------
 gtksourceview/gtksourcefileloader.c           |    4 ++--
 gtksourceview/gtksourcefileloader.h           |   16 +++++++++++++---
 4 files changed, 17 insertions(+), 11 deletions(-)
---
diff --git a/docs/reference/gtksourceview-3.0-sections.txt b/docs/reference/gtksourceview-3.0-sections.txt
index cfedbe8..e7c2952 100644
--- a/docs/reference/gtksourceview-3.0-sections.txt
+++ b/docs/reference/gtksourceview-3.0-sections.txt
@@ -241,6 +241,8 @@ gtk_source_encoding_get_type
 <TITLE>GtkSourceFileLoader</TITLE>
 GtkSourceFileLoader
 GTK_SOURCE_FILE_LOADER_ERROR
+GtkSourceFileLoaderError
+<SUBSECTION>
 gtk_source_file_loader_new
 gtk_source_file_loader_new_from_stream
 gtk_source_file_loader_set_candidate_encodings
diff --git a/gtksourceview/gtksourcebuffer.h b/gtksourceview/gtksourcebuffer.h
index c81acdd..0b5e8ce 100644
--- a/gtksourceview/gtksourcebuffer.h
+++ b/gtksourceview/gtksourcebuffer.h
@@ -96,12 +96,6 @@ typedef enum
 #define GTK_SOURCE_NEWLINE_TYPE_DEFAULT GTK_SOURCE_NEWLINE_TYPE_LF
 #endif
 
-/* NOTE: when adding a new compression type, make sure to update:
- *   1) The buffer loader to support it
- *   2) gedit_document_compression_type_for_display
- * TODO update this comment when finished
- */
-
 /**
  * GtkSourceCompressionType:
  * @GTK_SOURCE_COMPRESSION_TYPE_NONE: save file in plain text.
diff --git a/gtksourceview/gtksourcefileloader.c b/gtksourceview/gtksourcefileloader.c
index 8fb1643..3d71781 100644
--- a/gtksourceview/gtksourcefileloader.c
+++ b/gtksourceview/gtksourcefileloader.c
@@ -355,8 +355,8 @@ close_input_stream_cb (GInputStream        *input_stream,
                g_task_return_new_error (loader->priv->task,
                                         GTK_SOURCE_FILE_LOADER_ERROR,
                                         GTK_SOURCE_FILE_LOADER_ERROR_CONVERSION_FALLBACK,
-                                        "There was a conversion error and it was "
-                                        "needed to use a fallback char");
+                                        "There was an encoding conversion error and it was "
+                                        "needed to use a fallback character");
                return;
        }
 
diff --git a/gtksourceview/gtksourcefileloader.h b/gtksourceview/gtksourcefileloader.h
index cf34d31..e6cd1e1 100644
--- a/gtksourceview/gtksourcefileloader.h
+++ b/gtksourceview/gtksourcefileloader.h
@@ -43,13 +43,23 @@ typedef struct _GtkSourceFileLoaderPrivate GtkSourceFileLoaderPrivate;
 
 #define GTK_SOURCE_FILE_LOADER_ERROR gtk_source_file_loader_error_quark ()
 
-/* TODO document the errors */
-enum
+/**
+ * GtkSourceFileLoaderError:
+ * @GTK_SOURCE_FILE_LOADER_ERROR_TOO_BIG: The file is too big.
+ * @GTK_SOURCE_FILE_LOADER_ERROR_ENCODING_AUTO_DETECTION_FAILED: It is not
+ * possible to detect the encoding automatically.
+ * @GTK_SOURCE_FILE_LOADER_ERROR_CONVERSION_FALLBACK: There was an encoding
+ * conversion error and it was needed to use a fallback character.
+ *
+ * An error code used with %GTK_SOURCE_FILE_LOADER_ERROR in a #GError returned
+ * from a file loading related function.
+ */
+typedef enum
 {
        GTK_SOURCE_FILE_LOADER_ERROR_TOO_BIG,
        GTK_SOURCE_FILE_LOADER_ERROR_ENCODING_AUTO_DETECTION_FAILED,
        GTK_SOURCE_FILE_LOADER_ERROR_CONVERSION_FALLBACK
-};
+} GtkSourceFileLoaderError;
 
 struct _GtkSourceFileLoader
 {


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]