[gedit/wip/loader-saver] Update doc of gedit_document_get_file()



commit a5605218a1c6b0687bb98dc72156395a7dd0c0e4
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Tue Jul 1 00:13:22 2014 +0200

    Update doc of gedit_document_get_file()

 gedit/gedit-document.c |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)
---
diff --git a/gedit/gedit-document.c b/gedit/gedit-document.c
index db6d240..ab7e531 100644
--- a/gedit/gedit-document.c
+++ b/gedit/gedit-document.c
@@ -1813,14 +1813,16 @@ _gedit_document_get_empty_search (GeditDocument *doc)
  * @doc: a #GeditDocument.
  *
  * Gets the associated #GtkSourceFile. You should use it only for reading
- * purposes, not for creating a #GtkSourceFileLoader or #GtkSourceFileSaver. Use
- * the higher-lever gedit API instead, since those functions do some extra work,
- * like displaying progress and error information in an info bar.
+ * purposes, not for creating a #GtkSourceFileLoader or #GtkSourceFileSaver,
+ * because gedit does some extra work when loading or saving a file and
+ * maintains an internal state. If you use in a plugin a file loader or saver on
+ * the returned #GtkSourceFile, the internal state of gedit won't be updated.
  *
  * If you want to save the #GeditDocument to a secondary file, you can create a
  * new #GtkSourceFile and use a #GtkSourceFileSaver.
  *
  * Returns: (transfer none): the associated #GtkSourceFile.
+ * Since: 3.14
  */
 GtkSourceFile *
 gedit_document_get_file (GeditDocument *doc)


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