[glib] Fix malformed GTK-Doc comment blocks: remove repeated comment blocks.
- From: Johan Dahlin <johan src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Fix malformed GTK-Doc comment blocks: remove repeated comment blocks.
- Date: Thu, 5 Apr 2012 13:29:06 +0000 (UTC)
commit 265526288958bfe576b02e4d3a2a5cf7d4ea60a5
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date: Tue Apr 3 13:20:01 2012 +0200
Fix malformed GTK-Doc comment blocks: remove repeated comment blocks.
gio/gproxyresolver.h: GProxyResolver already documented in gio/giotypes.h
gio/gtlsbackend.h: GTlsBackend already documented in gio/gtlsbackend.c
gio/gtlsclientconnection.h: GTlsClientConnection already documented in gio/gtlsclientconnection.c
gio/gtlsconnection.h: GTlsConnection already documented in gio/gtlsconnection.c
gio/gunixconnection.h: GTcpConnection already documented in gio/giotypes.h
glib/gversion.h: GLIB_CHECK_VERSION already documented in glib/gversion.c
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/gproxyresolver.h | 5 -----
gio/gtlsbackend.c | 5 +++--
gio/gtlsbackend.h | 10 ----------
gio/gtlsclientconnection.h | 8 --------
gio/gtlsconnection.h | 8 --------
gio/gunixconnection.h | 7 -------
glib/gversion.h | 22 ----------------------
7 files changed, 3 insertions(+), 62 deletions(-)
---
diff --git a/gio/gproxyresolver.h b/gio/gproxyresolver.h
index 391f902..7d8d27d 100644
--- a/gio/gproxyresolver.h
+++ b/gio/gproxyresolver.h
@@ -44,11 +44,6 @@ G_BEGIN_DECLS
*/
#define G_PROXY_RESOLVER_EXTENSION_POINT_NAME "gio-proxy-resolver"
-/**
- * GProxyResolver:
- *
- * Interface that can be used to resolve proxy address.
- */
typedef struct _GProxyResolverInterface GProxyResolverInterface;
struct _GProxyResolverInterface {
diff --git a/gio/gtlsbackend.c b/gio/gtlsbackend.c
index f99bc42..c77293d 100644
--- a/gio/gtlsbackend.c
+++ b/gio/gtlsbackend.c
@@ -67,8 +67,9 @@
/**
* GTlsBackend:
*
- * Type implemented by TLS #GIOModules to provide access to additional
- * TLS-related types.
+ * TLS (Transport Layer Security, aka SSL) backend. This is an
+ * internal type used to coordinate the different classes implemented
+ * by a TLS backend.
*
* Since: 2.28
*/
diff --git a/gio/gtlsbackend.h b/gio/gtlsbackend.h
index 089463f..389b5d7 100644
--- a/gio/gtlsbackend.h
+++ b/gio/gtlsbackend.h
@@ -42,16 +42,6 @@ G_BEGIN_DECLS
#define G_IS_TLS_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_TLS_BACKEND))
#define G_TLS_BACKEND_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_TLS_BACKEND, GTlsBackendInterface))
-/**
- * GTlsBackend:
- *
- * TLS (Transport Layer Security, aka SSL) backend. This is an
- * internal type used to coordinate the different classes implemented
- * by a TLS backend.
- *
- * Since: 2.28
- */
-
typedef struct _GTlsBackend GTlsBackend;
typedef struct _GTlsBackendInterface GTlsBackendInterface;
diff --git a/gio/gtlsclientconnection.h b/gio/gtlsclientconnection.h
index fd6088a..eaf62f0 100644
--- a/gio/gtlsclientconnection.h
+++ b/gio/gtlsclientconnection.h
@@ -34,14 +34,6 @@ G_BEGIN_DECLS
#define G_IS_TLS_CLIENT_CONNECTION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_TLS_CLIENT_CONNECTION))
#define G_TLS_CLIENT_CONNECTION_GET_INTERFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_TLS_CLIENT_CONNECTION, GTlsClientConnectionInterface))
-/**
- * GTlsClientConnection:
- *
- * TLS client-side connection; the client-side implementation of a
- * #GTlsConnection
- *
- * Since: 2.28
- */
typedef struct _GTlsClientConnectionInterface GTlsClientConnectionInterface;
struct _GTlsClientConnectionInterface
diff --git a/gio/gtlsconnection.h b/gio/gtlsconnection.h
index 550d540..37132cc 100644
--- a/gio/gtlsconnection.h
+++ b/gio/gtlsconnection.h
@@ -36,14 +36,6 @@ G_BEGIN_DECLS
#define G_IS_TLS_CONNECTION_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_TLS_CONNECTION))
#define G_TLS_CONNECTION_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), G_TYPE_TLS_CONNECTION, GTlsConnectionClass))
-/**
- * GTlsConnection:
- *
- * TLS connection. This is an abstract type that will be subclassed by
- * a TLS-library-specific subtype.
- *
- * Since: 2.28
- */
typedef struct _GTlsConnectionClass GTlsConnectionClass;
typedef struct _GTlsConnectionPrivate GTlsConnectionPrivate;
diff --git a/gio/gunixconnection.h b/gio/gunixconnection.h
index e598ef5..018b08d 100644
--- a/gio/gunixconnection.h
+++ b/gio/gunixconnection.h
@@ -39,13 +39,6 @@ G_BEGIN_DECLS
#define G_UNIX_CONNECTION_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
G_TYPE_UNIX_CONNECTION, GUnixConnectionClass))
-/**
- * GTcpConnection:
- *
- * A #GSocketConnection for UNIX domain socket connections.
- *
- * Since: 2.22
- */
typedef struct _GUnixConnection GUnixConnection;
typedef struct _GUnixConnectionPrivate GUnixConnectionPrivate;
typedef struct _GUnixConnectionClass GUnixConnectionClass;
diff --git a/glib/gversion.h b/glib/gversion.h
index 35a7d3e..d0581c2 100644
--- a/glib/gversion.h
+++ b/glib/gversion.h
@@ -45,28 +45,6 @@ const gchar * glib_check_version (guint required_major,
guint required_minor,
guint required_micro);
-/**
- * GLIB_CHECK_VERSION:
- * @major: the major version to check for
- * @minor: the minor version to check for
- * @micro: the micro version to check for
- *
- * Checks the version of the GLib library that is being compiled
- * against.
- *
- * <example>
- * <title>Checking the version of the GLib library</title>
- * <programlisting>
- * if (!GLIB_CHECK_VERSION (1, 2, 0))
- * g_error ("GLib version 1.2.0 or above is needed");
- * </programlisting>
- * </example>
- *
- * See glib_check_version() for a runtime check.
- *
- * Returns: %TRUE if the version of the GLib header files
- * is the same as or newer than the passed-in version.
- */
#define GLIB_CHECK_VERSION(major,minor,micro) \
(GLIB_MAJOR_VERSION > (major) || \
(GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]