From 76424103fe483c6474c040b9248504feae4156e7 Mon Sep 17 00:00:00 2001
From: Wim Taymans <wim.taymans@gmail.com>
Date: Sun, 18 Dec 2005 16:04:41 +0000
Subject: [PATCH] gdp: Documentation updates.

Original commit message from CVS:
* libs/gst/base/gstadapter.c:
* libs/gst/base/gstadapter.h:
* libs/gst/base/gstbasesink.c: (gst_base_sink_class_init),
(gst_base_sink_get_position):
* libs/gst/base/gstbasesink.h:
* libs/gst/base/gstbasesrc.c: (gst_base_src_class_init),
(gst_base_src_default_query), (gst_base_src_default_do_seek),
(gst_base_src_do_seek), (gst_base_src_perform_seek),
(gst_base_src_send_event), (gst_base_src_update_length),
(gst_base_src_get_range), (gst_base_src_loop),
(gst_base_src_start):
* libs/gst/base/gstbasesrc.h:
* libs/gst/base/gstbasetransform.h:
* libs/gst/base/gstcollectpads.h:
* libs/gst/base/gstpushsrc.c:
* libs/gst/base/gstpushsrc.h:
* libs/gst/dataprotocol/dataprotocol.c:
* libs/gst/dataprotocol/dataprotocol.h:
* libs/gst/net/gstnetclientclock.h:
* libs/gst/net/gstnettimeprovider.h:
Documentation updates.
---
 gst/gdp/dataprotocol.c |  4 ++++
 gst/gdp/dataprotocol.h | 42 ++++++++++++++++++++++++++++++++++++------
 2 files changed, 40 insertions(+), 6 deletions(-)

diff --git a/gst/gdp/dataprotocol.c b/gst/gdp/dataprotocol.c
index aaf3d3e..1316682 100644
--- a/gst/gdp/dataprotocol.c
+++ b/gst/gdp/dataprotocol.c
@@ -124,6 +124,8 @@ gst_dp_init (void)
  * gst_dp_header_payload_length:
  * @header: the byte header of the packet array
  *
+ * Get the length of the payload described by @header.
+ *
  * Returns: the length of the payload this header describes.
  */
 guint32
@@ -136,6 +138,8 @@ gst_dp_header_payload_length (const guint8 * header)
  * gst_dp_header_payload_type:
  * @header: the byte header of the packet array
  *
+ * Get the type of the payload described by @header.
+ *
  * Returns: the #GstDPPayloadType the payload this header describes.
  */
 GstDPPayloadType
diff --git a/gst/gdp/dataprotocol.h b/gst/gdp/dataprotocol.h
index a326a91..0f60248 100644
--- a/gst/gdp/dataprotocol.h
+++ b/gst/gdp/dataprotocol.h
@@ -29,14 +29,35 @@
 
 G_BEGIN_DECLS
 
-/* GStreamer Data Protocol Version */
+/**
+ * GST_DP_VERSION_MAJOR:
+ *
+ * The major version number of the GStreamer Data Protocol.
+ */
 #define GST_DP_VERSION_MAJOR 0
+/**
+ * GST_DP_VERSION_MINOR:
+ *
+ * The minor version number of the GStreamer Data Protocol.
+ */
 #define GST_DP_VERSION_MINOR 2
 
-#define GST_DP_HEADER_LENGTH 62 /* header size in bytes */
-
-
-/* header flags */
+/**
+ * GST_DP_HEADER_LENGTH:
+ *
+ * The header size in bytes.
+ */
+#define GST_DP_HEADER_LENGTH 62
+
+/**
+ * GstDPHeaderFlag:
+ * @GST_DP_HEADER_FLAG_NONE: No flag present.
+ * @GST_DP_HEADER_FLAG_CRC_HEADER: a header CRC field is present.
+ * @GST_DP_HEADER_FLAG_CRC_PAYLOAD: a payload CRC field is present.
+ * @GST_DP_HEADER_FLAG_CRC: a CRC for header and payload is present.
+ *
+ * header flags for the dataprotocol.
+ */
 typedef enum {
   GST_DP_HEADER_FLAG_NONE        = 0,
   GST_DP_HEADER_FLAG_CRC_HEADER  = (1 << 0),
@@ -44,7 +65,16 @@ typedef enum {
   GST_DP_HEADER_FLAG_CRC         = (1 << 1) | (1 <<0),
 } GstDPHeaderFlag;
 
-/* payload types */
+/**
+ * GstDPPayloadType:
+ * @GST_DP_PAYLOAD_NONE: Invalid payload type.
+ * @GST_DP_PAYLOAD_BUFFER: #GstBuffer payload packet.
+ * @GST_DP_PAYLOAD_CAPS: #GstCaps payload packet.
+ * @GST_DP_PAYLOAD_EVENT_NONE: First value of #GstEvent payload packets.
+ *
+ * The GDP payload types. a #GstEvent payload type is encoded with the
+ * event type number starting from @GST_DP_PAYLOAD_EVENT_NONE.
+ */
 typedef enum {
   GST_DP_PAYLOAD_NONE            = 0,
   GST_DP_PAYLOAD_BUFFER,
-- 
2.7.4