GNOME.org
 

[anjuta] libanjuta: bgo #696984 - Add missing commas in documentation comments

commit 8bcaddca91599ac5fcb721e1c836a44a922751a4
Author: Arnel A. Borja <kyoushuu yahoo com>
Date:   Fri Mar 29 15:35:57 2013 +0800

    libanjuta: bgo #696984 - Add missing commas in documentation comments

 libanjuta/anjuta-command-bar.c       |    2 +-
 libanjuta/anjuta-dock-pane.c         |    8 ++--
 libanjuta/anjuta-entry.c             |    6 ++--
 libanjuta/anjuta-language-provider.c |    2 +-
 libanjuta/anjuta-launcher.c          |    4 +-
 libanjuta/anjuta-shell.h             |    2 +-
 libanjuta/anjuta-utils.h             |    2 +-
 libanjuta/interfaces/libanjuta.idl   |   57 ++++++++++++++++++----------------
 8 files changed, 43 insertions(+), 40 deletions(-)
---
diff --git a/libanjuta/anjuta-command-bar.c b/libanjuta/anjuta-command-bar.c
index 2d5542d..348d628 100644
--- a/libanjuta/anjuta-command-bar.c
+++ b/libanjuta/anjuta-command-bar.c
@@ -256,7 +256,7 @@ anjuta_command_bar_show_action_group (AnjutaCommandBar *self,
  * @self An AnjutaCommandBar
  * @group_name: The name of the action group
  *
- * Returns the #GtkActionGroup with the given @group_name
+ * Returns: The #GtkActionGroup with the given @group_name
  */
 GtkActionGroup *
 anjuta_command_bar_get_action_group (AnjutaCommandBar *self,
diff --git a/libanjuta/anjuta-dock-pane.c b/libanjuta/anjuta-dock-pane.c
index 204e972..af3e508 100644
--- a/libanjuta/anjuta-dock-pane.c
+++ b/libanjuta/anjuta-dock-pane.c
@@ -143,7 +143,7 @@ anjuta_dock_pane_class_init (AnjutaDockPaneClass *klass)
                                         param_spec);
 
        /** 
-        * AnjutaDockPane::single-selection-changed
+        * AnjutaDockPane::single-selection-changed:
         * @pane: An AnjutaDockPane
         *
         * This signal is emitted by pane subclasses to notify clients that
@@ -162,7 +162,7 @@ anjuta_dock_pane_class_init (AnjutaDockPaneClass *klass)
                              0);
 
        /**
-        * AnjutaDockPane::multiple-selection-changed
+        * AnjutaDockPane::multiple-selection-changed:
         * @pane: An AnjutaDockPane
         *
         * This signal is emitted by pane subclasses to notify clients that the set
@@ -203,7 +203,7 @@ anjuta_dock_pane_refresh (AnjutaDockPane *self)
  * anjuta_dock_pane_get_widget:
  * @self: An AnjutaDockPane
  *
- * Returns the widget associated with the given pane. The returned widget is 
+ * Returns: The widget associated with the given pane. The returned widget is
  * owned by the pane and should not be destroyed or modified.
  */
 GtkWidget *
@@ -217,7 +217,7 @@ anjuta_dock_pane_get_widget (AnjutaDockPane *self)
  * anjuta_dock_pane_get_plugin:
  * @self: An AnjutaDockPane
  *
- * Returns the plugin object associated with this pane. 
+ * Returns: The plugin object associated with this pane.
  */
 AnjutaPlugin *
 anjuta_dock_pane_get_plugin (AnjutaDockPane *self)
diff --git a/libanjuta/anjuta-entry.c b/libanjuta/anjuta-entry.c
index ceb408d..39a3795 100644
--- a/libanjuta/anjuta-entry.c
+++ b/libanjuta/anjuta-entry.c
@@ -255,7 +255,7 @@ anjuta_entry_new (void)
  * anjuta_entry_get_text:
  * @self: An AnjutaEntry
  *
- * Returns the contents of the entry. If the entry is empty, the help text will
+ * Returns: The contents of the entry. If the entry is empty, the help text will
  * be displayed and an empty string will be returned.
  */
 const gchar *
@@ -269,7 +269,7 @@ anjuta_entry_get_text (AnjutaEntry *self)
  * anjuta_entry_dup_text:
  * @self: An AnjutaEntry
  *
- * Returns a copy of the contents of the entry. If the entry is empty, the 
+ * Returns: A copy of the contents of the entry. If the entry is empty, the
  * returned string will be empty. The returned string must be freed when no
  * longer needed. 
  */
@@ -301,7 +301,7 @@ anjuta_entry_set_text (AnjutaEntry *self, const gchar *text)
  * anjuta_entry_is_showing_help_text:
  * @self: An AnjutaEntry
  * 
- * Returns whether the entry is showing its help text. In practice, if this
+ * Returns: Whether the entry is showing its help text. In practice, if this
  * method returns %TRUE, it means that the user has not entered anything.
  */
 gboolean
diff --git a/libanjuta/anjuta-language-provider.c b/libanjuta/anjuta-language-provider.c
index 3d06b60..d759953 100644
--- a/libanjuta/anjuta-language-provider.c
+++ b/libanjuta/anjuta-language-provider.c
@@ -179,7 +179,7 @@ anjuta_language_provider_is_character (gchar ch, const gchar* characters)
 }
 
 /**
- * anjuta_language_provider_get_scope_context
+ * anjuta_language_provider_get_scope_context:
  * @editor: (type GObject): current editor
  * @iter: Current cursor position
  * @scope_context_ch: language-specific context characters
diff --git a/libanjuta/anjuta-launcher.c b/libanjuta/anjuta-launcher.c
index b756f38..e7fde32 100644
--- a/libanjuta/anjuta-launcher.c
+++ b/libanjuta/anjuta-launcher.c
@@ -295,7 +295,7 @@ anjuta_launcher_class_init (AnjutaLauncherClass * klass)
        parent_class = g_type_class_peek_parent (klass);
 
        /**
-        * AnjutaLauncher::child-exited
+        * AnjutaLauncher::child-exited:
         * @launcher: a #AnjutaLancher object.
         * @child_pid: process ID of the child
         * @status: status as returned by waitpid function
@@ -319,7 +319,7 @@ anjuta_launcher_class_init (AnjutaLauncherClass * klass)
                                        G_TYPE_INT, G_TYPE_ULONG);
        
        /**
-        * AnjutaLauncher::busy
+        * AnjutaLauncher::busy:
         * @launcher: a #AnjutaLancher object.
         * @busy: TRUE is a child is currently running
         * 
diff --git a/libanjuta/anjuta-shell.h b/libanjuta/anjuta-shell.h
index d3258b2..3d39a70 100644
--- a/libanjuta/anjuta-shell.h
+++ b/libanjuta/anjuta-shell.h
@@ -45,7 +45,7 @@ typedef struct _AnjutaShell      AnjutaShell;
 typedef struct _AnjutaShellIface AnjutaShellIface;
 
 /**
- * AnjutaShellError_
+ * AnjutaShellError:
  * @ANJUTA_SHELL_ERROR_DOESNT_EXIST:
  */
 typedef enum
