docs: Remove <!-- --> comment before plural s
authorVolker Sobek <reklov@live.com>
Wed, 16 Apr 2014 21:56:02 +0000 (23:56 +0200)
committerVolker Sobek <reklov@live.com>
Thu, 24 Apr 2014 11:42:37 +0000 (13:42 +0200)
These did show up in the html. Since symbol names are checked for a
trailing plural s when generating the docs, the links stay functional
after removing these comments.

https://bugzilla.gnome.org/show_bug.cgi?id=728380

12 files changed:
gio/gappinfo.h
gio/gfile.h
gio/gfileattribute.h
gio/gfileenumerator.c
gio/gicon.h
gio/gioenums.h
gio/giotypes.h
gio/gunixmounts.h
glib/gvariant-core.c
gobject/gclosure.h
gobject/gtype.h
gobject/gvaluecollector.h

index d08885a..713616f 100644 (file)
@@ -55,7 +55,7 @@ typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
  * GAppInfoIface:
  * @g_iface: The parent interface.
  * @dup: Copies a #GAppInfo.
- * @equal: Checks two #GAppInfo<!-- -->s for equality.
+ * @equal: Checks two #GAppInfos for equality.
  * @get_id: Gets a string identifier for a #GAppInfo.
  * @get_name: Gets the name of the application for a #GAppInfo.
  * @get_description: Gets a short description for the application described by the #GAppInfo.
index 3b4d154..60a8d70 100644 (file)
@@ -52,7 +52,7 @@ typedef struct _GFileIface                    GFileIface;
  * @g_iface: The parent interface.
  * @dup: Duplicates a #GFile.
  * @hash: Creates a hash of a #GFile.
- * @equal: Checks equality of two given #GFile<!-- -->s.
+ * @equal: Checks equality of two given #GFiles.
  * @is_native: Checks to see if a file is native to the system.
  * @has_uri_scheme: Checks to see if a #GFile has a given URI scheme.
  * @get_uri_scheme: Gets the URI scheme for a #GFile.
@@ -80,8 +80,8 @@ typedef struct _GFileIface                    GFileIface;
  * @set_display_name: Sets the display name for a #GFile.
  * @set_display_name_async: Asynchronously sets a #GFile's display name.
  * @set_display_name_finish: Finishes asynchronously setting a #GFile's display name.
- * @query_settable_attributes: Returns a list of #GFileAttribute<!-- -->s that can be set.
- * @_query_settable_attributes_async: Asynchronously gets a list of #GFileAttribute<!-- -->s that can be set.
+ * @query_settable_attributes: Returns a list of #GFileAttributes that can be set.
+ * @_query_settable_attributes_async: Asynchronously gets a list of #GFileAttributes that can be set.
  * @_query_settable_attributes_finish: Finishes asynchronously querying settable attributes.
  * @query_writable_namespaces: Returns a list of #GFileAttribute namespaces that are writable.
  * @_query_writable_namespaces_async: Asynchronously gets a list of #GFileAttribute namespaces that are writable.
