luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Philip Withnall 2017-11-29 17:50:27 +00:00
parent 0a2b238f7c
commit 06719a86b2
5 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
gio/gdbus-2.0/codegen/codegen.py
View File

@ -993,7 +993,7 @@ class CodeGenerator:
self.c.write(self.docbook_gen.expand( self.c.write(self.docbook_gen.expand(
'/**\n' '/**\n'
' * %s_override_properties:\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' ' * @property_id_begin: The property id to assign to the first overridden property.\n'
' *\n' ' *\n'
' * Overrides all #GObject properties in the #%s interface for a concrete class.\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' ' * @interface_name: (nullable): Interface name of the remote object or %%NULL to get the object proxy #GType.\n'
' * @user_data: User data (unused).\n' ' * @user_data: User data (unused).\n'
' *\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' ' *\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.ns_lower, self.namespace), False))
self.c.write(' */\n') self.c.write(' */\n')
self.c.write('GType\n' self.c.write('GType\n'

2
gio/gproxyaddressenumerator.h
View File

@ -40,7 +40,7 @@ G_BEGIN_DECLS
* GProxyAddressEnumerator: * GProxyAddressEnumerator:
* *
* A subclass of #GSocketAddressEnumerator that takes another address * 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. * directed by the default #GProxyResolver.
*/ */

2
gio/gsocketconnectable.h
View File

@ -35,7 +35,7 @@ G_BEGIN_DECLS
/** /**
* GSocketConnectable: * GSocketConnectable:
* *
* Interface for objects that contain or generate #GSocketAddress<!-- -->es. * Interface for objects that contain or generate #GSocketAddresses.
*/ */
typedef struct _GSocketConnectableIface GSocketConnectableIface; typedef struct _GSocketConnectableIface GSocketConnectableIface;

2
gio/tests/test-pipe-unix.c
View File

@ -86,7 +86,7 @@ test_pipe (GInputStream **is,
* @right: (out) (optional): used to return the other #GIOStream * @right: (out) (optional): used to return the other #GIOStream
* @error: used to raise an error * @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 * The "left" input stream is connected by a unidirectional pipe
* to the "right" output stream, and vice versa. This can be used * to the "right" output stream, and vice versa. This can be used
* as a bidirectional pipe to a child process, for instance. * as a bidirectional pipe to a child process, for instance.

4
gobject/gclosure.c
View File

@ -52,8 +52,8 @@
* to a function and maybe a data argument, and the marshaller * to a function and maybe a data argument, and the marshaller
* converts between #GValue and native C types. The GObject * converts between #GValue and native C types. The GObject
* library provides the #GCClosure type for this purpose. Bindings for * library provides the #GCClosure type for this purpose. Bindings for
* other languages need marshallers which convert between #GValue<!-- * other languages need marshallers which convert between #GValues
* -->s and suitable representations in the runtime of the language in * and suitable representations in the runtime of the language in
* order to use functions written in that languages as callbacks. * order to use functions written in that languages as callbacks.
* *
* Within GObject, closures play an important role in the * Within GObject, closures play an important role in the