diff --git a/libanjuta/anjuta-utils.h b/libanjuta/anjuta-utils.h
index 66e7a61..8aa00cc 100644
--- a/libanjuta/anjuta-utils.h
+++ b/libanjuta/anjuta-utils.h
@@ -218,7 +218,7 @@ prefix##_get_type (void)                                  \
                                        &type_info, 0);
 
 /**
- * ANJUTA_TYPE_END
+ * ANJUTA_TYPE_END:
  *
  * Ends a declaration that began with ANJUTA_TYPE_BEGIN
  */
diff --git a/libanjuta/interfaces/libanjuta.idl b/libanjuta/interfaces/libanjuta.idl
index 828609a..e334656 100644
--- a/libanjuta/interfaces/libanjuta.idl
+++ b/libanjuta/interfaces/libanjuta.idl
@@ -674,7 +674,7 @@ interface IAnjutaBuilder
        typedef void (*Callback) (GObject *sender, IAnjutaBuilderHandle command, GError* err, gpointer 
user_data);
 
        /**
-       * IANJUTA_BUILDER_ROOT_URI
+       * IANJUTA_BUILDER_ROOT_URI:
        *
        * Build directory uri. It is the same than the project_root_uri for
        * in source build.
@@ -682,21 +682,21 @@ interface IAnjutaBuilder
        #define ROOT_URI                "build_root_uri"
 
        /**
-       * IANJUTA_BUILDER_CONFIGURATION_DEBUG
+       * IANJUTA_BUILDER_CONFIGURATION_DEBUG:
        *
        * Name of debugging configutation.
        */
        #define CONFIGURATION_DEBUG     "Debug"
 
        /**
-       * IANJUTA_BUILDER_CONFIGURATION_OPTIMIZED
+       * IANJUTA_BUILDER_CONFIGURATION_OPTIMIZED:
        *
        * Name of optimized configutation.
        */
        #define CONFIGURATION_OPTIMIZED "Optimized"
 
        /**
-       * IANJUTA_BUILDER_CONFIGURATION_PROFILING
+       * IANJUTA_BUILDER_CONFIGURATION_PROFILING:
        *
        * Name of profiling configutation.
        */
