[gspell] Entry: add comment about GtkEntry:input-purpose and :input-hints

[Sébastien Wilmet <swilmet src gnome org>]

commit 2c2f46e5e52be8cd420ca5074fff0b209fd00cd5
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Thu Dec 22 20:09:06 2016 +0100

    Entry: add comment about GtkEntry:input-purpose and :input-hints

 gspell/gspell-entry.c |   13 +++++++++++++
 1 files changed, 13 insertions(+), 0 deletions(-)
---
diff --git a/gspell/gspell-entry.c b/gspell/gspell-entry.c
index 021cccb..d9bd2b1 100644
--- a/gspell/gspell-entry.c
+++ b/gspell/gspell-entry.c
@@ -88,6 +88,19 @@ G_DEFINE_TYPE (GspellEntry, gspell_entry, G_TYPE_OBJECT)
 static gboolean
 inline_spell_checking_is_enabled (GspellEntry *gspell_entry)
 {
+       /* The GtkEntry:input-purpose and/or GtkEntry:input-hints could be taken
+        * into account here, but it is not the case. There is already the
+        * GspellEntry:inline-spell-checking property, which needs to be FALSE
+        * by default. If it was TRUE by default, an application would just need
+        * to call gspell_entry_get_from_gtk_entry(), but it would be strange to
+        * do nothing with the returned GspellEntry. So inline-spell-checking is
+        * FALSE by default and the application anyway needs to set it to TRUE
+        * manually to enable the *inline* spell checking (a GtkEntry could have
+        * other types of spell checking, for example based on GspellNavigator
+        * to check an entire form or check a list of forms, even though such
+        * feature is probably rare).
+        */
+
        return (gspell_entry->inline_spell_checking &&
                gtk_entry_get_visibility (gspell_entry->entry));
 }