[gtksourceview/wip/loader-saver] doc: descriptions for the FileLoader and FileSaver



commit fe8706dec60a35daecce3fee6467f8551d84ae51
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Mar 29 20:00:43 2014 +0100

    doc: descriptions for the FileLoader and FileSaver

 gtksourceview/gtksourcefileloader.c |   10 ++++++++++
 gtksourceview/gtksourcefilesaver.c  |   22 ++++++++++++++++------
 2 files changed, 26 insertions(+), 6 deletions(-)
---
diff --git a/gtksourceview/gtksourcefileloader.c b/gtksourceview/gtksourcefileloader.c
index 5240c76..8be41d7 100644
--- a/gtksourceview/gtksourcefileloader.c
+++ b/gtksourceview/gtksourcefileloader.c
@@ -29,6 +29,16 @@
 #include "gtksourceview-typebuiltins.h"
 #include "gtksourceview-i18n.h"
 
+/**
+ * SECTION:fileloader
+ * @Short_description: Load a file into a GtkSourceBuffer
+ * @Title: GtkSourceFileLoader
+ * @See_also: #GtkSourceFileSaver, #GtkSourceBuffer
+ *
+ * A #GtkSourceFileLoader object permits to load the content of a #GFile or a
+ * #GInputStream into a #GtkSourceBuffer.
+ */
+
 #if 0
 #define DEBUG(x) (x)
 #else
diff --git a/gtksourceview/gtksourcefilesaver.c b/gtksourceview/gtksourcefilesaver.c
index 1ce7ed4..ee0c38b 100644
--- a/gtksourceview/gtksourcefilesaver.c
+++ b/gtksourceview/gtksourcefilesaver.c
@@ -22,18 +22,28 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-/* The code has been written initially in gedit (GeditDocumentSaver).
- * It uses a GtkSourceBufferInputStream as input, create converter(s) if needed
- * for the encoding and the compression, and write the contents to a
- * GOutputStream (the file).
- */
-
 #include "gtksourcefilesaver.h"
 #include "gtksourcebufferinputstream.h"
 #include "gtksourceencoding.h"
 #include "gtksourceview-typebuiltins.h"
 #include "gtksourceview-i18n.h"
 
+/**
+ * SECTION:filesaver
+ * @Short_description: Save a GtkSourceBuffer into a file
+ * @Title: GtkSourceFileSaver
+ * @See_also: #GtkSourceFileLoader, #GtkSourceBuffer
+ *
+ * A #GtkSourceFileSaver object permits to save a #GtkSourceBuffer into a
+ * #GFile.
+ */
+
+/* The code has been written initially in gedit (GeditDocumentSaver).
+ * It uses a GtkSourceBufferInputStream as input, create converter(s) if needed
+ * for the encoding and the compression, and write the contents to a
+ * GOutputStream (the file).
+ */
+
 #if 0
 #define DEBUG(x) (x)
 #else


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