doc: Various doc fixes for libgstreamer-base
authorNicolas Dufresne <nicolas.dufresne@collabora.co.uk>
Sun, 14 Jun 2015 14:56:28 +0000 (10:56 -0400)
committerNicolas Dufresne <nicolas.dufresne@collabora.co.uk>
Sun, 14 Jun 2015 14:56:28 +0000 (10:56 -0400)
* Fix function name in sections.txt
* Add few missing or fix miss-named
* Workaround gtk-doc being confused with non typedef
  types (loose track of public/private

docs/libs/gstreamer-libs-sections.txt
libs/gst/base/gstbaseparse.h
libs/gst/net/gstnetcontrolmessagemeta.h
libs/gst/net/gstptpclock.h

index 5e8357d..3ace1b7 100644 (file)
@@ -361,7 +361,7 @@ gst_base_transform_get_allocator
 gst_base_transform_get_buffer_pool
 gst_base_transform_reconfigure_sink
 gst_base_transform_reconfigure_src
-gst_base_transform_update_src
+gst_base_transform_update_src_caps
 
 GST_BASE_TRANSFORM_SINK_NAME
 GST_BASE_TRANSFORM_SRC_NAME
index 94dac21..66c3d04 100644 (file)
@@ -156,6 +156,7 @@ typedef struct _GstBaseParsePrivate GstBaseParsePrivate;
  * The opaque #GstBaseParse data structure.
  */
 struct _GstBaseParse {
+  /*< public >*/
   GstElement     element;
 
   /*< protected >*/
index 94eddba..5c3b965 100644 (file)
@@ -30,7 +30,7 @@ typedef struct _GstNetControlMessageMeta GstNetControlMessageMeta;
 /**
  * GstNetControlMessageMeta:
  * @meta: the parent type
- * @addr: a #GSocketControlMessage stored as metadata
+ * @message: a #GSocketControlMessage stored as metadata
  *
  * Buffer metadata for GSocket control messages, AKA ancillary data attached to
  * data sent across a socket.
index f50b83e..7a85cab 100644 (file)
@@ -43,6 +43,7 @@ typedef struct _GstPtpClockPrivate GstPtpClockPrivate;
 
 /**
  * GstPtpClock:
+ * @clock: parented to #GstSystemClock
  *
  * Opaque #GstPtpClock structure.
  */
@@ -55,6 +56,12 @@ struct _GstPtpClock {
   gpointer _gst_reserved[GST_PADDING];
 };
 
+/**
+ * GstPtpClockClass:
+ * @parent_class: parented to #GstSystemClockClass
+ *
+ * Opaque #GstPtpClockClass structure.
+ */
 struct _GstPtpClockClass {
   GstSystemClockClass parent_class;