[glib/wip/xclaesse/doc-part1: 2/5] Doc: Stop documented g_iface, parent_instance and parent_class
- From: Xavier Claessens <xclaesse src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/wip/xclaesse/doc-part1: 2/5] Doc: Stop documented g_iface, parent_instance and parent_class
- Date: Thu, 5 Feb 2015 19:39:03 +0000 (UTC)
commit f567f895923d043d9633f7b96ae735070557ea8f
Author: Xavier Claessens <xavier claessens collabora com>
Date: Thu Feb 5 13:10:55 2015 -0500
Doc: Stop documented g_iface, parent_instance and parent_class
They are standard members that does not need to be documented.
gtk-doc now skip them.
gio/gappinfo.h | 1 -
gio/gasyncinitable.h | 1 -
gio/gasyncresult.h | 1 -
gio/gconverter.h | 1 -
gio/gdbusinterfaceskeleton.h | 1 -
gio/gdbusobjectmanagerclient.h | 1 -
gio/gdbusobjectmanagerserver.h | 1 -
gio/gdbusobjectproxy.h | 1 -
gio/gdbusobjectskeleton.h | 1 -
gio/gdrive.h | 1 -
gio/gfile.h | 1 -
gio/gfiledescriptorbased.h | 1 -
gio/gicon.h | 1 -
gio/ginitable.h | 1 -
gio/glistmodel.c | 1 -
gio/gloadableicon.h | 1 -
gio/gmount.h | 1 -
gio/gnetworkmonitor.c | 1 -
gio/gpollableinputstream.h | 1 -
gio/gpollableoutputstream.h | 1 -
gio/gproxy.h | 1 -
gio/gproxyresolver.c | 1 -
gio/gseekable.h | 1 -
gio/gsocketconnectable.h | 1 -
gio/gtlsbackend.h | 1 -
gio/gtlsclientconnection.h | 1 -
gio/gtlsfiledatabase.h | 1 -
gio/gtlsserverconnection.h | 1 -
gio/gvolume.h | 1 -
gobject/gparamspecs.h | 22 ----------------------
gobject/gtypemodule.h | 1 -
31 files changed, 0 insertions(+), 52 deletions(-)
---
diff --git a/gio/gappinfo.h b/gio/gappinfo.h
index 5bf3cf6..a1b6798 100644
--- a/gio/gappinfo.h
+++ b/gio/gappinfo.h
@@ -53,7 +53,6 @@ typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
/**
* GAppInfoIface:
- * @g_iface: The parent interface.
* @dup: Copies a #GAppInfo.
* @equal: Checks two #GAppInfos for equality.
* @get_id: Gets a string identifier for a #GAppInfo.
diff --git a/gio/gasyncinitable.h b/gio/gasyncinitable.h
index 43dda48..762be20 100644
--- a/gio/gasyncinitable.h
+++ b/gio/gasyncinitable.h
@@ -47,7 +47,6 @@ typedef struct _GAsyncInitableIface GAsyncInitableIface;
/**
* GAsyncInitableIface:
- * @g_iface: The parent interface.
* @init_async: Starts initialization of the object.
* @init_finish: Finishes initialization of the object.
*
diff --git a/gio/gasyncresult.h b/gio/gasyncresult.h
index a80805f..4109ba0 100644
--- a/gio/gasyncresult.h
+++ b/gio/gasyncresult.h
@@ -45,7 +45,6 @@ typedef struct _GAsyncResultIface GAsyncResultIface;
/**
* GAsyncResultIface:
- * @g_iface: The parent interface.
* @get_user_data: Gets the user data passed to the callback.
* @get_source_object: Gets the source object that issued the asynchronous operation.
* @is_tagged: Checks if a result is tagged with a particular source.
diff --git a/gio/gconverter.h b/gio/gconverter.h
index 62bc592..ad48370 100644
--- a/gio/gconverter.h
+++ b/gio/gconverter.h
@@ -45,7 +45,6 @@ typedef struct _GConverterIface GConverterIface;
/**
* GConverterIface:
- * @g_iface: The parent interface.
* @convert: Converts data.
* @reset: Reverts the internal state of the converter to its initial state.
*
diff --git a/gio/gdbusinterfaceskeleton.h b/gio/gdbusinterfaceskeleton.h
index 45307fe..e5826f0 100644
--- a/gio/gdbusinterfaceskeleton.h
+++ b/gio/gdbusinterfaceskeleton.h
@@ -52,7 +52,6 @@ struct _GDBusInterfaceSkeleton
/**
* GDBusInterfaceSkeletonClass:
- * @parent_class: The parent class.
* @get_info: Returns a #GDBusInterfaceInfo. See g_dbus_interface_skeleton_get_info() for details.
* @get_vtable: Returns a #GDBusInterfaceVTable. See g_dbus_interface_skeleton_get_vtable() for details.
* @get_properties: Returns a #GVariant with all properties. See g_dbus_interface_skeleton_get_properties().
diff --git a/gio/gdbusobjectmanagerclient.h b/gio/gdbusobjectmanagerclient.h
index e7986b6..c5595df 100644
--- a/gio/gdbusobjectmanagerclient.h
+++ b/gio/gdbusobjectmanagerclient.h
@@ -52,7 +52,6 @@ struct _GDBusObjectManagerClient
/**
* GDBusObjectManagerClientClass:
- * @parent_class: The parent class.
* @interface_proxy_signal: Signal class handler for the #GDBusObjectManagerClient::interface-proxy-signal
signal.
* @interface_proxy_properties_changed: Signal class handler for the
#GDBusObjectManagerClient::interface-proxy-properties-changed signal.
*
diff --git a/gio/gdbusobjectmanagerserver.h b/gio/gdbusobjectmanagerserver.h
index 6debf59..28bf7c7 100644
--- a/gio/gdbusobjectmanagerserver.h
+++ b/gio/gdbusobjectmanagerserver.h
@@ -52,7 +52,6 @@ struct _GDBusObjectManagerServer
/**
* GDBusObjectManagerServerClass:
- * @parent_class: The parent class.
*
* Class structure for #GDBusObjectManagerServer.
*
diff --git a/gio/gdbusobjectproxy.h b/gio/gdbusobjectproxy.h
index 147cde9..718c9b2 100644
--- a/gio/gdbusobjectproxy.h
+++ b/gio/gdbusobjectproxy.h
@@ -52,7 +52,6 @@ struct _GDBusObjectProxy
/**
* GDBusObjectProxyClass:
- * @parent_class: The parent class.
*
* Class structure for #GDBusObjectProxy.
*
diff --git a/gio/gdbusobjectskeleton.h b/gio/gdbusobjectskeleton.h
index 075b92b..4d9bd79 100644
--- a/gio/gdbusobjectskeleton.h
+++ b/gio/gdbusobjectskeleton.h
@@ -52,7 +52,6 @@ struct _GDBusObjectSkeleton
/**
* GDBusObjectSkeletonClass:
- * @parent_class: The parent class.
* @authorize_method: Signal class handler for the #GDBusObjectSkeleton::authorize-method signal.
*
* Class structure for #GDBusObjectSkeleton.
diff --git a/gio/gdrive.h b/gio/gdrive.h
index 451e417..1fa0682 100644
--- a/gio/gdrive.h
+++ b/gio/gdrive.h
@@ -37,7 +37,6 @@ G_BEGIN_DECLS
/**
* GDriveIface:
- * @g_iface: The parent interface.
* @changed: Signal emitted when the drive is changed.
* @disconnected: The removed signal that is emitted when the #GDrive have been disconnected. If the
recipient is holding references to the object they should release them so the object can be finalized.
* @eject_button: Signal emitted when the physical eject button (if any) of a drive have been pressed.
diff --git a/gio/gfile.h b/gio/gfile.h
index 368bb04..48c364f 100644
--- a/gio/gfile.h
+++ b/gio/gfile.h
@@ -49,7 +49,6 @@ typedef struct _GFileIface GFileIface;
/**
* GFileIface:
- * @g_iface: The parent interface.
* @dup: Duplicates a #GFile.
* @hash: Creates a hash of a #GFile.
* @equal: Checks equality of two given #GFiles.
diff --git a/gio/gfiledescriptorbased.h b/gio/gfiledescriptorbased.h
index 7c9d8bc..5915f74 100644
--- a/gio/gfiledescriptorbased.h
+++ b/gio/gfiledescriptorbased.h
@@ -40,7 +40,6 @@ typedef struct _GFileDescriptorBasedIface GFileDescriptorBasedIface;
/**
* GFileDescriptorBasedIface:
- * @g_iface: The parent interface.
* @get_fd: Gets the underlying file descriptor.
*
* An interface for file descriptor based io objects.
diff --git a/gio/gicon.h b/gio/gicon.h
index b0c45b4..52609e1 100644
--- a/gio/gicon.h
+++ b/gio/gicon.h
@@ -43,7 +43,6 @@ typedef struct _GIconIface GIconIface;
/**
* GIconIface:
- * @g_iface: The parent interface.
* @hash: A hash for a given #GIcon.
* @equal: Checks if two #GIcons are equal.
* @to_tokens: Serializes a #GIcon into tokens. The tokens must not
diff --git a/gio/ginitable.h b/gio/ginitable.h
index 2c8804b..3b64d47 100644
--- a/gio/ginitable.h
+++ b/gio/ginitable.h
@@ -46,7 +46,6 @@ typedef struct _GInitableIface GInitableIface;
/**
* GInitableIface:
- * @g_iface: The parent interface.
* @init: Initializes the object.
*
* Provides an interface for initializing object such that initialization
diff --git a/gio/glistmodel.c b/gio/glistmodel.c
index b43f3a3..3b2608f 100644
--- a/gio/glistmodel.c
+++ b/gio/glistmodel.c
@@ -84,7 +84,6 @@ G_DEFINE_INTERFACE (GListModel, g_list_model, G_TYPE_OBJECT);
/**
* GListModelInterface:
- * @g_iface: parent #GTypeInterface
* @get_item_type: the virtual function pointer for g_list_model_get_item_type()
* @get_n_items: the virtual function pointer for g_list_model_get_n_items()
* @get_item: the virtual function pointer for g_list_model_get_item()
diff --git a/gio/gloadableicon.h b/gio/gloadableicon.h
index d164ca0..07eb403 100644
--- a/gio/gloadableicon.h
+++ b/gio/gloadableicon.h
@@ -44,7 +44,6 @@ typedef struct _GLoadableIconIface GLoadableIconIface;
/**
* GLoadableIconIface:
- * @g_iface: The parent interface.
* @load: Loads an icon.
* @load_async: Loads an icon asynchronously.
* @load_finish: Finishes an asynchronous icon load.
diff --git a/gio/gmount.h b/gio/gmount.h
index 1339743..23487e0 100644
--- a/gio/gmount.h
+++ b/gio/gmount.h
@@ -39,7 +39,6 @@ typedef struct _GMountIface GMountIface;
/**
* GMountIface:
- * @g_iface: The parent interface.
* @changed: Changed signal that is emitted when the mount's state has changed.
* @unmounted: The unmounted signal that is emitted when the #GMount have been unmounted. If the recipient
is holding references to the object they should release them so the object can be finalized.
* @pre_unmount: The ::pre-unmount signal that is emitted when the #GMount will soon be emitted. If the
recipient is somehow holding the mount open by keeping an open file on it it should close the file.
diff --git a/gio/gnetworkmonitor.c b/gio/gnetworkmonitor.c
index b08de47..4c1825b 100644
--- a/gio/gnetworkmonitor.c
+++ b/gio/gnetworkmonitor.c
@@ -50,7 +50,6 @@
/**
* GNetworkMonitorInterface:
- * @g_iface: The parent interface.
* @network_changed: the virtual function pointer for the
* GNetworkMonitor::network-changed signal.
* @can_reach: the virtual function pointer for g_network_monitor_can_reach()
diff --git a/gio/gpollableinputstream.h b/gio/gpollableinputstream.h
index f0a97ea..65f98e4 100644
--- a/gio/gpollableinputstream.h
+++ b/gio/gpollableinputstream.h
@@ -43,7 +43,6 @@ typedef struct _GPollableInputStreamInterface GPollableInputStreamInterface;
/**
* GPollableInputStreamInterface:
- * @g_iface: The parent interface.
* @can_poll: Checks if the #GPollableInputStream instance is actually pollable
* @is_readable: Checks if the stream is readable
* @create_source: Creates a #GSource to poll the stream
diff --git a/gio/gpollableoutputstream.h b/gio/gpollableoutputstream.h
index f1c183b..7491374 100644
--- a/gio/gpollableoutputstream.h
+++ b/gio/gpollableoutputstream.h
@@ -43,7 +43,6 @@ typedef struct _GPollableOutputStreamInterface GPollableOutputStreamInterface;
/**
* GPollableOutputStreamInterface:
- * @g_iface: The parent interface.
* @can_poll: Checks if the #GPollableOutputStream instance is actually pollable
* @is_writable: Checks if the stream is writable
* @create_source: Creates a #GSource to poll the stream
diff --git a/gio/gproxy.h b/gio/gproxy.h
index 9a169c9..8e64cde 100644
--- a/gio/gproxy.h
+++ b/gio/gproxy.h
@@ -57,7 +57,6 @@ typedef struct _GProxyInterface GProxyInterface;
/**
* GProxyInterface:
- * @g_iface: The parent interface.
* @connect: Connect to proxy server and wrap (if required) the #connection
* to handle payload.
* @connect_async: Same as connect() but asynchronous.
diff --git a/gio/gproxyresolver.c b/gio/gproxyresolver.c
index eb3552f..ccee2d8 100644
--- a/gio/gproxyresolver.c
+++ b/gio/gproxyresolver.c
@@ -43,7 +43,6 @@
/**
* GProxyResolverInterface:
- * @g_iface: The parent interface.
* @is_supported: the virtual function pointer for g_proxy_resolver_is_supported()
* @lookup: the virtual function pointer for g_proxy_resolver_lookup()
* @lookup_async: the virtual function pointer for
diff --git a/gio/gseekable.h b/gio/gseekable.h
index fbfd9e1..61827d5 100644
--- a/gio/gseekable.h
+++ b/gio/gseekable.h
@@ -43,7 +43,6 @@ typedef struct _GSeekableIface GSeekableIface;
/**
* GSeekableIface:
- * @g_iface: The parent interface.
* @tell: Tells the current location within a stream.
* @can_seek: Checks if seeking is supported by the stream.
* @seek: Seeks to a location within a stream.
diff --git a/gio/gsocketconnectable.h b/gio/gsocketconnectable.h
index f7db680..7446433 100644
--- a/gio/gsocketconnectable.h
+++ b/gio/gsocketconnectable.h
@@ -41,7 +41,6 @@ typedef struct _GSocketConnectableIface GSocketConnectableIface;
/**
* GSocketConnectableIface:
- * @g_iface: The parent interface.
* @enumerate: Creates a #GSocketAddressEnumerator
* @proxy_enumerate: Creates a #GProxyAddressEnumerator
*
diff --git a/gio/gtlsbackend.h b/gio/gtlsbackend.h
index 440d02d..122c9cc 100644
--- a/gio/gtlsbackend.h
+++ b/gio/gtlsbackend.h
@@ -45,7 +45,6 @@ typedef struct _GTlsBackendInterface GTlsBackendInterface;
/**
* GTlsBackendInterface:
- * @g_iface: The parent interface.
* @supports_tls: returns whether the backend supports TLS.
* @get_default_database: returns a default #GTlsDatabase instance.
* @get_certificate_type: returns the #GTlsCertificate implementation type
diff --git a/gio/gtlsclientconnection.h b/gio/gtlsclientconnection.h
index 23e90f5..c932551 100644
--- a/gio/gtlsclientconnection.h
+++ b/gio/gtlsclientconnection.h
@@ -36,7 +36,6 @@ typedef struct _GTlsClientConnectionInterface GTlsClientConnectionInterface;
/**
* GTlsClientConnectionInterface:
- * @g_iface: The parent interface.
*
* vtable for a #GTlsClientConnection implementation.
*
diff --git a/gio/gtlsfiledatabase.h b/gio/gtlsfiledatabase.h
index 5024949..7741962 100644
--- a/gio/gtlsfiledatabase.h
+++ b/gio/gtlsfiledatabase.h
@@ -32,7 +32,6 @@ typedef struct _GTlsFileDatabaseInterface GTlsFileDatabaseInterface;
/**
* GTlsFileDatabaseInterface:
- * @g_iface: The parent interface.
*
* Provides an interface for #GTlsFileDatabase implementations.
*
diff --git a/gio/gtlsserverconnection.h b/gio/gtlsserverconnection.h
index ad61e30..e8aed07 100644
--- a/gio/gtlsserverconnection.h
+++ b/gio/gtlsserverconnection.h
@@ -44,7 +44,6 @@ typedef struct _GTlsServerConnectionInterface GTlsServerConnectionInterface;
/**
* GTlsServerConnectionInterface:
- * @g_iface: The parent interface.
*
* vtable for a #GTlsServerConnection implementation.
*
diff --git a/gio/gvolume.h b/gio/gvolume.h
index c9421b1..712a2bf 100644
--- a/gio/gvolume.h
+++ b/gio/gvolume.h
@@ -88,7 +88,6 @@ G_BEGIN_DECLS
/**
* GVolumeIface:
- * @g_iface: The parent interface.
* @changed: Changed signal that is emitted when the volume's state has changed.
* @removed: The removed signal that is emitted when the #GVolume have been removed. If the recipient is
holding references to the object they should release them so the object can be finalized.
* @get_name: Gets a string containing the name of the #GVolume.
diff --git a/gobject/gparamspecs.h b/gobject/gparamspecs.h
index 7b6dd2a..ef6bec1 100644
--- a/gobject/gparamspecs.h
+++ b/gobject/gparamspecs.h
@@ -609,7 +609,6 @@ typedef struct _GParamSpecVariant GParamSpecVariant;
/**
* GParamSpecChar:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -626,7 +625,6 @@ struct _GParamSpecChar
};
/**
* GParamSpecUChar:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -643,7 +641,6 @@ struct _GParamSpecUChar
};
/**
* GParamSpecBoolean:
- * @parent_instance: private #GParamSpec portion
* @default_value: default value for the property specified
*
* A #GParamSpec derived structure that contains the meta data for boolean properties.
@@ -656,7 +653,6 @@ struct _GParamSpecBoolean
};
/**
* GParamSpecInt:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -673,7 +669,6 @@ struct _GParamSpecInt
};
/**
* GParamSpecUInt:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -690,7 +685,6 @@ struct _GParamSpecUInt
};
/**
* GParamSpecLong:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -707,7 +701,6 @@ struct _GParamSpecLong
};
/**
* GParamSpecULong:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -724,7 +717,6 @@ struct _GParamSpecULong
};
/**
* GParamSpecInt64:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -741,7 +733,6 @@ struct _GParamSpecInt64
};
/**
* GParamSpecUInt64:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -758,7 +749,6 @@ struct _GParamSpecUInt64
};
/**
* GParamSpecUnichar:
- * @parent_instance: private #GParamSpec portion
* @default_value: default value for the property specified
*
* A #GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties.
@@ -771,7 +761,6 @@ struct _GParamSpecUnichar
};
/**
* GParamSpecEnum:
- * @parent_instance: private #GParamSpec portion
* @enum_class: the #GEnumClass for the enum
* @default_value: default value for the property specified
*
@@ -787,7 +776,6 @@ struct _GParamSpecEnum
};
/**
* GParamSpecFlags:
- * @parent_instance: private #GParamSpec portion
* @flags_class: the #GFlagsClass for the flags
* @default_value: default value for the property specified
*
@@ -803,7 +791,6 @@ struct _GParamSpecFlags
};
/**
* GParamSpecFloat:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -823,7 +810,6 @@ struct _GParamSpecFloat
};
/**
* GParamSpecDouble:
- * @parent_instance: private #GParamSpec portion
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
@@ -843,7 +829,6 @@ struct _GParamSpecDouble
};
/**
* GParamSpecString:
- * @parent_instance: private #GParamSpec portion
* @default_value: default value for the property specified
* @cset_first: a string containing the allowed values for the first byte
* @cset_nth: a string containing the allowed values for the subsequent bytes
@@ -867,7 +852,6 @@ struct _GParamSpecString
};
/**
* GParamSpecParam:
- * @parent_instance: private #GParamSpec portion
*
* A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM
* properties.
@@ -878,7 +862,6 @@ struct _GParamSpecParam
};
/**
* GParamSpecBoxed:
- * @parent_instance: private #GParamSpec portion
*
* A #GParamSpec derived structure that contains the meta data for boxed properties.
*/
@@ -888,7 +871,6 @@ struct _GParamSpecBoxed
};
/**
* GParamSpecPointer:
- * @parent_instance: private #GParamSpec portion
*
* A #GParamSpec derived structure that contains the meta data for pointer properties.
*/
@@ -898,7 +880,6 @@ struct _GParamSpecPointer
};
/**
* GParamSpecValueArray:
- * @parent_instance: private #GParamSpec portion
* @element_spec: a #GParamSpec describing the elements contained in arrays of this property, may be %NULL
* @fixed_n_elements: if greater than 0, arrays of this property will always have this many elements
*
@@ -912,7 +893,6 @@ struct _GParamSpecValueArray
};
/**
* GParamSpecObject:
- * @parent_instance: private #GParamSpec portion
*
* A #GParamSpec derived structure that contains the meta data for object properties.
*/
@@ -942,7 +922,6 @@ struct _GParamSpecOverride
};
/**
* GParamSpecGType:
- * @parent_instance: private #GParamSpec portion
* @is_a_type: a #GType whose subtypes can occur as values
*
* A #GParamSpec derived structure that contains the meta data for #GType properties.
@@ -956,7 +935,6 @@ struct _GParamSpecGType
};
/**
* GParamSpecVariant:
- * @parent_instance: private #GParamSpec portion
* @type: a #GVariantType, or %NULL
* @default_value: a #GVariant, or %NULL
*
diff --git a/gobject/gtypemodule.h b/gobject/gtypemodule.h
index 9c63bac..9597e9d 100644
--- a/gobject/gtypemodule.h
+++ b/gobject/gtypemodule.h
@@ -57,7 +57,6 @@ struct _GTypeModule
/**
* GTypeModuleClass:
- * @parent_class: the parent class
* @load: loads the module and registers one or more types using
* g_type_module_register_type().
* @unload: unloads the module
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]