[gtksourceview] Fix gtk-doc warnings
- From: Paolo Borelli <pborelli src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtksourceview] Fix gtk-doc warnings
- Date: Sun, 3 Jan 2010 20:44:14 +0000 (UTC)
commit 8bf253d276221d8c39ed0175823e445f152bf8ff
Author: Paolo Borelli <pborelli gnome org>
Date: Sun Jan 3 21:43:19 2010 +0100
Fix gtk-doc warnings
gtksourceview/gtksourcecompletion.c | 9 ++++-----
gtksourceview/gtksourcecompletioninfo.c | 9 +++++----
gtksourceview/gtksourcecompletionproposal.c | 6 +++---
gtksourceview/gtksourcecompletionprovider.c | 8 ++++----
gtksourceview/gtksourcecompletionutils.c | 21 ++++++---------------
5 files changed, 22 insertions(+), 31 deletions(-)
---
diff --git a/gtksourceview/gtksourcecompletion.c b/gtksourceview/gtksourcecompletion.c
index f9c3fd0..2fd4dce 100644
--- a/gtksourceview/gtksourcecompletion.c
+++ b/gtksourceview/gtksourcecompletion.c
@@ -1,5 +1,5 @@
-/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; coding: utf-8 -*-
- * gtksourcecompletion.c
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; coding: utf-8 -*- */
+/* gtksourcecompletion.c
* This file is part of gtksourcecompletion
*
* Copyright (C) 2007 -2009 Jesús Barbero RodrÃguez <chuchiperriman gmail com>
@@ -19,13 +19,12 @@
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
-
+
/**
- * SECTION:gtksourcecompletion
+ * SECTION:completion
* @title: GtkSourceCompletion
* @short_description: Main Completion Object
*
- * TODO
*/
#include <gdk/gdkkeysyms.h>
diff --git a/gtksourceview/gtksourcecompletioninfo.c b/gtksourceview/gtksourcecompletioninfo.c
index d68112b..2224622 100644
--- a/gtksourceview/gtksourcecompletioninfo.c
+++ b/gtksourceview/gtksourcecompletioninfo.c
@@ -1,5 +1,5 @@
-/*
- * gtksourcecompletioninfo.c
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; coding: utf-8 -*- */
+/* gtksourcecompletioninfo.c
* This file is part of gtksourcecompletion
*
* Copyright (C) 2007 -2009 Jesús Barbero RodrÃguez <chuchiperriman gmail com>
@@ -21,11 +21,12 @@
*/
/**
- * SECTION:gsc-info
+ * SECTION:completioninfo
* @title: GtkSourceCompletionInfo
* @short_description: Calltips object
*
- * This object can be used to show a calltip or help.
+ * This object can be used to show a calltip or help for the
+.* current completion proposal.
*/
#include <gtksourceview/gtksourcecompletioninfo.h>
diff --git a/gtksourceview/gtksourcecompletionproposal.c b/gtksourceview/gtksourcecompletionproposal.c
index 6f606f1..796eef5 100644
--- a/gtksourceview/gtksourcecompletionproposal.c
+++ b/gtksourceview/gtksourcecompletionproposal.c
@@ -1,5 +1,5 @@
-/*
- * gtksourcecompletionproposal.c
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; coding: utf-8 -*- */
+/* gtksourcecompletionproposal.c
* This file is part of gtksourcecompletion
*
* Copyright (C) 2007 - 2009 Jesús Barbero RodrÃguez <chuchiperriman gmail com>
@@ -21,7 +21,7 @@
*/
/**
- * SECTION:gtksourcecompletionproposal
+ * SECTION:completionproposal
* @title: GtkSourceCompletionProposal
* @short_description: Completion proposal object
*
diff --git a/gtksourceview/gtksourcecompletionprovider.c b/gtksourceview/gtksourcecompletionprovider.c
index 927776a..471f87f 100644
--- a/gtksourceview/gtksourcecompletionprovider.c
+++ b/gtksourceview/gtksourcecompletionprovider.c
@@ -1,5 +1,5 @@
-/*
- * gtksourcecompletionprovider.c
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; coding: utf-8 -*- */
+/* gtksourcecompletionprovider.c
* This file is part of gtksourcecompletion
*
* Copyright (C) 2007 -2009 Jesús Barbero RodrÃguez <chuchiperriman gmail com>
@@ -22,11 +22,11 @@
/**
- * SECTION:gtk_source_completion-provider
+ * SECTION:completionprovider
* @title: GtkSourceCompletionProvider
* @short_description: Completion provider interface
*
- * You must implement this interface to provide proposals to #GscCompletion
+ * You must implement this interface to provide proposals to #GtkSourceCompletion
*
*/
diff --git a/gtksourceview/gtksourcecompletionutils.c b/gtksourceview/gtksourcecompletionutils.c
index 0fc96f3..e43c934 100644
--- a/gtksourceview/gtksourcecompletionutils.c
+++ b/gtksourceview/gtksourcecompletionutils.c
@@ -1,5 +1,5 @@
-/*
- * gtksourcecompletionutils.c
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; coding: utf-8 -*- */
+/* gtksourcecompletionutils.c
* This file is part of gtksourcecompletion
*
* Copyright (C) 2007 -2009 Jesús Barbero RodrÃguez <chuchiperriman gmail com>
@@ -20,26 +20,19 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
-/**
- * SECTION:gsc-utils
- * @title: Gsc Utils
- * @short_description: Useful functions
- *
- */
-
#include <string.h>
#include "gtksourcecompletionutils.h"
/**
- * gsc_utils_char_is_separator:
+ * gtk_source_completion_utils_is_separator:
* @ch: The character to check
*
* A separator is a character like (, an space etc. An _ is not a separator
*
- * Returns TRUE if the ch is a separator
+ * Returns: TRUE if @ch is a separator
*/
gboolean
-gtk_source_completion_utils_is_separator(const gunichar ch)
+gtk_source_completion_utils_is_separator (const gunichar ch)
{
if (g_unichar_isprint(ch) &&
(g_unichar_isalnum(ch) || ch == g_utf8_get_char("_")))
@@ -58,7 +51,6 @@ gtk_source_completion_utils_is_separator(const gunichar ch)
* @end_word: if != 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,
@@ -191,12 +183,11 @@ gtk_source_completion_utils_replace_word (GtkSourceBuffer *source_buffer,
}
/**
- * gsc_utils_view_replace_current_word:
+ * gtk_source_completion_utils_replace_current_word:
* @source_buffer: The #GtkSourceBuffer
* @text: The text to be inserted instead of the current word
*
* Replaces the current word in the #GtkSourceBuffer with the new word
- *
*/
void
gtk_source_completion_utils_replace_current_word (GtkSourceBuffer *source_buffer,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]