[gedit] Improve doc of gedit_encodings_combo_box_get_selected_encoding()



commit 11ad99d65591079b25162612fb02c84a6c029f53
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Mon Aug 11 20:11:16 2014 +0200

    Improve doc of gedit_encodings_combo_box_get_selected_encoding()

 gedit/gedit-encodings-combo-box.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)
---
diff --git a/gedit/gedit-encodings-combo-box.c b/gedit/gedit-encodings-combo-box.c
index 25fb26a..9025e92 100644
--- a/gedit/gedit-encodings-combo-box.c
+++ b/gedit/gedit-encodings-combo-box.c
@@ -437,7 +437,8 @@ gedit_encodings_combo_box_new (gboolean save_mode)
  * gedit_encodings_combo_box_get_selected_encoding:
  * @menu: a #GeditEncodingsComboBox.
  *
- * Returns: the selected #GtkSourceEncoding.
+ * Returns: the selected #GtkSourceEncoding, or %NULL if the encoding should be
+ * auto-detected (only for loading mode, not for saving).
  */
 const GtkSourceEncoding *
 gedit_encodings_combo_box_get_selected_encoding (GeditEncodingsComboBox *menu)


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