index 3cbdcd1..b0b0916 100644 (file)
@@ -46,11 +46,11 @@ struct _GFileAttributeInfo
 
 /**
  * GFileAttributeInfoList:
- * @infos: an array of #GFileAttributeInfo<!-- -->s.
+ * @infos: an array of #GFileAttributeInfos.
  * @n_infos: the number of values in the array.
  *
  * Acts as a lightweight registry for possible valid file attributes.
- * The registry stores Key-Value pair formats as #GFileAttributeInfo<!-- -->s.
+ * The registry stores Key-Value pair formats as #GFileAttributeInfos.
  **/
 struct _GFileAttributeInfoList
 {
index ae2965f..597d1ac 100644 (file)
@@ -395,7 +395,7 @@ g_file_enumerator_next_files_async (GFileEnumerator     *enumerator,
  * 
  * Finishes the asynchronous operation started with g_file_enumerator_next_files_async().
  * 
- * Returns: (transfer full) (element-type Gio.FileInfo): a #GList of #GFileInfo<!---->s. You must free the list with 
+ * Returns: (transfer full) (element-type Gio.FileInfo): a #GList of #GFileInfos. You must free the list with 
  *     g_list_free() and unref the infos with g_object_unref() when you're 
  *     done with them.
  **/
index 1e3ed9a..5a09864 100644 (file)
@@ -45,7 +45,7 @@ typedef struct _GIconIface GIconIface;
  * GIconIface:
  * @g_iface: The parent interface.
  * @hash: A hash for a given #GIcon.
- * @equal: Checks if two #GIcon<!-- -->s are equal.
+ * @equal: Checks if two #GIcons are equal.
  * @to_tokens: Serializes a #GIcon into tokens. The tokens must not
  * contain any whitespace. Don't implement if the #GIcon can't be
  * serialized (Since 2.20).
index 9a7631f..a9d30fd 100644 (file)
@@ -1348,7 +1348,7 @@ typedef enum /*< flags >*/
  * assign a serial number from the #GDBusConnection object when
  * sending a message.
  *
- * Flags used when sending #GDBusMessage<!-- -->s on a #GDBusConnection.
+ * Flags used when sending #GDBusMessages on a #GDBusConnection.
  *
  * Since: 2.26
  */
index d3f8be0..0c5df22 100644 (file)
@@ -393,7 +393,7 @@ typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
  * @size: the available size in @buffer.
  *
  * Structure used for scatter/gather data input.
- * You generally pass in an array of #GInputVector<!-- -->s
+ * You generally pass in an array of #GInputVectors
  * and the operation will store the read data starting in the
  * first buffer, switching to the next as needed.
  *
@@ -412,7 +412,7 @@ struct _GInputVector {
  * @size: the size of @buffer.
  *
  * Structure used for scatter/gather data output.
- * You generally pass in an array of #GOutputVector<!-- -->s
+ * You generally pass in an array of #GOutputVectors
  * and the operation will use all the buffers as if they were
  * one buffer.
  *
index 6ac06f2..dffdce6 100644 (file)
@@ -44,7 +44,7 @@ typedef struct _GUnixMountPoint GUnixMountPoint;
 /**
  * GUnixMountMonitor:
  *
- * Watches #GUnixMount<!-- -->s for changes.
+ * Watches #GUnixMounts for changes.
  **/
 typedef struct _GUnixMountMonitor      GUnixMountMonitor;
 typedef struct _GUnixMountMonitorClass GUnixMountMonitorClass;
index 8b649d9..a9f5d94 100644 (file)
@@ -844,7 +844,7 @@ g_variant_get_size (GVariant *value)
  * serialised data, you must know the type of the #GVariant, and (if the
  * machine might be different) the endianness of the machine that stored
  * it. As a result, file formats or network messages that incorporate
- * serialised #GVariant<!---->s must include this information either
+ * serialised #GVariants must include this information either
  * implicitly (for instance "the file always contains a
  * %G_VARIANT_TYPE_VARIANT and it is always in little-endian order") or
  * explicitly (by storing the type and/or endianness in addition to the
index 2142bd9..1cc609e 100644 (file)
@@ -102,7 +102,7 @@ typedef void  (*GClosureNotify)             (gpointer        data,
  *  value.
  * @n_param_values: the length of the @param_values array
  * @param_values: (array length=n_param_values): an array of
- *  #GValue<!-- -->s holding the arguments on which to invoke the
+ *  #GValues holding the arguments on which to invoke the
  *  callback of @closure
  * @invocation_hint: (allow-none): the invocation hint given as the
  *  last argument to g_closure_invoke()
index 50fab2b..8ceeb96 100644 (file)
@@ -926,7 +926,7 @@ typedef void   (*GInterfaceFinalizeFunc)     (gpointer         g_iface,
  * whether they actually want to cache the class of this type, since all
  * classes are routed through the same #GTypeClassCacheFunc chain.
  * 
- * Returns: %TRUE to stop further #GTypeClassCacheFunc<!-- -->s from being 
+ * Returns: %TRUE to stop further #GTypeClassCacheFuncs from being 
  *  called, %FALSE to continue.
  */
 typedef gboolean (*GTypeClassCacheFunc)             (gpointer         cache_data,
index 1e488b4..11a1ad8 100644 (file)
@@ -244,7 +244,7 @@ G_STMT_START {                                                                              \
 /**
  * G_VALUE_COLLECT_FORMAT_MAX_LENGTH:
  * 
- * The maximal number of #GTypeCValue<!-- -->s which can be collected for a 
+ * The maximal number of #GTypeCValues which can be collected for a 
  * single #GValue.
  */
 #define        G_VALUE_COLLECT_FORMAT_MAX_LENGTH       (8)