[glib] Fix malformed GTK-Doc comment blocks: invalid parameters and tags.



commit 0183c1f8a158834e5bfb601d4a207a8cff0b2b62
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date:   Tue Apr 3 20:17:00 2012 +0200

    Fix malformed GTK-Doc comment blocks: invalid parameters and tags.
    
    Found these thanks to the improved gobject-introspection
    GTK-Doc comment block/annotation parser.
    See https://bugzilla.gnome.org/show_bug.cgi?id=672254
    
    https://bugzilla.gnome.org/show_bug.cgi?id=673385

 gio/gremoteactiongroup.c |    2 +-
 glib/gasyncqueue.c       |    4 ++--
 glib/gmem.c              |    1 -
 gobject/gtype.c          |    2 +-
 4 files changed, 4 insertions(+), 5 deletions(-)
---
diff --git a/gio/gremoteactiongroup.c b/gio/gremoteactiongroup.c
index 9f1ee9a..1b6f342 100644
--- a/gio/gremoteactiongroup.c
+++ b/gio/gremoteactiongroup.c
@@ -81,7 +81,7 @@ g_remote_action_group_default_init (GRemoteActionGroupInterface *iface)
  * g_remote_action_group_activate_action_full:
  * @remote: a #GDBusActionGroup
  * @action_name: the name of the action to activate
- * @parameter: (allow none): the optional parameter to the activation
+ * @parameter: (allow-none): the optional parameter to the activation
  * @platform_data: the platform data to send
  *
  * Activates the remote action.
diff --git a/glib/gasyncqueue.c b/glib/gasyncqueue.c
index 31976bc..075266f 100644
--- a/glib/gasyncqueue.c
+++ b/glib/gasyncqueue.c
@@ -176,7 +176,7 @@ g_async_queue_ref (GAsyncQueue *queue)
  *
  * Increases the reference count of the asynchronous @queue by 1.
  *
- * @Deprecated: Since 2.8, reference counting is done atomically
+ * Deprecated: 2.8: Reference counting is done atomically.
  * so g_async_queue_ref() can be used regardless of the @queue's
  * lock.
  */
@@ -197,7 +197,7 @@ g_async_queue_ref_unlocked (GAsyncQueue *queue)
  * the @queue's lock. If the reference count went to 0, the @queue
  * will be destroyed and the memory allocated will be freed.
  *
- * @Deprecated: Since 2.8, reference counting is done atomically
+ * Deprecated: 2.8: Reference counting is done atomically.
  * so g_async_queue_unref() can be used regardless of the @queue's
  * lock.
  */
diff --git a/glib/gmem.c b/glib/gmem.c
index afb94c1..1f01cd1 100644
--- a/glib/gmem.c
+++ b/glib/gmem.c
@@ -659,7 +659,6 @@ profile_print_locked (guint   *local_data,
 
 /**
  * g_mem_profile:
- * @void:
  * 
  * Outputs a summary of memory usage.
  * 
diff --git a/gobject/gtype.c b/gobject/gtype.c
index d78a897..43fdbc6 100644
--- a/gobject/gtype.c
+++ b/gobject/gtype.c
@@ -4058,7 +4058,7 @@ g_type_check_class_cast (GTypeClass *type_class,
  * Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
  * macro.
  *
- * @Returns:  #TRUE if @instance is valid, #FALSE otherwise.
+ * Returns: %TRUE if @instance is valid, %FALSE otherwise.
  */
 gboolean
 g_type_check_instance (GTypeInstance *type_instance)



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