doc: Better document new GstCollectData.ABI.abi.dts
authorNicolas Dufresne <nicolas.dufresne@collabora.co.uk>
Sun, 14 Jun 2015 14:58:18 +0000 (10:58 -0400)
committerNicolas Dufresne <nicolas.dufresne@collabora.co.uk>
Sun, 14 Jun 2015 14:58:18 +0000 (10:58 -0400)
The doc generator get confused with the inline structure. So
workaround by wrapping the inner of the structure with
public/private mark, and document that GST_COLLECT_PADS_DTS macro
shall be used to access this.

libs/gst/base/gstcollectpads.h

index 4176530..cfa29eb 100644 (file)
@@ -135,7 +135,8 @@ typedef enum {
  * @buffer: currently queued buffer.
  * @pos: position in the buffer
  * @segment: last segment received.
- * @dts: the signed version of the DTS converted to running time. (Since 1.6)
+ * @dts: the signed version of the DTS converted to running time. To access
+ *       this memeber, use %GST_COLLECT_PADS_DTS macro. (Since 1.6)
  *
  * Structure used by the collect_pads.
  */
@@ -155,12 +156,12 @@ struct _GstCollectData
 
   GstCollectDataPrivate *priv;
 
-  /*< public >*/
   union {
     struct {
+      /*< public >*/
       gint64 dts;
+      /*< private >*/
     } abi;
-    /*< private >*/
     gpointer _gst_reserved[GST_PADDING];
   } ABI;
 };