[glib] docs: Drop unnecessary <!-- -->s from gtk-doc comments



commit 06719a86b2eb85235b9877e8e27535ddcd45dae2
Author: Philip Withnall <withnall endlessm com>
Date:   Wed Nov 29 17:50:27 2017 +0000

    docs: Drop unnecessary <!-- -->s from gtk-doc comments
    
    Putting a <!-- --> in plural<!-- -->s was an old hack used to fix
    linking the symbol with gtk-doc when gtk-doc didn’t know about plural
    forms. gtk-doc does now know about plural forms, so the hack can be
    removed.
    
    Signed-off-by: Philip Withnall <withnall endlessm com>

 gio/gdbus-2.0/codegen/codegen.py |    6 +++---
 gio/gproxyaddressenumerator.h    |    2 +-
 gio/gsocketconnectable.h         |    2 +-
 gio/tests/test-pipe-unix.c       |    2 +-
 gobject/gclosure.c               |    4 ++--
 5 files changed, 8 insertions(+), 8 deletions(-)
---
diff --git a/gio/gdbus-2.0/codegen/codegen.py b/gio/gdbus-2.0/codegen/codegen.py
index 03fc2dc..97229c8 100644
--- a/gio/gdbus-2.0/codegen/codegen.py
+++ b/gio/gdbus-2.0/codegen/codegen.py
@@ -993,7 +993,7 @@ class CodeGenerator:
             self.c.write(self.docbook_gen.expand(
                     '/**\n'
                     ' * %s_override_properties:\n'
-                    ' * @klass: The class structure for a #GObject<!-- -->-derived class.\n'
+                    ' * @klass: The class structure for a #GObject derived class.\n'
                     ' * @property_id_begin: The property id to assign to the first overridden property.\n'
                     ' *\n'
                     ' * Overrides all #GObject properties in the #%s interface for a concrete class.\n'
@@ -3153,9 +3153,9 @@ class CodeGenerator:
                 ' * @interface_name: (nullable): Interface name of the remote object or %%NULL to get the 
object proxy #GType.\n'
                 ' * @user_data: User data (unused).\n'
                 ' *\n'
-                ' * A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy<!-- 
-->- and #GDBusProxy<!-- -->-derived types.\n'
+                ' * A #GDBusProxyTypeFunc that maps @interface_name to the generated #GDBusObjectProxy 
derived and #GDBusProxy derived types.\n'
                 ' *\n'
-                ' * Returns: A #GDBusProxy<!-- -->-derived #GType if @interface_name is not %%NULL, 
otherwise the #GType for #%sObjectProxy.\n'
+                ' * Returns: A #GDBusProxy derived #GType if @interface_name is not %%NULL, otherwise the 
#GType for #%sObjectProxy.\n'
                 %(self.ns_lower, self.namespace), False))
         self.c.write(' */\n')
         self.c.write('GType\n'
diff --git a/gio/gproxyaddressenumerator.h b/gio/gproxyaddressenumerator.h
index 4bd05ce..1b99e35 100644
--- a/gio/gproxyaddressenumerator.h
+++ b/gio/gproxyaddressenumerator.h
@@ -40,7 +40,7 @@ G_BEGIN_DECLS
  * GProxyAddressEnumerator:
  *
  * A subclass of #GSocketAddressEnumerator that takes another address
- * enumerator and wraps its results in #GProxyAddress<!-- -->es as
+ * enumerator and wraps its results in #GProxyAddresses as
  * directed by the default #GProxyResolver.
  */
 
diff --git a/gio/gsocketconnectable.h b/gio/gsocketconnectable.h
index 6a92dac..6528d49 100644
--- a/gio/gsocketconnectable.h
+++ b/gio/gsocketconnectable.h
@@ -35,7 +35,7 @@ G_BEGIN_DECLS
 /**
  * GSocketConnectable:
  *
- * Interface for objects that contain or generate #GSocketAddress<!-- -->es.
+ * Interface for objects that contain or generate #GSocketAddresses.
  */
 typedef struct _GSocketConnectableIface GSocketConnectableIface;
 
diff --git a/gio/tests/test-pipe-unix.c b/gio/tests/test-pipe-unix.c
index 14b22e7..ccf9faa 100644
--- a/gio/tests/test-pipe-unix.c
+++ b/gio/tests/test-pipe-unix.c
@@ -86,7 +86,7 @@ test_pipe (GInputStream  **is,
  * @right: (out) (optional): used to return the other #GIOStream
  * @error: used to raise an error
  *
- * Return two #GIOStream<!---->s connected to each other with pipes.
+ * Return two #GIOStreams connected to each other with pipes.
  * The "left" input stream is connected by a unidirectional pipe
  * to the "right" output stream, and vice versa. This can be used
  * as a bidirectional pipe to a child process, for instance.
diff --git a/gobject/gclosure.c b/gobject/gclosure.c
index 4d3031c..caa1154 100644
--- a/gobject/gclosure.c
+++ b/gobject/gclosure.c
@@ -52,8 +52,8 @@
  * to a function and maybe a data argument, and the marshaller
  * converts between #GValue and native C types. The GObject
  * library provides the #GCClosure type for this purpose. Bindings for
- * other languages need marshallers which convert between #GValue<!--
- * -->s and suitable representations in the runtime of the language in
+ * other languages need marshallers which convert between #GValues
+ * and suitable representations in the runtime of the language in
  * order to use functions written in that languages as callbacks.
  *
  * Within GObject, closures play an important role in the


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