Commit e4305413 authored by Philip Withnall's avatar Philip Withnall

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's avatarPhilip Withnall <withnall@endlessm.com>
Reviewed-by: nobody
parent d3b07453
......@@ -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;
* }
......
......@@ -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
......
......@@ -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
......
......@@ -38,7 +38,7 @@ G_BEGIN_DECLS
* GSocketAddressEnumerator:
*
* Enumerator type for objects that contain or generate
* #GSocketAddress<!-- -->es.
* #GSocketAddress instances.
*/
typedef struct _GSocketAddressEnumeratorClass GSocketAddressEnumeratorClass;
......
......@@ -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;
* }
* ]|
......
......@@ -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
......
......@@ -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);
* ]|
......
......@@ -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()`.
*
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment