From 2a7a17ce2be8291080b947a133c01473da32b36f Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sourceforge.net>
Date: Sun, 25 Sep 2005 18:34:49 +0000
Subject: [PATCH] added more docs

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/base/gstbasetransform.h:
* gst/gstindex.h:
added more docs
---
 ChangeLog                        |  7 +++++++
 docs/gst/gstreamer-sections.txt  | 14 ++++++--------
 gst/base/gstbasetransform.h      | 11 ++++++++++-
 gst/gstindex.h                   |  2 ++
 libs/gst/base/gstbasetransform.h | 11 ++++++++++-
 5 files changed, 35 insertions(+), 10 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index ee93a99..011ea3a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2005-09-25  Stefan Kost  <ensonic@users.sf.net>
 
+	* docs/gst/gstreamer-sections.txt:
+	* gst/base/gstbasetransform.h:
+	* gst/gstindex.h:
+	  added more docs
+
+2005-09-25  Stefan Kost  <ensonic@users.sf.net>
+
 	* docs/gst/.cvsignore:
 	* docs/gst/tmpl/.cvsignore:
 	* docs/gst/tmpl/gstpipeline.sgml:
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index d46c813..142fa8b 100644
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -38,7 +38,6 @@ thread_list
 <FILE>gstbin</FILE>
 <TITLE>GstBin</TITLE>
 GstBin
-GstBinClass
 GstBinFlags
 
 GST_BIN_CHILDREN
@@ -415,7 +414,6 @@ GST_PADDING_INIT
 <FILE>gstelement</FILE>
 <TITLE>GstElement</TITLE>
 GstElement
-GstElementClass
 GstElementFlags
 GstState
 GstStateChange
@@ -513,6 +511,7 @@ gst_element_unlink
 gst_element_unlink_many
 gst_element_unlink_pads
 <SUBSECTION Standard>
+GstElementClass
 GST_ELEMENT
 GST_IS_ELEMENT
 GST_ELEMENT_CLASS
@@ -2141,7 +2140,6 @@ gst_xml_get_type
 <TITLE>GstAdapter</TITLE>
 <INCLUDE>gst/base/gstadapter.h</INCLUDE>
 GstAdapter
-GstAdapterClass
 gst_adapter_new
 gst_adapter_clear
 gst_adapter_push
@@ -2151,6 +2149,7 @@ gst_adapter_available
 gst_adapter_available_fast
 gst_adapter_take
 <SUBSECTION Standard>
+GstAdapterClass
 GST_ADAPTER
 GST_IS_ADAPTER
 GST_TYPE_ADAPTER
@@ -2167,7 +2166,6 @@ gst_adapter_get_type
 <TITLE>GstBaseSrc</TITLE>
 <INCLUDE>gst/base/gstbasesrc.h</INCLUDE>
 GstBaseSrc
-GstBaseSrcClass
 GstBaseSrcFlags
 
 gst_base_src_is_live
@@ -2175,6 +2173,7 @@ gst_base_src_set_live
 
 GST_BASE_SRC_PAD
 <SUBSECTION Standard>
+GstBaseSrcClass
 GST_BASE_SRC
 GST_IS_BASE_SRC
 GST_TYPE_BASE_SRC
@@ -2191,7 +2190,6 @@ gst_base_src_get_type
 <TITLE>GstBaseSink</TITLE>
 <INCLUDE>gst/base/gstbasesink.h</INCLUDE>
 GstBaseSink
-GstBaseSinkClass
 
 GST_BASE_SINK_CLOCK
 GST_BASE_SINK_PAD
@@ -2224,7 +2222,6 @@ gst_base_sink_get_type
 <TITLE>GstBaseTransform</TITLE>
 <INCLUDE>gst/base/gstbasetransform.h</INCLUDE>
 GstBaseTransform
-GstBaseTransformClass
 
 gst_base_transform_is_passthrough
 gst_base_transform_set_passthrough
@@ -2235,6 +2232,7 @@ GST_BASE_TRANSFORM_SINK_NAME
 GST_BASE_TRANSFORM_SRC_NAME
 
 <SUBSECTION Standard>
+GstBaseTransformClass
 GST_BASE_TRANSFORM
 GST_IS_BASE_TRANSFORM
 GST_TYPE_BASE_TRANSFORM
@@ -2251,7 +2249,6 @@ gst_base_transform_get_type
 <TITLE>GstCollectPads</TITLE>
 <INCLUDE>gst/base/gstcollectpads.h</INCLUDE>
 GstCollectPads
-GstCollectPadsClass
 GstCollectPadsFunction
 gst_collectpads_new
 gst_collectpads_set_function
@@ -2272,6 +2269,7 @@ GST_COLLECTPADS_GET_COND
 GST_COLLECTPADS_SIGNAL
 GST_COLLECTPADS_WAIT
 <SUBSECTION Standard>
+GstCollectPadsClass
 GST_COLLECTPADS
 GST_IS_COLLECTPADS
 GST_TYPE_COLLECTPADS
@@ -2288,8 +2286,8 @@ gst_collectpads_get_type
 <TITLE>GstPushSrc</TITLE>
 <INCLUDE>gst/base/gstpushsrc.h</INCLUDE>
 GstPushSrc
-GstPushSrcClass
 <SUBSECTION Standard>
+GstPushSrcClass
 GST_PUSH_SRC
 GST_IS_PUSH_SRC
 GST_TYPE_PUSH_SRC
diff --git a/gst/base/gstbasetransform.h b/gst/base/gstbasetransform.h
index 2f42a81..9fe6ce9 100644
--- a/gst/base/gstbasetransform.h
+++ b/gst/base/gstbasetransform.h
@@ -33,8 +33,17 @@ G_BEGIN_DECLS
 #define GST_IS_BASE_TRANSFORM(obj)	(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_TRANSFORM))
 #define GST_IS_BASE_TRANSFORM_CLASS(obj)(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_TRANSFORM))
 
-/* the names of the templates for the sink and source pads */
+/**
+ * GST_BASE_TRANSFORM_SINK_NAME:
+ *
+ * the name of the templates for the sink pad
+ */
 #define GST_BASE_TRANSFORM_SINK_NAME	"sink"
+/**
+ * GST_BASE_TRANSFORM_SRC_NAME:
+ *
+ * the name of the templates for the source pad
+ */
 #define GST_BASE_TRANSFORM_SRC_NAME	"src"
 
 typedef struct _GstBaseTransform GstBaseTransform;
diff --git a/gst/gstindex.h b/gst/gstindex.h
index fbad222..22738d8 100644
--- a/gst/gstindex.h
+++ b/gst/gstindex.h
@@ -193,6 +193,7 @@ typedef enum {
  * The basic element of an index.
  */
 struct _GstIndexEntry {
+  /*< private >*/
   GstIndexEntryType	 type;
   gint			 id;
 
@@ -225,6 +226,7 @@ struct _GstIndexEntry {
  */
 
 struct _GstIndexGroup {
+  /*< private >*/
   /* unique ID of group in index */
   gint groupnum;
 
diff --git a/libs/gst/base/gstbasetransform.h b/libs/gst/base/gstbasetransform.h
index 2f42a81..9fe6ce9 100644
--- a/libs/gst/base/gstbasetransform.h
+++ b/libs/gst/base/gstbasetransform.h
@@ -33,8 +33,17 @@ G_BEGIN_DECLS
 #define GST_IS_BASE_TRANSFORM(obj)	(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_TRANSFORM))
 #define GST_IS_BASE_TRANSFORM_CLASS(obj)(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_TRANSFORM))
 
-/* the names of the templates for the sink and source pads */
+/**
+ * GST_BASE_TRANSFORM_SINK_NAME:
+ *
+ * the name of the templates for the sink pad
+ */
 #define GST_BASE_TRANSFORM_SINK_NAME	"sink"
+/**
+ * GST_BASE_TRANSFORM_SRC_NAME:
+ *
+ * the name of the templates for the source pad
+ */
 #define GST_BASE_TRANSFORM_SRC_NAME	"src"
 
 typedef struct _GstBaseTransform GstBaseTransform;
-- 
2.7.4