[gtksourceview/wip/loader-saver] File loading and saving: improve doc



commit c5f775b7020c8cdf2b98ccdd98c0d210df8d6d38
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Tue Jul 8 22:00:08 2014 +0200

    File loading and saving: improve doc

 gtksourceview/gtksourcefileloader.c |    6 +++++-
 gtksourceview/gtksourcefilesaver.c  |    4 ++++
 2 files changed, 9 insertions(+), 1 deletions(-)
---
diff --git a/gtksourceview/gtksourcefileloader.c b/gtksourceview/gtksourcefileloader.c
index 0537985..5620922 100644
--- a/gtksourceview/gtksourcefileloader.c
+++ b/gtksourceview/gtksourcefileloader.c
@@ -36,8 +36,12 @@
  * @Title: GtkSourceFileLoader
  * @See_also: #GtkSourceFile, #GtkSourceFileSaver
  *
- * A #GtkSourceFileLoader object permits to load the content of a #GFile or a
+ * A #GtkSourceFileLoader object permits to load the contents of a #GFile or a
  * #GInputStream into a #GtkSourceBuffer.
+ *
+ * A file loader should be used only for one load operation, including errors
+ * handling. If an error occurs, you can reconfigure the loader and relaunch the
+ * operation with gtk_source_file_loader_load_async().
  */
 
 #if 0
diff --git a/gtksourceview/gtksourcefilesaver.c b/gtksourceview/gtksourcefilesaver.c
index 222bde5..6d6651b 100644
--- a/gtksourceview/gtksourcefilesaver.c
+++ b/gtksourceview/gtksourcefilesaver.c
@@ -39,6 +39,10 @@
  *
  * A #GtkSourceFileSaver object permits to save a #GtkSourceBuffer into a
  * #GFile.
+ *
+ * A file saver should be used only for one save operation, including errors
+ * handling. If an error occurs, you can reconfigure the saver and relaunch the
+ * operation with gtk_source_file_saver_save_async().
  */
 
 /* The code has been written initially in gedit (GeditDocumentSaver).


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