gst_plugins_base/gst-libs/gst/interfaces/propertyprobe.h
changeset 8 4a7fac7dd34a
parent 0 0e761a78d257
child 30 7e817e7e631c
--- a/gst_plugins_base/gst-libs/gst/interfaces/propertyprobe.h	Fri Mar 19 09:35:09 2010 +0200
+++ b/gst_plugins_base/gst-libs/gst/interfaces/propertyprobe.h	Fri Apr 16 15:15:52 2010 +0300
@@ -35,9 +35,26 @@
 #define GST_PROPERTY_PROBE_GET_IFACE(obj) \
   (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_PROPERTY_PROBE, GstPropertyProbeInterface))
 
+/**
+ * GstPropertyProbe:
+ *
+ * Opaque #GstPropertyProbe data structure.
+ */
 typedef struct _GstPropertyProbe GstPropertyProbe; /* dummy typedef */
+typedef struct _GstPropertyProbeInterface GstPropertyProbeInterface;
 
-typedef struct _GstPropertyProbeInterface {
+/**
+ * GstPropertyProbeInterface:
+ * @klass: parent interface type.
+ * @probe_needed: default signal handler
+ * @get_properties: virtual method to get list of probable properties
+ * @needs_probe: virtual method to tell if probe need update
+ * @probe_property: virtual method to probe a property
+ * @get_values: virtual method to get probe results for a property
+ *
+ * #GstPropertyProbe interface.
+ */
+struct _GstPropertyProbeInterface {
   GTypeInterface klass;
 
   /* signals */
@@ -56,8 +73,9 @@
                                    guint             prop_id,
                                    const GParamSpec *pspec);
 
+  /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
-} GstPropertyProbeInterface;
+};
 #ifdef __SYMBIAN32__
 IMPORT_C
 #endif