[gspell] docs: the use of Enchant is not part of the API



commit 07c2cc6d6b84496d501bc188b44a68a44668b931
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Thu Dec 22 18:09:13 2016 +0100

    docs: the use of Enchant is not part of the API

 gspell/gspell-checker.c |    8 ++++++--
 1 files changed, 6 insertions(+), 2 deletions(-)
---
diff --git a/gspell/gspell-checker.c b/gspell/gspell-checker.c
index d501d50..eac450b 100644
--- a/gspell/gspell-checker.c
+++ b/gspell/gspell-checker.c
@@ -36,14 +36,18 @@
  * @Title: GspellChecker
  * @See_also: #GspellLanguage
  *
- * #GspellChecker is a spell checker. It is a wrapper around the Enchant
- * library, to have an API based on #GObject.
+ * #GspellChecker is a spell checker.
  *
  * If the #GspellChecker:language property is %NULL, it means that no
  * dictonaries are available, in which case the #GspellChecker is in a
  * “disabled” (but allowed) state.
  */
 
+/* Enchant is currently used under the hood, but it is an implementation detail,
+ * it is *NOT* part of the gspell API. A future gspell version can be based on
+ * another library (e.g. using directly hunspell).
+ */
+
 typedef struct _GspellCheckerPrivate GspellCheckerPrivate;
 
 struct _GspellCheckerPrivate


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