[gspell] docs: explain that the CheckerDialog owns a ref to the navigator



commit a13252d3870c624038e52967f2cfce238e5a342d
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sun Feb 28 12:50:08 2016 +0100

    docs: explain that the CheckerDialog owns a ref to the navigator

 gspell/gspell-checker-dialog.c |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/gspell/gspell-checker-dialog.c b/gspell/gspell-checker-dialog.c
index 5d50c2c..e63fa8e 100644
--- a/gspell/gspell-checker-dialog.c
+++ b/gspell/gspell-checker-dialog.c
@@ -703,6 +703,10 @@ gspell_checker_dialog_init (GspellCheckerDialog *dialog)
  * @parent: transient parent of the dialog.
  * @navigator: the #GspellNavigator to use.
  *
+ * Creates a new #GspellCheckerDialog. The #GspellCheckerDialog will own a
+ * reference to @navigator, so you can release your reference if you no longer
+ * need it.
+ *
  * Returns: a new #GspellCheckerDialog widget.
  */
 GtkWidget *


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