diff --git a/ChangeLog b/ChangeLog index ee93a9936f..011ea3a07f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2005-09-25 Stefan Kost + + * docs/gst/gstreamer-sections.txt: + * gst/base/gstbasetransform.h: + * gst/gstindex.h: + added more docs + 2005-09-25 Stefan Kost * docs/gst/.cvsignore: diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index d46c813d44..142fa8b00e 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -38,7 +38,6 @@ thread_list gstbin GstBin GstBin -GstBinClass GstBinFlags GST_BIN_CHILDREN @@ -415,7 +414,6 @@ GST_PADDING_INIT gstelement GstElement GstElement -GstElementClass GstElementFlags GstState GstStateChange @@ -513,6 +511,7 @@ gst_element_unlink gst_element_unlink_many gst_element_unlink_pads +GstElementClass GST_ELEMENT GST_IS_ELEMENT GST_ELEMENT_CLASS @@ -2141,7 +2140,6 @@ gst_xml_get_type GstAdapter gst/base/gstadapter.h 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 +GstAdapterClass GST_ADAPTER GST_IS_ADAPTER GST_TYPE_ADAPTER @@ -2167,7 +2166,6 @@ gst_adapter_get_type GstBaseSrc gst/base/gstbasesrc.h GstBaseSrc -GstBaseSrcClass GstBaseSrcFlags gst_base_src_is_live @@ -2175,6 +2173,7 @@ gst_base_src_set_live GST_BASE_SRC_PAD +GstBaseSrcClass GST_BASE_SRC GST_IS_BASE_SRC GST_TYPE_BASE_SRC @@ -2191,7 +2190,6 @@ gst_base_src_get_type GstBaseSink gst/base/gstbasesink.h GstBaseSink -GstBaseSinkClass GST_BASE_SINK_CLOCK GST_BASE_SINK_PAD @@ -2224,7 +2222,6 @@ gst_base_sink_get_type GstBaseTransform gst/base/gstbasetransform.h 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 +GstBaseTransformClass GST_BASE_TRANSFORM GST_IS_BASE_TRANSFORM GST_TYPE_BASE_TRANSFORM @@ -2251,7 +2249,6 @@ gst_base_transform_get_type GstCollectPads gst/base/gstcollectpads.h GstCollectPads -GstCollectPadsClass GstCollectPadsFunction gst_collectpads_new gst_collectpads_set_function @@ -2272,6 +2269,7 @@ GST_COLLECTPADS_GET_COND GST_COLLECTPADS_SIGNAL GST_COLLECTPADS_WAIT +GstCollectPadsClass GST_COLLECTPADS GST_IS_COLLECTPADS GST_TYPE_COLLECTPADS @@ -2288,8 +2286,8 @@ gst_collectpads_get_type GstPushSrc gst/base/gstpushsrc.h GstPushSrc -GstPushSrcClass +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 2f42a817fe..9fe6ce9405 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 fbad22251f..22738d8c66 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 2f42a817fe..9fe6ce9405 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;