[glib] docs: Remove XML-style comments from documentation strings
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] docs: Remove XML-style comments from documentation strings
- Date: Fri, 12 Jan 2018 15:30:37 +0000 (UTC)
commit e430541378bd9471036a6097ccb408e83cf20fd2
Author: Philip Withnall <withnall endlessm com>
Date: Fri Jan 12 15:29:29 2018 +0000
docs: Remove XML-style comments from documentation strings
gtk-doc doesn’t support them any more since it was ported to Markdown,
so they end up appearing in the generated documentation, which isn’t
great.
Mostly, they were used to split up things invisibly, which we can do in
other ways.
Signed-off-by: Philip Withnall <withnall endlessm com>
Reviewed-by: nobody
gio/gdbusconnection.h | 6 +++---
gio/gdbusmethodinvocation.c | 2 +-
gio/gsettingsschema.c | 4 ++--
gio/gsocketaddressenumerator.h | 2 +-
glib/docs.c | 4 ++--
glib/ghash.c | 2 +-
glib/gvariant.c | 2 +-
gobject/gtypemodule.h | 2 +-
8 files changed, 12 insertions(+), 12 deletions(-)
---
diff --git a/gio/gdbusconnection.h b/gio/gdbusconnection.h
index b0219e9..b2c5035 100644
--- a/gio/gdbusconnection.h
+++ b/gio/gdbusconnection.h
@@ -604,7 +604,7 @@ void g_dbus_connection_signal_unsubscribe (GDBusConnection
* gboolean incoming,
* gpointer user_data)
* {
- * /<!-- -->* inspect @message *<!-- -->/
+ * // inspect @message
* return message;
* }
* ]|
@@ -637,10 +637,10 @@ void g_dbus_connection_signal_unsubscribe (GDBusConnection
*
* error = NULL;
* copy = g_dbus_message_copy (message, &error);
- * /<!-- -->* handle @error being is set *<!-- -->/
+ * // handle @error being set
* g_object_unref (message);
*
- * /<!-- -->* modify @copy *<!-- -->/
+ * // modify @copy
*
* return copy;
* }
diff --git a/gio/gdbusmethodinvocation.c b/gio/gdbusmethodinvocation.c
index fe28203..18ae9d1 100644
--- a/gio/gdbusmethodinvocation.c
+++ b/gio/gdbusmethodinvocation.c
@@ -554,7 +554,7 @@ g_dbus_method_invocation_return_value_internal (GDBusMethodInvocation *invocatio
* g_dbus_method_invocation_return_value (invocation,
* g_variant_new ("(s)", result_string));
*
- * /<!-- -->* Do not free @invocation here; returning a value does that *<!-- -->/
+ * // Do not free @invocation here; returning a value does that
* ]|
*
* This method will take ownership of @invocation. See
diff --git a/gio/gsettingsschema.c b/gio/gsettingsschema.c
index 4e12243..f1274a3 100644
--- a/gio/gsettingsschema.c
+++ b/gio/gsettingsschema.c
@@ -850,7 +850,7 @@ ensure_schema_lists (void)
/**
* g_settings_list_schemas:
*
- * <!-- -->
+ * Deprecated.
*
* Returns: (element-type utf8) (transfer none): a list of #GSettings
* schemas that are available. The list must not be modified or
@@ -874,7 +874,7 @@ g_settings_list_schemas (void)
/**
* g_settings_list_relocatable_schemas:
*
- * <!-- -->
+ * Deprecated.
*
* Returns: (element-type utf8) (transfer none): a list of relocatable
* #GSettings schemas that are available. The list must not be
diff --git a/gio/gsocketaddressenumerator.h b/gio/gsocketaddressenumerator.h
index d11b7e4..f148f63 100644
--- a/gio/gsocketaddressenumerator.h
+++ b/gio/gsocketaddressenumerator.h
@@ -38,7 +38,7 @@ G_BEGIN_DECLS
* GSocketAddressEnumerator:
*
* Enumerator type for objects that contain or generate
- * #GSocketAddress<!-- -->es.
+ * #GSocketAddress instances.
*/
typedef struct _GSocketAddressEnumeratorClass GSocketAddressEnumeratorClass;
diff --git a/glib/docs.c b/glib/docs.c
index b9c4245..19aad0e 100644
--- a/glib/docs.c
+++ b/glib/docs.c
@@ -2597,9 +2597,9 @@
*
* membuf = g_malloc (8192);
*
- * /<!-- -->* Some computation on membuf *<!-- -->/
+ * // Some computation on membuf
*
- * /<!-- -->* membuf will be automatically freed here *<!-- -->/
+ * // membuf will be automatically freed here
* return TRUE;
* }
* ]|
diff --git a/glib/ghash.c b/glib/ghash.c
index d3c6c6e..1ddd4e9 100644
--- a/glib/ghash.c
+++ b/glib/ghash.c
@@ -118,7 +118,7 @@
* g_direct_hash() is also the appropriate hash function for keys
* of the form `GINT_TO_POINTER (n)` (or similar macros).
*
- * <!-- FIXME: Need more here. --> A good hash functions should produce
+ * A good hash functions should produce
* hash values that are evenly distributed over a fairly large range.
* The modulus is taken with the hash table size (a prime number) to
* find the 'bucket' to place each key into. The function should also
diff --git a/glib/gvariant.c b/glib/gvariant.c
index ad1ea16..8be9ce7 100644
--- a/glib/gvariant.c
+++ b/glib/gvariant.c
@@ -5282,7 +5282,7 @@ g_variant_valist_get (const gchar **str,
* GVariant *new_variant;
*
* new_variant = g_variant_new ("(t^as)",
- * /<!-- -->* This cast is required. *<!-- -->/
+ * // This cast is required.
* (guint64) some_flags,
* some_strings);
* ]|
diff --git a/gobject/gtypemodule.h b/gobject/gtypemodule.h
index d989e82..deeadcd 100644
--- a/gobject/gtypemodule.h
+++ b/gobject/gtypemodule.h
@@ -93,7 +93,7 @@ struct _GTypeModuleClass
* A convenience macro for dynamic type implementations, which declares a
* class initialization function, an instance initialization function (see
* #GTypeInfo for information about these) and a static variable named
- * @t_n<!-- -->_parent_class pointing to the parent class. Furthermore,
+ * `t_n`_parent_class pointing to the parent class. Furthermore,
* it defines a `*_get_type()` and a static `*_register_type()` functions
* for use in your `module_init()`.
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]