[gspell] docs: more docs in the GspellEntry class description



commit 08bcdf9078e929c1f4cfcb8a9ea559ca8ddce61e
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Nov 26 18:47:26 2016 +0100

    docs: more docs in the GspellEntry class description

 gspell/gspell-entry.c |   12 +++++++++++-
 1 files changed, 11 insertions(+), 1 deletions(-)
---
diff --git a/gspell/gspell-entry.c b/gspell/gspell-entry.c
index f8becb3..0e7e2b6 100644
--- a/gspell/gspell-entry.c
+++ b/gspell/gspell-entry.c
@@ -30,7 +30,17 @@
  *
  * #GspellEntry extends the #GtkEntry class with inline spell checking.
  * Misspelled words are highlighted with a %PANGO_UNDERLINE_ERROR, usually a red
- * wavy underline.
+ * wavy underline. Right-clicking a misspelled word pops up a context menu of
+ * suggested replacements. The context menu also contains an “Ignore All” item
+ * to add the misspelled word to the session dictionary. And an “Add” item to
+ * add the word to the personal dictionary.
+ *
+ * For a basic use-case, there is the gspell_entry_basic_setup() convenience
+ * function.
+ *
+ * If you don't use the gspell_entry_basic_setup() function, you need to call
+ * gspell_entry_buffer_set_spell_checker() to associate a #GspellChecker to the
+ * #GtkEntryBuffer.
  *
  * Note that #GspellEntry extends the #GtkEntry class but without subclassing
  * it, because #GtkEntry is already subclassed by #GtkSearchEntry for example.


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