doc: Better document new GstCollectData.ABI.abi.dts

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.
This commit is contained in:
Nicolas Dufresne 2015-06-14 10:58:18 -04:00
parent 0e0a0c1b11
commit e6ec142084

View file

@ -135,7 +135,8 @@ typedef enum {
* @buffer: currently queued buffer. * @buffer: currently queued buffer.
* @pos: position in the buffer * @pos: position in the buffer
* @segment: last segment received. * @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. * Structure used by the collect_pads.
*/ */
@ -155,12 +156,12 @@ struct _GstCollectData
GstCollectDataPrivate *priv; GstCollectDataPrivate *priv;
/*< public >*/
union { union {
struct { struct {
/*< public >*/
gint64 dts; gint64 dts;
/*< private >*/
} abi; } abi;
/*< private >*/
gpointer _gst_reserved[GST_PADDING]; gpointer _gst_reserved[GST_PADDING];
} ABI; } ABI;
}; };