[gtksourceview] Fix some gtkdoc issues



commit 04c7c9822d88b29b93159f6f7a13d287aa2c430f
Author: Paolo Borelli <pborelli gnome org>
Date:   Mon Apr 16 14:09:42 2012 +0200

    Fix some gtkdoc issues

 gtksourceview/gtksourcebuffer.c          |    5 +++--
 gtksourceview/gtksourcecompletionutils.c |    7 ++++---
 gtksourceview/gtksourcecontextengine.c   |    9 ---------
 gtksourceview/gtksourcestylescheme.c     |    6 +++---
 gtksourceview/gtksourceview.c            |    4 ++--
 5 files changed, 12 insertions(+), 19 deletions(-)
---
diff --git a/gtksourceview/gtksourcebuffer.c b/gtksourceview/gtksourcebuffer.c
index 306664b..d26a22f 100644
--- a/gtksourceview/gtksourcebuffer.c
+++ b/gtksourceview/gtksourcebuffer.c
@@ -329,8 +329,9 @@ gtk_source_buffer_class_init (GtkSourceBufferClass *klass)
 			   _gtksourceview_marshal_VOID__BOXED_BOXED,
 			   G_TYPE_NONE,
 			   2, param_types);
+
 	/**
-	 * GtkSourceBuffer::source-mark-updated
+	 * GtkSourceBuffer::source-mark-updated:
 	 * @buffer: the buffer that received the signal
 	 *
 	 * The ::source_mark_updated signal is emitted each time
@@ -367,7 +368,7 @@ gtk_source_buffer_class_init (GtkSourceBufferClass *klass)
 			  0);
 
 	/**
-	 * GtkSourceBuffer::bracket-matched
+	 * GtkSourceBuffer::bracket-matched:
 	 * @buffer: a #GtkSourceBuffer.
 	 * @iter: iterator to initialize.
 	 * @state: state of bracket matching
diff --git a/gtksourceview/gtksourcecompletionutils.c b/gtksourceview/gtksourcecompletionutils.c
index 1ce75f0..0cd0ecb 100644
--- a/gtksourceview/gtksourcecompletionutils.c
+++ b/gtksourceview/gtksourcecompletionutils.c
@@ -47,14 +47,15 @@ gtk_source_completion_utils_is_separator (const gunichar ch)
  * gtk_source_completion_utils_get_word_iter:
  *
  * @source_buffer: a #GtkSourceBuffer.
- * @start_word: (allow-none): if != NULL then assign it the start position of the word
- * @end_word: (allow-none): if != NULL then assing it the end position of the word
+ * @current: (allow-none): the iter of the position to consider, or %NULL to use the current insert position
+ * @start_word: (allow-none): if not %NULL then assign it the start position of the word
+ * @end_word: (allow-none): if not %NULL then assing it the end position of the word
  *
  * Returns: the current word.
  */
 gchar *
 gtk_source_completion_utils_get_word_iter (GtkSourceBuffer *source_buffer,
-                                           GtkTextIter     *current,
+					   GtkTextIter     *current,
 					   GtkTextIter     *start_word,
 					   GtkTextIter     *end_word)
 {
diff --git a/gtksourceview/gtksourcecontextengine.c b/gtksourceview/gtksourcecontextengine.c
index d8caf67..5b4941e 100644
--- a/gtksourceview/gtksourcecontextengine.c
+++ b/gtksourceview/gtksourcecontextengine.c
@@ -861,15 +861,6 @@ apply_tags (GtkSourceContextEngine *ce,
 	}
 }
 
-/**
- * highlight_region:
- *
- * @ce: a #GtkSourceContextEngine.
- * @start: the beginning of the region to highlight.
- * @end: the end of the region to highlight.
- *
- * Highlights the specified region.
- */
 static void
 highlight_region (GtkSourceContextEngine *ce,
 		  GtkTextIter            *start,
diff --git a/gtksourceview/gtksourcestylescheme.c b/gtksourceview/gtksourcestylescheme.c
index a04fc91..1e06da2 100644
--- a/gtksourceview/gtksourcestylescheme.c
+++ b/gtksourceview/gtksourcestylescheme.c
@@ -228,9 +228,9 @@ gtk_source_style_scheme_class_init (GtkSourceStyleSchemeClass *klass)
 							      G_PARAM_READABLE));
 
 	/**
-	 * GtkSourceStyleScheme:name:
+	 * GtkSourceStyleScheme:description:
 	 *
-	 * Style scheme name, a translatable string to present to user.
+	 * Style scheme description, a translatable string to present to user.
 	 */
 	g_object_class_install_property (object_class,
 					 PROP_DESCRIPTION,
@@ -243,7 +243,7 @@ gtk_source_style_scheme_class_init (GtkSourceStyleSchemeClass *klass)
 	/**
 	 * GtkSourceStyleScheme:filename:
 	 *
-	 * Style scheme filename or NULL.
+	 * Style scheme filename or %NULL.
 	 */
 	g_object_class_install_property (object_class,
 					 PROP_FILENAME,
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index eb72383..e934bdf 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -296,9 +296,9 @@ gtk_source_view_class_init (GtkSourceViewClass *klass)
 	klass->move_words = gtk_source_view_move_words;
 
 	/**
-	 * GtkSourceView:show-line-numbers:
+	 * GtkSourceView:completion:
 	 *
-	 * Whether to display line numbers
+	 * The completion object associated with the view
 	 */
 	g_object_class_install_property (object_class,
 					 PROP_COMPLETION,



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