Attachment 47374 Details for Bug 10890 – [PATCH 1/3] Remove Doxygen droppings from source code

[patch] [PATCH 1/3] Remove Doxygen droppings from source code

0001-Remove-Doxygen-droppings-from-source-code.patch (text/plain), 7.88 KB, created by Simon McVittie on 2011-05-31 07:33:13 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2011-05-31 07:33:13 UTC

Size: 7.88 KB

patch

obsolete

>From 7f98b6a54cfaf9a33be9e16e6af4a90ce74d1681 Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Tue, 31 May 2011 15:27:59 +0100
>Subject: [PATCH 1/3] Remove Doxygen droppings from source code
>
>---
> dbus/dbus-gidl.c      |    8 +-------
> dbus/dbus-gidl.h      |    4 ----
> dbus/dbus-glib-tool.c |    3 +--
> dbus/dbus-glib.c      |    3 +--
> dbus/dbus-gmain.c     |   22 +++-------------------
> dbus/dbus-gobject.c   |    3 +--
> dbus/dbus-gparser.c   |    4 ----
> dbus/dbus-gproxy.c    |   29 +++--------------------------
> dbus/dbus-gthread.c   |    6 ------
> dbus/dbus-gutils.c    |    7 +------
> dbus/dbus-gutils.h    |    4 ----
> dbus/dbus-gvalue.c    |    5 +----
> 12 files changed, 12 insertions(+), 86 deletions(-)
>
>diff --git a/dbus/dbus-gidl.c b/dbus/dbus-gidl.c
>index 5d50ee7..3b17222 100644
>--- a/dbus/dbus-gidl.c
>+++ b/dbus/dbus-gidl.c
>@@ -26,8 +26,6 @@
> 
> #include "dbus-gidl.h"
> 
>-#ifndef DOXYGEN_SHOULD_SKIP_THIS
>-
> struct BaseInfo
> {
>   unsigned int refcount : 28;
>@@ -770,11 +768,9 @@ arg_info_add_annotation (ArgInfo             *info,
> 		       g_strdup (value));
> }
> 
>-
> #ifdef DBUS_BUILD_TESTS
> 
>-/**
>- * @ingroup DBusGIDL
>+/*
>  * Unit test for GLib IDL internals
>  * Returns: #TRUE on success.
>  */
>@@ -786,5 +782,3 @@ _dbus_gidl_test (void)
> }
> 
> #endif /* DBUS_BUILD_TESTS */
>-
>-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
>diff --git a/dbus/dbus-gidl.h b/dbus/dbus-gidl.h
>index b766bcb..d9837ce 100644
>--- a/dbus/dbus-gidl.h
>+++ b/dbus/dbus-gidl.h
>@@ -24,8 +24,6 @@
> #ifndef DBUS_GLIB_IDL_H
> #define DBUS_GLIB_IDL_H
> 
>-#ifndef DOXYGEN_SHOULD_SKIP_THIS
>-
> #include <dbus/dbus.h>
> #include <glib-object.h>
> 
>@@ -154,5 +152,3 @@ void                arg_info_add_annotation       (ArgInfo             *info,
> G_END_DECLS
> 
> #endif /* DBUS_GLIB_IDL_H */
>-
>-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
>diff --git a/dbus/dbus-glib-tool.c b/dbus/dbus-glib-tool.c
>index 8f2019f..c40d6ee 100644
>--- a/dbus/dbus-glib-tool.c
>+++ b/dbus/dbus-glib-tool.c
>@@ -463,8 +463,7 @@ test_die (const char *failure)
>   lose ("Unit test failed: %s", failure);
> }
> 
>-/**
>- * @ingroup DBusGTool
>+/*
>  * Unit test for GLib utility tool
>  * Returns: #TRUE on success.
>  */
>diff --git a/dbus/dbus-glib.c b/dbus/dbus-glib.c
>index a6a717f..40ec23c 100644
>--- a/dbus/dbus-glib.c
>+++ b/dbus/dbus-glib.c
>@@ -349,8 +349,7 @@ dbus_g_message_get_message (DBusGMessage *gmessage)
> 
> #ifdef DBUS_BUILD_TESTS
> 
>-/**
>- * @ingroup DBusGLibInternals
>+/*
>  * Unit test for general glib stuff
>  * Returns: #TRUE on success.
>  */
>diff --git a/dbus/dbus-gmain.c b/dbus/dbus-gmain.c
>index 5109bc8..9135a07 100644
>--- a/dbus/dbus-gmain.c
>+++ b/dbus/dbus-gmain.c
>@@ -37,16 +37,9 @@
> #define _(x) dgettext (GETTEXT_PACKAGE, x)
> #define N_(x) x
> 
>-/**
>- * @defgroup DBusGLibInternals GLib bindings implementation details
>- * @ingroup  DBusInternals
>- * @brief Implementation details of GLib bindings
>- *
>- * @{
>- */
>-
>-/**
>+/*
>  * DBusGMessageQueue:
>+ *
>  * A GSource subclass for dispatching DBusConnection messages.
>  * We need this on top of the IO handlers, because sometimes
>  * there are messages to dispatch queued up but no IO pending.
>@@ -524,12 +517,6 @@ connection_setup_new_from_old (GMainContext    *context,
>   return cs;
> }
> 
>-/** @} */ /* End of GLib bindings internals */
>-
>-/** @addtogroup DBusGLib
>- * @{
>- */
>-
> /**
>  * dbus_connection_setup_with_g_main:
>  * @connection: the connection
>@@ -804,12 +791,9 @@ dbus_g_bus_get_private (DBusBusType     type,
>   return DBUS_G_CONNECTION_FROM_CONNECTION (connection);
> }
> 
>-/** @} */ /* end of public API */
>-
> #ifdef DBUS_BUILD_TESTS
> 
>-/**
>- * @ingroup DBusGLibInternals
>+/*
>  * Unit test for GLib main loop integration
>  * Returns: #TRUE on success.
>  */
>diff --git a/dbus/dbus-gobject.c b/dbus/dbus-gobject.c
>index 20c0bba..cbbaa43 100644
>--- a/dbus/dbus-gobject.c
>+++ b/dbus/dbus-gobject.c
>@@ -3112,8 +3112,7 @@ const DBusGObjectInfo dbus_glib_internal_test_object_info = {
> };
> 
> 
>-/**
>- * @ingroup DBusGLibInternals
>+/*
>  * Unit test for GLib GObject integration ("skeletons")
>  * Returns: #TRUE on success.
>  */
>diff --git a/dbus/dbus-gparser.c b/dbus/dbus-gparser.c
>index d9f8349..c7a643d 100644
>--- a/dbus/dbus-gparser.c
>+++ b/dbus/dbus-gparser.c
>@@ -34,8 +34,6 @@
> #define _(x) gettext ((x))
> #define N_(x) x
> 
>-#ifndef DOXYGEN_SHOULD_SKIP_THIS
>-
> #define ELEMENT_IS(name) (strcmp (element_name, (name)) == 0)
> 
> typedef struct
>@@ -904,5 +902,3 @@ parser_get_nodes (Parser *parser)
> {
>   return parser->result;
> }
>-
>-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
>diff --git a/dbus/dbus-gproxy.c b/dbus/dbus-gproxy.c
>index 11c427d..1c9a481 100644
>--- a/dbus/dbus-gproxy.c
>+++ b/dbus/dbus-gproxy.c
>@@ -49,23 +49,10 @@ oom (void)
>   g_error ("no memory");
> }
> 
>-/**
>- * @addtogroup DBusGLibInternals
>- *
>- * @{
>- */
>-
>-/**
>- * DBusGProxyManager typedef
>- */
>-
> typedef struct _DBusGProxyManager DBusGProxyManager;
> 
> typedef struct _DBusGProxyPrivate DBusGProxyPrivate;
> 
>-/**
>- * Internals of DBusGProxy
>- */
> struct _DBusGProxyPrivate
> {
>   DBusGProxyManager *manager; /**< Proxy manager */
>@@ -127,7 +114,7 @@ static gboolean dbus_g_proxy_end_call_internal (DBusGProxy        *proxy,
> 						GType              first_arg_type,
> 						va_list            args);
> 
>-/**
>+/*
>  * A list of proxies with a given name+path+interface, used to
>  * route incoming signals.
>  */
>@@ -142,7 +129,7 @@ typedef struct
>   
> } DBusGProxyList;
> 
>-/**
>+/*
>  * DBusGProxyManager's primary task is to route signals to the proxies
>  * those signals are emitted on. In order to do this it also has to
>  * track the owners of the names proxies are bound to.
>@@ -1905,12 +1892,6 @@ manager_begin_bus_call (DBusGProxyManager    *manager,
>   return call;
> }
> 
>-/** @} End of DBusGLibInternals */
>-
>-/** @addtogroup DBusGLib
>- * @{
>- */
>-
> /**
>  * SECTION:dbus-gproxy
>  * @short_description: DBus Proxy
>@@ -3134,13 +3115,9 @@ dbus_g_proxy_set_default_timeout (DBusGProxy        *proxy,
>   priv->default_timeout = timeout;
> }
> 
>-
>-/** @} End of DBusGLib public */
>-
> #ifdef DBUS_BUILD_TESTS
> 
>-/**
>- * @ingroup DBusGLibInternals
>+/*
>  * Unit test for GLib proxy functions
>  * Returns: #TRUE on success.
>  */
>diff --git a/dbus/dbus-gthread.c b/dbus/dbus-gthread.c
>index 6d430ef..4342864 100644
>--- a/dbus/dbus-gthread.c
>+++ b/dbus/dbus-gthread.c
>@@ -29,10 +29,6 @@
> #include <dbus/dbus.h>
> #include "dbus-glib.h"
> 
>-/** @addtogroup DBusGLib
>- * @{
>- */
>-
> /**
>  * dbus_g_thread_init:
>  *
>@@ -49,5 +45,3 @@ dbus_g_thread_init (void)
> 
>   dbus_threads_init_default ();
> }
>-
>-/** @} end of public API */
>diff --git a/dbus/dbus-gutils.c b/dbus/dbus-gutils.c
>index e882282..c09d61c 100644
>--- a/dbus/dbus-gutils.c
>+++ b/dbus/dbus-gutils.c
>@@ -26,8 +26,6 @@
> #include "dbus-gtest.h"
> #include <string.h>
> 
>-#ifndef DOXYGEN_SHOULD_SKIP_THIS
>-
> char**
> _dbus_gutils_split_path (const char *path)
> {
>@@ -113,8 +111,7 @@ _dbus_gutils_wincaps_to_uscore (const char *caps)
> 
> #ifdef DBUS_BUILD_TESTS
> 
>-/**
>- * @ingroup DBusGLibInternals
>+/*
>  * Unit test for GLib utils internals
>  * Returns: #TRUE on success.
>  */
>@@ -126,5 +123,3 @@ _dbus_gutils_test (const char *test_data_dir)
> }
> 
> #endif /* DBUS_BUILD_TESTS */
>-
>-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
>diff --git a/dbus/dbus-gutils.h b/dbus/dbus-gutils.h
>index d56c07d..8468a55 100644
>--- a/dbus/dbus-gutils.h
>+++ b/dbus/dbus-gutils.h
>@@ -24,8 +24,6 @@
> #ifndef DBUS_GLIB_UTILS_H
> #define DBUS_GLIB_UTILS_H
> 
>-#ifndef DOXYGEN_SHOULD_SKIP_THIS
>-
> #include <dbus/dbus.h>
> #include <glib-object.h>
> 
>@@ -53,5 +51,3 @@ char       *_dbus_gutils_wincaps_to_uscore (const char *uscore);
> G_END_DECLS
> 
> #endif /* DBUS_GLIB_UTILS_H */
>-
>-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
>diff --git a/dbus/dbus-gvalue.c b/dbus/dbus-gvalue.c
>index e154da4..771dfd2 100644
>--- a/dbus/dbus-gvalue.c
>+++ b/dbus/dbus-gvalue.c
>@@ -2026,10 +2026,7 @@ assert_bidirectional_mapping (GType gtype, const char *expected_sig)
>   assert_signature_maps_to (expected_sig, gtype);
> }
> 
>-/**
>- * @ingroup DBusGLibInternals
>- * @test_data_dir:
>- *
>+/*
>  * Unit test for general glib stuff
>  * Returns: #TRUE on success.
>  */
>-- 
>1.7.5.3
>

Actions: View | Splinter Review

Attachments on bug 10890: 41840 | 47374 | 47375 | 47376

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.