@@ -1264,28 +1264,28 @@ interface IAnjutaEditor
        #include <libanjuta/interfaces/ianjuta-iterable.h>
 
        /**
-       * IANJUTA_EDITOR_PREF_SCHEMA
+       * IANJUTA_EDITOR_PREF_SCHEMA:
        *
        * Schema id used to store common editor settings. 
        */
        #define PREF_SCHEMA     "editor"
 
        /**
-       * IANJUTA_EDITOR_USE_TABS_KEY
+       * IANJUTA_EDITOR_USE_TABS_KEY:
        *
        * Boolean key, true is tabs has to be used for indenting.
        */
        #define USE_TABS_KEY    "use-tabs"
 
        /**
-       * IANJUTA_EDITOR_TAB_WIDTH_KEY
+       * IANJUTA_EDITOR_TAB_WIDTH_KEY:
        *
        * Integer key, defines the size of a tabulation in spaces.
        */
        #define TAB_WIDTH_KEY   "tab-width"
 
        /**
-       * IANJUTA_EDITOR_INDENT_WIDTH_KEY
+       * IANJUTA_EDITOR_INDENT_WIDTH_KEY:
        *
        * Integer key, defines the number a space for one indentation step.
        */
@@ -2083,7 +2083,7 @@ interface IAnjutaEditor
                void show (List<const gchar*> tips, IAnjutaIterable *position);
 
                /**
-                * ianjuta_editor_tip_cancel
+                * ianjuta_editor_tip_cancel:
                 * @obj: Self
                 * @err: Error propagation and reporting
                 *
@@ -2125,7 +2125,7 @@ interface IAnjutaEditor
      }
 
     /**
-        * IAnjutaEditorAssist::cancelled
+        * IAnjutaEditorAssist::cancelled:
         * @obj: Self
         *
         * This signal is emitted when the autocompletion is cancelled due to various
@@ -2135,7 +2135,7 @@ interface IAnjutaEditor
         void   ::cancelled ();
 
      /*
-      * ianjuta_editor_assist_add
+      * ianjuta_editor_assist_add:
       * @obj: self
       * @provider: a IAnjutaProvider
       * @err: Error handling
@@ -2145,7 +2145,7 @@ interface IAnjutaEditor
       void add(IAnjutaProvider* provider);
 
      /*
-      * ianjuta_editor_assist_remove
+      * ianjuta_editor_assist_remove:
       * @obj: self
       * @provider: a IAnjutaProvider
       * @err: Error handling
@@ -2155,7 +2155,7 @@ interface IAnjutaEditor
       void remove(IAnjutaProvider* provider);
 
      /*
-      * ianjuta_editor_assist_invoke
+      * ianjuta_editor_assist_invoke:
       * @obj: self
       * @provider: a IAnjutaProvider (can be NULL to use all providers)
       * @err: Error handling
@@ -2207,6 +2207,7 @@ interface IAnjutaEditor
                void ::hover_over (IAnjutaIterable* position);
 
          /* IAnjutaEditorHover::hover-leave
+                * IAnjutaEditorHover::hover-leave:
                 * @obj: self
                 * @position: IAnjutaEditorCell specifying the position the mouse was over
                 *
@@ -2503,7 +2504,8 @@ interface IAnjutaEditor
         */
        interface IAnjutaEditorGladeSignal
        {
-               /* IAnjutaEditorGladeSignal::drop-possible
+               /**
+                * IAnjutaEditorGladeSignal::drop-possible:
                 * @obj: self
                 * @iter: a IAnjutaIterable of the position where drop would happen
                 *
@@ -2513,7 +2515,8 @@ interface IAnjutaEditor
                 */
                gboolean ::drop_possible (IAnjutaIterable* iterator);
 
-               /* IAnjutaEditorGladeSignal::drop
+               /**
+                * IAnjutaEditorGladeSignal::drop:
                 * @obj: self
                 * @iter: a IAnjutaIterable of the position where drop happens
                 * @signal_data: Signal data in form "widget:signal:handler", e.g.
@@ -2707,35 +2710,35 @@ interface IAnjutaProvider
                #include "ianjuta-symbol.h"
                
                /**
-                * IANJUTA_LANGUAGE_PROVIDER_PREF_CALLTIP_ENABLE
+                * IANJUTA_LANGUAGE_PROVIDER_PREF_CALLTIP_ENABLE:
                 *
                 * Boolean key, true is calltips has to be shown.
                 */
                 #define PREF_CALLTIP_ENABLE                      "calltip-enable"
                 
                /**
-                * IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_ENABLE
+                * IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_ENABLE:
                 *
                 * Boolean key, true is code completion is enable.
                 */
                 #define PREF_AUTOCOMPLETE_ENABLE                 "completion-enable"
                 
                /**
-                * IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_SPACE_AFTER_FUNC
+                * IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_SPACE_AFTER_FUNC:
                 *
                 * Boolean key, true is adding a space after function call autocompletion
                 */
                 #define PREF_AUTOCOMPLETE_SPACE_AFTER_FUNC       "completion-space-after-func"
                 
                /**
-                * IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_BRACE_AFTER_FUNC
+                * IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_BRACE_AFTER_FUNC:
                 *
                 * Boolean key, true is adding '(' after function call autocompletion
                 */
                 #define PREF_AUTOCOMPLETE_BRACE_AFTER_FUNC       "completion-brace-after-func"
                 
                /**
-                * IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_CLOSEBRACE_AFTER_FUNC
+                * IANJUTA_LANGUAGE_PROVIDER_PREF_AUTOCOMPLETE_CLOSEBRACE_AFTER_FUNC:
                 *
                 * Boolean key, true is adding ')' after function call autocompletion
                 */
@@ -2812,7 +2815,7 @@ interface IAnjutaDocumentManager
        #include <gio/gio.h>
 
        /**
-       * IANJUTA_DOCUMENT_MANAGER_CURRENT_DOCUMENT
+       * IANJUTA_DOCUMENT_MANAGER_CURRENT_DOCUMENT:
        *
        * Anjuta shell value set by document manager to the current document
        */
@@ -3246,7 +3249,7 @@ interface IAnjutaFileManager
        #include <gio/gio.h>
 
        /**
-       * IANJUTA_FILE_MANAGER_SELECTED_FILE
+       * IANJUTA_FILE_MANAGER_SELECTED_FILE:
        *
        * Anjuta shell value set by file manager to the selected file.
        */
@@ -3602,14 +3605,14 @@ interface IAnjutaProjectManager
        #include <libanjuta/interfaces/ianjuta-project.h>
 
        /**
-       * IANJUTA_PROJECT_MANAGER_PROJECT_ROOT_URI
+       * IANJUTA_PROJECT_MANAGER_PROJECT_ROOT_URI:
        *
        * Anjuta shell value set by project manager to the project root uri.
        */
        #define PROJECT_ROOT_URI        "project_root_uri"
 
        /**
-       * IANJUTA_PROJECT_MANAGER_CURRENT_PROJECT
+       * IANJUTA_PROJECT_MANAGER_CURRENT_PROJECT:
        *
        * Anjuta shell value set by project manager to the current project object
        * which implement #IAnjutaProject interface.
@@ -3617,7 +3620,7 @@ interface IAnjutaProjectManager
        #define CURRENT_PROJECT "project_manager_current_project"
 
        /**
-       * IANJUTA_PROJECT_MANAGER_CURRENT_URI
+       * IANJUTA_PROJECT_MANAGER_CURRENT_URI:
        *
        * Anjuta shell value set by project manager to the current uri.
        */
@@ -5750,7 +5753,7 @@ interface IAnjutaVcs
        }
 
        /**
-        * IAnjutaVcsStatus
+        * IAnjutaVcsStatus:
         * @obj: Self
         *
         * This signal is emited when the git pull command is finished, and refreshes the tree of files with 
the new pulled files without the need to
@@ -6790,7 +6793,7 @@ interface IAnjutaIndenter
   #include <libanjuta/interfaces/ianjuta-iterable.h>
 
        /**
-        * ianjuta_indenter_indent
+        * ianjuta_indenter_indent:
         * @obj: Self
         * @start: Start of the area to indent
         * @end: End of the area to indent
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]