[gspell] docs: a few minor improvements
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gspell] docs: a few minor improvements
- Date: Sat, 16 Jan 2016 17:58:58 +0000 (UTC)
commit 0e53a349fd74d31e4e5b986390e2a3a78c25af81
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sat Jan 16 18:35:10 2016 +0100
docs: a few minor improvements
gspell/gspell-checker.c | 4 ++--
gspell/gspell-inline-checker-text.c | 6 +++---
gspell/gspell-language-chooser-dialog.c | 5 +++--
gspell/gspell-language-chooser.c | 2 +-
gspell/gspell-text-buffer.c | 4 +++-
5 files changed, 12 insertions(+), 9 deletions(-)
---
diff --git a/gspell/gspell-checker.c b/gspell/gspell-checker.c
index df92492..983ac23 100644
--- a/gspell/gspell-checker.c
+++ b/gspell/gspell-checker.c
@@ -344,7 +344,7 @@ gspell_checker_get_language (GspellChecker *checker)
* If the #GspellChecker:language is %NULL, i.e. when no dictonaries are
* available, this function returns %TRUE to limit the damage.
*
- * Returns: whether @word is correctly spelled.
+ * Returns: %TRUE if @word is correctly spelled, %FALSE otherwise.
*/
gboolean
gspell_checker_check_word (GspellChecker *checker,
@@ -457,7 +457,7 @@ gspell_checker_get_suggestions (GspellChecker *checker,
* @word: a word.
* @word_length: the byte length of @word, or -1 if @word is nul-terminated.
*
- * Adds a word to the personal dictionary. It is typically saved in the user
+ * Adds a word to the personal dictionary. It is typically saved in the user's
* home directory.
*/
void
diff --git a/gspell/gspell-inline-checker-text.c b/gspell/gspell-inline-checker-text.c
index 907c3f5..96ab6a0 100644
--- a/gspell/gspell-inline-checker-text.c
+++ b/gspell/gspell-inline-checker-text.c
@@ -237,7 +237,7 @@ gspell_inline_checker_text_class_init (GspellInlineCheckerTextClass *klass)
/**
* GspellInlineCheckerText:enabled:
*
- * Whether the inline spell checking is enabled.
+ * Whether the inline spell checker is enabled.
*/
g_object_class_install_property (object_class,
PROP_ENABLED,
@@ -292,7 +292,7 @@ gspell_text_view_get_inline_checker (GtkTextView *view)
* @inline_checker: a #GspellInlineCheckerText.
* @enabled: the new state.
*
- * Enables or disables the inline spell checking.
+ * Enables or disables the inline spell checker.
*/
void
gspell_inline_checker_text_set_enabled (GspellInlineCheckerText *inline_checker,
@@ -323,7 +323,7 @@ gspell_inline_checker_text_set_enabled (GspellInlineCheckerText *inline_checker,
* gspell_inline_checker_text_get_enabled:
* @inline_checker: a #GspellInlineCheckerText.
*
- * Returns: whether the inline spell checking is enabled.
+ * Returns: whether the inline spell checker is enabled.
*/
gboolean
gspell_inline_checker_text_get_enabled (GspellInlineCheckerText *inline_checker)
diff --git a/gspell/gspell-language-chooser-dialog.c b/gspell/gspell-language-chooser-dialog.c
index 819cb42..d0b228f 100644
--- a/gspell/gspell-language-chooser-dialog.c
+++ b/gspell/gspell-language-chooser-dialog.c
@@ -31,8 +31,9 @@
* #GspellLanguage. #GspellLanguageChooserDialog implements the
* #GspellLanguageChooser interface.
*
- * The #GspellLanguageChooser:language property is updated only when the Select
- * button is pressed or when a row is activated (e.g. with a double-click).
+ * The #GspellLanguageChooser:language and #GspellLanguageChooser:language-code
+ * properties are updated only when the Select button is pressed or when a row
+ * is activated (e.g. with a double-click).
*
* The application is responsible to destroy the dialog, typically when the
* #GtkDialog::response signal has been received or gtk_dialog_run() has
diff --git a/gspell/gspell-language-chooser.c b/gspell/gspell-language-chooser.c
index 2a5644c..2873ff9 100644
--- a/gspell/gspell-language-chooser.c
+++ b/gspell/gspell-language-chooser.c
@@ -49,7 +49,7 @@
* language, even if the language is the same as the default language.
*
* Thus, a good default value for a #GSettings key is the empty string. That
- * way, the default language is chosen, and can change depending on the locale.
+ * way, the default language is picked, and can change depending on the locale.
* But once the user has chosen a language, that language is kept in the
* #GSettings key.
*/
diff --git a/gspell/gspell-text-buffer.c b/gspell/gspell-text-buffer.c
index 5e19e10..f03505d 100644
--- a/gspell/gspell-text-buffer.c
+++ b/gspell/gspell-text-buffer.c
@@ -35,7 +35,9 @@
* @buffer: a #GtkTextBuffer.
* @checker: (nullable): a #GspellChecker, or %NULL to unset the spell checker.
*
- * Associates a spell checker to a #GtkTextBuffer.
+ * Associates a spell checker to a #GtkTextBuffer. The @buffer will own a
+ * reference to @checker, so you can release your reference to @checker if you
+ * no longer need it.
*/
void
gspell_text_buffer_set_spell_checker (GtkTextBuffer *buffer,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]