docs: add missing documentation for various pieces

gst-libs/gst/audio/gstringbuffer.h

@@ -116,6 +116,53 @@ typedef enum
   GST_BUFTYPE_MPEG4_AAC,
 } GstBufferFormatType;
 
+/**
+ * GstBufferFormat:
+ * @GST_UNKNOWN: unspecified
+ * @GST_S8: integer signed 8 bit
+ * @GST_U8: integer unsigned 8 bit
+ * @GST_S16_LE: integer signed 16 bit little endian
+ * @GST_S16_BE: integer signed 16 bit big endian
+ * @GST_U16_LE: integer unsigned 16 bit little endian
+ * @GST_U16_BE: integer unsigned 16 bit big endian
+ * @GST_S24_LE: integer signed 24 bit little endian
+ * @GST_S24_BE: integer signed 24 bit big endian
+ * @GST_U24_LE: integer unsigned 24 bit little endian
+ * @GST_U24_BE: integer unsigned 24 bit big endian
+ * @GST_S32_LE: integer signed 32 bit little endian
+ * @GST_S32_BE: integer signed 32 bit big endian
+ * @GST_U32_LE: integer unsigned 32 bit little endian
+ * @GST_U32_BE: integer unsigned 32 bit big endian
+ * @GST_S24_3LE: integer signed 24 bit little endian packed in 3 bytes
+ * @GST_S24_3BE: integer signed 24 bit big endian packed in 3 bytes
+ * @GST_U24_3LE: integer unsigned 24 bit little endian packed in 3 bytes
+ * @GST_U24_3BE: integer unsigned 24 bit big endian packed in 3 bytes
+ * @GST_S20_3LE: integer signed 20 bit little endian packed in 3 bytes
+ * @GST_S20_3BE: integer signed 20 bit big endian packed in 3 bytes
+ * @GST_U20_3LE: integer unsigned 20 bit little endian packed in 3 bytes
+ * @GST_U20_3BE: integer unsigned 20 bit big endian packed in 3 bytes
+ * @GST_S18_3LE: integer signed 18 bit little endian packed in 3 bytes
+ * @GST_S18_3BE: integer signed 18 bit big endian packed in 3 bytes
+ * @GST_U18_3LE: integer unsigned 18 bit little endian packed in 3 bytes
+ * @GST_U18_3BE: integer unsigned 18 bit big endian packed in 3 bytes
+ * @GST_FLOAT32_LE: floating 32 bit little endian
+ * @GST_FLOAT32_BE: floating 32 bit big endian
+ * @GST_FLOAT64_LE: floating 64 bit little endian
+ * @GST_FLOAT64_BE: floating 64 bit big endian
+ * @GST_MU_LAW: mu-law
+ * @GST_A_LAW: a-law
+ * @GST_IMA_ADPCM: ima adpcm
+ * @GST_MPEG: mpeg audio (but not aac)
+ * @GST_GSM: gsm
+ * @GST_IEC958: IEC958 frames
+ * @GST_AC3: ac3
+ * @GST_EAC3: eac3
+ * @GST_DTS: dts
+ * @GST_MPEG2_AAC: mpeg-2 aac
+ * @GST_MPEG4_AAC: mpeg-4 aac
+ *
+ * The detailed format of the samples in the ringbuffer.
+ */
 typedef enum
 {
   GST_UNKNOWN,

gst-libs/gst/cdda/gstcddabasesrc.h

@@ -115,6 +115,17 @@ struct _GstCddaBaseSrc {
   gpointer              _gst_reserved2[GST_PADDING/2];
 };
 
+/**
+ * GstCddaBaseSrcClass:
+ * @pushsrc_class: the parent class
+ * @open: opening the device
+ * @close: closing the device
+ * @read_sector: reading a sector
+ * @get_default_device: getting the default device
+ * @probe_devices: probing possible devices
+ *
+ * Cdda source base class.
+ */
 struct _GstCddaBaseSrcClass {
   GstPushSrcClass pushsrc_class;
 

gst-libs/gst/interfaces/colorbalance.h

@@ -66,6 +66,17 @@ typedef enum
   GST_COLOR_BALANCE_SOFTWARE
 } GstColorBalanceType;
 
+/**
+ * GstColorBalanceClass:
+ * @klass: the parent interface
+ * @balance_type: implementation type
+ * @list_channels: list handled channels
+ * @set_value: set a channel value
+ * @get_value: get a channel value
+ * @value_changed: default handler for value changed notification
+ *
+ * Color-balance interface.
+ */
 struct _GstColorBalanceClass {
   GTypeInterface klass;
 
@@ -85,6 +96,7 @@ struct _GstColorBalanceClass {
                           GstColorBalanceChannel *channel,
                           gint                    value);
 
+  /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
 

gst-libs/gst/interfaces/colorbalancechannel.h

@@ -57,7 +57,13 @@ struct _GstColorBalanceChannel {
   gint    max_value;
 };
 
-
+/**
+ * GstColorBalanceChannelClass:
+ * @parent: the parent interface
+ * @value_changed: default handler for value changed notification
+ *
+ * Color-balance channel class.
+ */
 struct _GstColorBalanceChannelClass {
   GObjectClass parent;
 
@@ -65,6 +71,7 @@ struct _GstColorBalanceChannelClass {
   void (* value_changed) (GstColorBalanceChannel *channel,
                           gint                    value);
 
+  /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
 

gst-libs/gst/interfaces/mixer.h

@@ -47,6 +47,13 @@ G_BEGIN_DECLS
 typedef struct _GstMixer GstMixer;
 typedef struct _GstMixerClass GstMixerClass;
 
+/**
+ * GstMixerType:
+ * @GST_MIXER_HARDWARE: mixing is implemented with dedicated hardware.
+ * @GST_MIXER_SOFTWARE: mixing is implemented via software processing.
+ *
+ * Mixer classification.
+ */
 typedef enum
 {
   GST_MIXER_HARDWARE,

gst-libs/gst/interfaces/mixeroptions.h

@@ -49,22 +49,25 @@ typedef struct _GstMixerOptionsClass GstMixerOptionsClass;
 
 /**
  * GstMixerOptions:
- * @parent: Parent object
  * @values: List of option strings. Do not access this member directly,
  *     always use gst_mixer_options_get_values() instead.
+ *
+ * Mixer control object.
  */
 struct _GstMixerOptions {
   GstMixerTrack parent;
 
+  /*< public >*/
   /* list of strings (do not access directly) (FIXME 0.11: make private) */
   GList        *values;
 
+  /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
 
 /**
  * GstMixerOptionsClass:
- * @parent: Parent class
+ * @parent: the parent interface
  * @get_values: Optional implementation of gst_mixer_options_get_values().
  *    (Since: 0.10.18)
  */

gst-libs/gst/interfaces/navigation.h

@@ -39,12 +39,20 @@ G_BEGIN_DECLS
 typedef struct _GstNavigation GstNavigation;
 typedef struct _GstNavigationInterface GstNavigationInterface;
 
+/**
+ * GstNavigationInterface:
+ * @g_iface: the parent interface
+ * @send_event: sending a navigation event
+ *
+ * Color-balance interface.
+ */
 struct _GstNavigationInterface {
   GTypeInterface g_iface;
 
   /* virtual functions */
   void (*send_event) (GstNavigation *navigation, GstStructure *structure);
-  
+
+  /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
 
@@ -109,7 +117,7 @@ typedef enum {
   GST_NAVIGATION_COMMAND_MENU5    = 5,
   GST_NAVIGATION_COMMAND_MENU6    = 6,
   GST_NAVIGATION_COMMAND_MENU7    = 7,
-  
+
   GST_NAVIGATION_COMMAND_LEFT     = 20,
   GST_NAVIGATION_COMMAND_RIGHT    = 21,
   GST_NAVIGATION_COMMAND_UP       = 22,
@@ -130,6 +138,14 @@ typedef enum {
 #define GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU    GST_NAVIGATION_COMMAND_MENU7
 
 /* Queries */
+/**
+ * GstNavigationQueryType:
+ * @GST_NAVIGATION_QUERY_INVALID: invalid query
+ * @GST_NAVIGATION_QUERY_COMMANDS: command query
+ * @GST_NAVIGATION_QUERY_ANGLES: viewing angle query
+ *
+ * Tyoes of navigation interface queries.
+ */
 typedef enum
 {
   GST_NAVIGATION_QUERY_INVALID     = 0,
@@ -245,9 +261,9 @@ gboolean gst_navigation_event_parse_command (GstEvent *event,
 /* interface virtual function wrappers */
 void gst_navigation_send_event (GstNavigation *navigation,
         GstStructure *structure);
-void gst_navigation_send_key_event (GstNavigation *navigation, 
+void gst_navigation_send_key_event (GstNavigation *navigation,
         const char *event, const char *key);
-void gst_navigation_send_mouse_event (GstNavigation *navigation, 
+void gst_navigation_send_mouse_event (GstNavigation *navigation,
         const char *event, int button, double x, double y);
 void gst_navigation_send_command (GstNavigation *navigation,
         GstNavigationCommand command);

gst-libs/gst/interfaces/tuner.h

@@ -45,6 +45,25 @@ G_BEGIN_DECLS
 typedef struct _GstTuner GstTuner;
 typedef struct _GstTunerClass GstTunerClass;
 
+/**
+ * GstTunerClass:
+ * @klass: the parent interface
+ * @list_channels: list available channels
+ * @set_channel: set to a channel
+ * @get_channel: return the current channel
+ * @list_norms: list available norms
+ * @set_norm: set a norm
+ * @get_norm: return the current norm
+ * @set_frequency: set the frequency
+ * @get_frequency: return the current frequency
+ * @signal_strength: get the signal strength
+ * @channel_changed: default handler for channel changed notification
+ * @norm_changed: default handler for norm changed notification
+ * @frequency_changed: default handler for frequency changed notification
+ * @signal_changed: default handler for signal-strength changed notification
+ *
+ * Tuner interface.
+ */
 struct _GstTunerClass {
   GTypeInterface klass;
 
@@ -80,6 +99,7 @@ struct _GstTunerClass {
                              GstTunerChannel *channel,
                              gint             signal);
 
+  /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
 

gst-libs/gst/video/gstvideofilter.h

@@ -47,6 +47,12 @@ struct _GstVideoFilter {
   gboolean inited;
 };
 
+/**
+ * GstVideoFilterClass:
+ * @parent_class: the parent class structure
+ *
+ * The video filter class structure.
+ */
 struct _GstVideoFilterClass {
   GstBaseTransformClass parent_class;
 };

gst-libs/gst/video/gstvideosink.h

@@ -27,7 +27,7 @@
 #include <gst/base/gstbasesink.h>
 
 G_BEGIN_DECLS
-  
+
 #define GST_TYPE_VIDEO_SINK (gst_video_sink_get_type())
 #define GST_VIDEO_SINK(obj) \
   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VIDEO_SINK, GstVideoSink))
@@ -60,7 +60,7 @@ G_BEGIN_DECLS
 
 #define GST_VIDEO_SINK_WIDTH(obj) (GST_VIDEO_SINK_CAST (obj)->width)
 #define GST_VIDEO_SINK_HEIGHT(obj) (GST_VIDEO_SINK_CAST (obj)->height)
-  
+
 typedef struct _GstVideoSink GstVideoSink;
 typedef struct _GstVideoSinkClass GstVideoSinkClass;
 typedef struct _GstVideoRectangle GstVideoRectangle;
@@ -84,7 +84,6 @@ struct _GstVideoRectangle {
 
 /**
  * GstVideoSink:
- * @element: the parent object structure (which is GstBaseSink)
  * @height: video height (derived class needs to set this)
  * @width: video width (derived class needs to set this)
  *
@@ -93,9 +92,10 @@ struct _GstVideoRectangle {
  */
 struct _GstVideoSink {
   GstBaseSink element;    /* FIXME 0.11: this should not be called 'element' */
-  
+
+  /*< public >*/
   gint width, height;
-  
+
   /*< private >*/
   GstVideoSinkPrivate *priv;