docs: Remove DocBook tags

We are still using gtk-doc, but gtk-doc uses Markdown these days, not DocBook.
2024-11-09 19:06:15 +01:00 · 2022-02-13 14:20:51 +00:00 · 2022-02-13 14:20:51 +00:00 · 2ca3c1da83
commit 2ca3c1da83
parent edbd878523
18 changed files with 111 additions and 240 deletions
--- a/giarginfo.c
+++ b/giarginfo.c
@ -35,16 +35,9 @@
 * @title: GIArgInfo
 * @short_description: Struct representing an argument
 *
- * GIArgInfo represents an argument. An argument is always
- * part of a #GICallableInfo.
+ * GIArgInfo represents an argument of a callable.
 *
- * <refsect1 id="gi-giarginfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----GIArgInfo
- * </synopsis>
- * </refsect1>
+ * An argument is always part of a #GICallableInfo.
 */

 /**
--- a/gibaseinfo.c
+++ b/gibaseinfo.c
@ -185,43 +185,45 @@ _g_type_info_init (GIBaseInfo *info,
 * @title: GIBaseInfo
 * @short_description: Base struct for all GITypelib structs
 *
- * GIBaseInfo is the common base struct of all other *Info structs
+ * GIBaseInfo is the common base struct of all other Info structs
 * accessible through the #GIRepository API.
- * All other structs can be casted to a #GIBaseInfo, for instance:
- * <example>
- * <title>Casting a #GIFunctionInfo to #GIBaseInfo</title>
- * <programlisting>
+ *
+ * All info structures can be cast to a #GIBaseInfo, for instance:
+ *
+ * |[<!-- language="C" -->
 *    GIFunctionInfo *function_info = ...;
- *    GIBaseInfo *info = (GIBaseInfo*)function_info;
- * </programlisting>
- * </example>
- * Most #GIRepository APIs returning a #GIBaseInfo is actually creating a new struct, in other
- * words, g_base_info_unref() has to be called when done accessing the data.
- * GIBaseInfos are normally accessed by calling either
- * g_irepository_find_by_name(), g_irepository_find_by_gtype() or g_irepository_get_info().
+ *    GIBaseInfo *info = (GIBaseInfo *) function_info;
+ * ]|
 *
- * <example>
- * <title>Getting the Button of the Gtk typelib</title>
- * <programlisting>
- *    GIBaseInfo *button_info = g_irepository_find_by_name(NULL, "Gtk", "Button");
- *    ... use button_info ...
- *    g_base_info_unref(button_info);
- * </programlisting>
- * </example>
+ * Most #GIRepository APIs returning a #GIBaseInfo is actually
+ * creating a new struct; in other words, g_base_info_unref() has to
+ * be called when done accessing the data.
 *
- * <refsect1 id="gi-gibaseinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
+ * #GIBaseInfo structuress are normally accessed by calling either
+ * g_irepository_find_by_name(), g_irepository_find_by_gtype() or
+ * g_irepository_get_info().
+ *
+ * |[<!-- language="C" -->
+ * GIBaseInfo *button_info =
+ *   g_irepository_find_by_name (NULL, "Gtk", "Button");
+ *
+ * // ... use button_info ...
+ *
+ * g_base_info_unref (button_info);
+ * ]|
+ *
+ * ## Hierarchy
+ *
+ * |[<!-- language="plain" -->
 *   GIBaseInfo
- *    +----<link linkend="gi-GIArgInfo">GIArgInfo</link>
- *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
- *    +----<link linkend="gi-GIConstantInfo">GIConstantInfo</link>
- *    +----<link linkend="gi-GIFieldInfo">GIFieldInfo</link>
- *    +----<link linkend="gi-GIPropertyInfo">GIPropertyInfo</link>
- *    +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
- *    +----<link linkend="gi-GITypeInfo">GITypeInfo</link>
- * </synopsis>
- * </refsect1>
+ *    +---- GIArgInfo
+ *    +---- GICallableInfo
+ *    +---- GIConstantInfo
+ *    +---- GIFieldInfo
+ *    +---- GIPropertyInfo
+ *    +---- GIRegisteredTypeInfo
+ *    +---- GITypeInfo
+ * ]|
 */

 /**
@ -573,9 +575,7 @@ _attribute_blob_find_first (GIBaseInfo *info,
 * Both the @name and @value should be treated as constants
 * and must not be freed.
 *
- * <example>
- * <title>Iterating over attributes</title>
- * <programlisting>
+ * |[<!-- language="C" -->
 * void
 * print_attributes (GIBaseInfo *info)
 * {
@ -587,8 +587,7 @@ _attribute_blob_find_first (GIBaseInfo *info,
 *       g_print ("attribute name: %s value: %s", name, value);
 *     }
 * }
- * </programlisting>
- * </example>
+ * ]|
 *
 * Returns: %TRUE if there are more attributes
 */
