[gspell/gspell-1-2] docs: the use of Enchant is not part of the API
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gspell/gspell-1-2] docs: the use of Enchant is not part of the API
- Date: Thu, 22 Dec 2016 17:12:17 +0000 (UTC)
commit 4c16fcd0707ef0649a79a076e4d91cd52660e2fb
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 2fbf8db..82f3766 100644
--- a/gspell/gspell-checker.c
+++ b/gspell/gspell-checker.c
@@ -35,14 +35,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]