--- a/gicallableinfo.c
+++ b/gicallableinfo.c
@ -39,22 +39,15 @@
 * @short_description: Struct representing a callable
 *
 * GICallableInfo represents an entity which is callable.
- * Currently a function (#GIFunctionInfo), virtual function,
- * (#GIVFuncInfo) or callback (#GICallbackInfo).
+ *
+ * Examples of callable are:
+ *
+ *  - functions (#GIFunctionInfo)
+ *  - virtual functions (#GIVFuncInfo)
+ *  - callbacks (#GICallbackInfo).
 *
 * A callable has a list of arguments (#GIArgInfo), a return type,
 * direction and a flag which decides if it returns null.
- *
- * <refsect1 id="gi-gicallableinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----GICallableInfo
- *          +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
- *          +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
- *          +----<link linkend="gi-GIVFuncInfo">GIVFuncInfo</link>
- * </synopsis>
- * </refsect1>
 */

 static guint32
@ -479,14 +472,16 @@ g_callable_info_iterate_return_attributes (GICallableInfo  *info,
 * @return_tag: #GITypeTag of the return value
 * @interface_type: #GIInfoType of the underlying interface type
 * @ffi_value: pointer to #GIFFIReturnValue union containing the return value
- *   from ffi_call()
+ *   from `ffi_call()`
 * @arg: (out caller-allocates): pointer to an allocated #GIArgument
 *
- * Extract the correct bits from an ffi_arg return value into
- * GIArgument: https://bugzilla.gnome.org/show_bug.cgi?id=665152
+ * Extract the correct bits from an `ffi_arg` return value into
+ * GIArgument.
 *
- * Also see <citerefentry><refentrytitle>ffi_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- *  - the storage requirements for return values are "special".
+ * See: https://bugzilla.gnome.org/show_bug.cgi?id=665152
+ *
+ * Also see `ffi_call(3)`: the storage requirements for return values
+ * are "special".
 *
 * The @interface_type argument only applies if @return_tag is
 * %GI_TYPE_TAG_INTERFACE. Otherwise it is ignored.
@ -553,14 +548,16 @@ gi_type_tag_extract_ffi_return_value (GITypeTag         return_tag,
 * gi_type_info_extract_ffi_return_value:
 * @return_info: #GITypeInfo describing the return type
 * @ffi_value: pointer to #GIFFIReturnValue union containing the return value
- *   from ffi_call()
+ *   from `ffi_call()`
 * @arg: (out caller-allocates): pointer to an allocated #GIArgument
 *
- * Extract the correct bits from an ffi_arg return value into
- * GIArgument: https://bugzilla.gnome.org/show_bug.cgi?id=665152
+ * Extract the correct bits from an `ffi_arg` return value into
+ * #GIArgument.
 *
- * Also see <citerefentry><refentrytitle>ffi_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- *  - the storage requirements for return values are "special".
+ * See: https://bugzilla.gnome.org/show_bug.cgi?id=665152
+ *
+ * Also see `ffi_call(3)`: the storage requirements for return values
+ * are "special".
 */
 void
 gi_type_info_extract_ffi_return_value (GITypeInfo                  *return_info,
--- a/giconstantinfo.c
+++ b/giconstantinfo.c
@ -34,17 +34,11 @@
 * @title: GIConstantInfo
 * @short_description: Struct representing a constant
 *
- * GIConstantInfo represents a constant. A constant has a type associated
- * which can be obtained by calling g_constant_info_get_type() and a value,
- * which can be obtained by calling g_constant_info_get_value().
+ * GIConstantInfo represents a constant.
 *
- * <refsect1 id="gi-giconstantinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----GIConstantInfo
- * </synopsis>
- * </refsect1>
+ * A constant has a type associated which can be obtained by calling
+ * g_constant_info_get_type() and a value, which can be obtained by
+ * calling g_constant_info_get_value().
 */


--- a/gienuminfo.c
+++ b/gienuminfo.c
@ -33,18 +33,13 @@
 * @title: GIEnumInfo
 * @short_description: Structs representing an enumeration and its values
 *
- * A GIEnumInfo represents an enumeration and a GIValueInfo struct represents a value
- * of an enumeration. The GIEnumInfo contains a set of values and a type
- * The GIValueInfo is fetched by calling g_enum_info_get_value() on a #GIEnumInfo.
+ * A GIEnumInfo represents an enumeration, and a GIValueInfo represents
+ * a value in the enumeration.
 *
- * <refsect1 id="gi-gienuminfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
- *          +----GIEnumInfo
- * </synopsis>
- * </refsect1>
+ * The GIEnumInfo contains a set of values and a type.
+ *
+ * The GIValueInfo is fetched by calling g_enum_info_get_value() on
+ * a GIEnumInfo.
 */

 /**
@ -235,4 +230,3 @@ g_value_info_get_value (GIValueInfo *info)
  else
    return (gint64)blob->value;
 }
-
--- a/gifieldinfo.c
+++ b/gifieldinfo.c
@ -34,20 +34,15 @@
 * @title: GIFieldInfo
 * @short_description: Struct representing a struct or union field
 *
- * A GIFieldInfo struct represents a field of a struct (see #GIStructInfo),
- * union (see #GIUnionInfo) or an object (see #GIObjectInfo). The GIFieldInfo
- * is fetched by calling g_struct_info_get_field(), g_union_info_get_field()
- * or g_object_info_get_field().
- * A field has a size, type and a struct offset asssociated and a set of flags,
- * which is currently #GI_FIELD_IS_READABLE or #GI_FIELD_IS_WRITABLE.
+ * A GIFieldInfo struct represents a field of a struct, union, or object.
 *
- * <refsect1 id="gi-gifieldinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----GIFieldInfo
- * </synopsis>
- * </refsect1>
+ * The GIFieldInfo is fetched by calling g_struct_info_get_field(),
+ * g_union_info_get_field() or g_object_info_get_field().
+ *
+ * A field has a size, type and a struct offset asssociated and a set of flags,
+ * which are currently #GI_FIELD_IS_READABLE or #GI_FIELD_IS_WRITABLE.
+ *
+ * See also: #GIStructInfo, #GIUnionInfo, #GIObjectInfo
 */

 /**
--- a/gifunctioninfo.c
+++ b/gifunctioninfo.c
@ -36,22 +36,12 @@
 * @short_description: Struct representing a function
 *
 * GIFunctionInfo represents a function, method or constructor.
+ *
 * To find out what kind of entity a #GIFunctionInfo represents, call
 * g_function_info_get_flags().
 *
 * See also #GICallableInfo for information on how to retreive arguments and
 * other metadata.
- *
- * <refsect1 id="gi-gifunctioninfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
- *          +----GIFunctionInfo
- *          +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
- *          +----<link linkend="gi-GIVFuncInfo">GIVFuncInfo</link>
- * </synopsis>
- * </refsect1>
 */

 GIFunctionInfo *
--- a/giinterfaceinfo.c
+++ b/giinterfaceinfo.c
@ -37,15 +37,6 @@
 *
 * A GInterface has methods, fields, properties, signals, interfaces, constants,
 * virtual functions and prerequisites.
- *
- * <refsect1 id="gi-giinterfaceinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
- *          +----GIInterfaceInfo
- * </synopsis>
- * </refsect1>
 */

 /**
--- a/giobjectinfo.c
+++ b/giobjectinfo.c
@ -31,22 +31,18 @@
 /**
 * SECTION:giobjectinfo
 * @title: GIObjectInfo
- * @short_description: Struct representing a GObject
+ * @short_description: Struct representing a classed type
 *
- * GIObjectInfo represents a #GObject. This doesn't represent a specific
- * instance of a GObject, instead this represent the object type (eg class).
+ * GIObjectInfo represents a classed type.
 *
- * A GObject has methods, fields, properties, signals, interfaces, constants
- * and virtual functions.
+ * Classed types in GType inherit from #GTypeInstance; the most common
+ * type is #GObject.
 *
- * <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
- *          +----GIObjectInfo
- * </synopsis>
- * </refsect1>
+ * A GIObjectInfo doesn't represent a specific instance of a classed type,
+ * instead this represent the object type (eg class).
+ *
+ * A GIObjectInfo has methods, fields, properties, signals, interfaces,
+ * constants and virtual functions.
 */

 /**
--- a/gipropertyinfo.c
+++ b/gipropertyinfo.c
@ -33,16 +33,9 @@
 * @title: GIPropertyInfo
 * @short_description: Struct representing a property
 *
- * GIPropertyInfo represents a property. A property belongs to
- * either a #GIObjectInfo or a #GIInterfaceInfo.
+ * GIPropertyInfo represents a property in a #GObject.
 *
- * <refsect1 id="gi-gipropertyinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----GIPropertyInfo
- * </synopsis>
- * </refsect1>
+ * A property belongs to either a #GIObjectInfo or a #GIInterfaceInfo.
 */

 /**
--- a/giregisteredtypeinfo.c
+++ b/giregisteredtypeinfo.c
@ -35,27 +35,16 @@
 * @title: GIRegisteredTypeInfo
 * @short_description: Struct representing a struct with a GType
 *
- * GIRegisteredTypeInfo represents an entity with a GType associated. Could
- * be either a #GIEnumInfo, #GIInterfaceInfo, #GIObjectInfo, #GIStructInfo or a
- * #GIUnionInfo.
+ * GIRegisteredTypeInfo represents an entity with a GType associated.
+ *
+ * Could be either a #GIEnumInfo, #GIInterfaceInfo, #GIObjectInfo,
+ * #GIStructInfo or a #GIUnionInfo.
 *
 * A registered type info struct has a name and a type function.
+ *
 * To get the name call g_registered_type_info_get_type_name().
 * Most users want to call g_registered_type_info_get_g_type() and don't worry
 * about the rest of the details.
- *
- * <refsect1 id="gi-giregisteredtypeinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----GIRegisteredTypeInfo
- *          +----<link linkend="gi-GIEnumInfo">GIEnumInfo</link>
- *          +----<link linkend="gi-GIInterfaceInfo">GIInterfaceInfo</link>
- *          +----<link linkend="gi-GIObjectInfo">GIObjectInfo</link>
- *          +----<link linkend="gi-GIStructInfo">GIStructInfo</link>
- *          +----<link linkend="gi-GIUnionInfo">GIUnionInfo</link>
- * </synopsis>
- * </refsect1>
 */

 /**
--- a/girepository.c
+++ b/girepository.c
@ -455,7 +455,7 @@ register_internal (GIRepository *repository,
 * @namespace_: Namespace of interest
 *
 * Return an array of the immediate versioned dependencies for @namespace_.
- * Returned strings are of the form <code>namespace-version</code>.
+ * Returned strings are of the form `namespace-version`.
 *
 * Note: @namespace_ must have already been loaded using a function
 * such as g_irepository_require() before calling this function.
@ -537,9 +537,10 @@ get_typelib_dependencies_transitive (GIRepository *repository,
 *   process-global default #GIRepository
 * @namespace_: Namespace of interest
 *
- * Return an array of all (transitive) versioned dependencies for
- * @namespace_. Returned strings are of the form
- * <code>namespace-version</code>.
+ * Retrieves all (transitive) versioned dependencies for
+ * @namespace_.
+ *
+ * The strings are of the form `namespace-version`.
 *
 * Note: @namespace_ must have already been loaded using a function
 * such as g_irepository_require() before calling this function.
@ -547,7 +548,7 @@ get_typelib_dependencies_transitive (GIRepository *repository,
 * To get only the immediate dependencies for @namespace_, use
 * g_irepository_get_immediate_dependencies().
 *
- * Returns: (transfer full): Zero-terminated string array of all versioned
+ * Returns: (transfer full) (array zero-terminated=1): all versioned
 *   dependencies
 */
 char **
--- a/gisignalinfo.c
+++ b/gisignalinfo.c
@ -33,22 +33,13 @@
 * @title: GISignalInfo
 * @short_description: Struct representing a signal
 *
- * GISignalInfo represents a signal. It's a sub-struct of #GICallableInfo
- * and contains a set of flags and a class closure.
+ * GISignalInfo represents a signal.
+ *
+ * It's a sub-struct of #GICallableInfo and contains a set of flags and
+ * a class closure.
 *
 * See #GICallableInfo for information on how to retreive arguments
 * and other metadata from the signal.
- *
- * <refsect1 id="gi-gisignalinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
- *          +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
- *          +----GISignalInfo
- *          +----<link linkend="gi-GIVFuncInfo">GIVFuncInfo</link>
- * </synopsis>
- * </refsect1>
 */

 /**
--- a/gistructinfo.c
+++ b/gistructinfo.c
@ -38,15 +38,6 @@
 * GIStructInfo represents a generic C structure type.
 *
 * A structure has methods and fields.
- *
- * <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
- *          +----GIStructInfo
- * </synopsis>
- * </refsect1>
 */

 /**
--- a/gitypeinfo.c
+++ b/gitypeinfo.c
@ -33,23 +33,17 @@
 * @title: GITypeInfo
 * @short_description: Struct representing a type
 *
- * GITypeInfo represents a type. You can retrieve a type info from
- * an argument (see #GIArgInfo), a functions return value (see #GIFunctionInfo),
- * a field (see #GIFieldInfo), a property (see #GIPropertyInfo), a constant
+ * GITypeInfo represents a type.
+ *
+ * You can retrieve a type info from an argument (see #GIArgInfo), a
+ * functions return value (see #GIFunctionInfo), a field (see
+ * #GIFieldInfo), a property (see #GIPropertyInfo), a constant
 * (see #GIConstantInfo) or for a union discriminator (see #GIUnionInfo).
 *
 * A type can either be a of a basic type which is a standard C primitive
 * type or an interface type. For interface types you need to call
 * g_type_info_get_interface() to get a reference to the base info for that
 * interface.
- *
- * <refsect1 id="gi-gitypeinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----GITypeInfo
- * </synopsis>
- * </refsect1>
 */

 /**
--- a/gitypes.h
+++ b/gitypes.h
@ -64,17 +64,6 @@ typedef GIBaseInfo GIFunctionInfo;
 * @short_description: Struct representing a callback
 *
 * GICallbackInfo represents a callback.
- *
- * <refsect1 id="gi-gicallbackinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
- *          +----GIFunctionInfo
- *          +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
- *          +----<link linkend="gi-GIVFuncInfo">GIVFuncInfo</link>
- * </synopsis>
- * </refsect1>
 */

 /**
@ -139,14 +128,6 @@ typedef GIBaseInfo GIConstantInfo;
 * @short_description: Struct representing a value
 *
 * GIValueInfo represents a value.
- *
- * <refsect1 id="gi-givalueinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----GIValueInfo
- * </synopsis>
- * </refsect1>
 */

 /**
--- a/giunioninfo.c
+++ b/giunioninfo.c
@ -38,15 +38,6 @@
 * A union has methods and fields.  Unions can optionally have a
 * discriminator, which is a field deciding what type of real union
 * fields is valid for specified instance.
- *
- * <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
- *          +----GIUnionInfo
- * </synopsis>
- * </refsect1>
 */

 /**
--- a/givfuncinfo.c
+++ b/givfuncinfo.c
@ -35,19 +35,10 @@
 * @title: GIVFuncInfo
 * @short_description: Struct representing a virtual function
 *
- * GIVfuncInfo represents a virtual function. A property belongs to
- * either a #GIObjectInfo or a #GIInterfaceInfo.
+ * GIVfuncInfo represents a virtual function.
 *
- * <refsect1 id="gi-givfuncinfo.struct-hierarchy" role="struct_hierarchy">
- * <title role="struct_hierarchy.title">Struct hierarchy</title>
- * <synopsis>
- *   <link linkend="GIBaseInfo">GIBaseInfo</link>
- *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
- *          +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
- *          +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
- *          +----GIVFuncInfo
- * </synopsis>
- * </refsect1>
+ * A virtual function is a callable object that belongs to either a
+ * #GIObjectInfo or a #GIInterfaceInfo.
 */

 GIVFuncInfo *