added more docs

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/base/gstbasetransform.h:
* gst/gstindex.h:
added more docs
This commit is contained in:
Stefan Kost 2005-09-25 18:34:49 +00:00
parent 788bac107d
commit 2a7a17ce2b
5 changed files with 35 additions and 10 deletions

View file

@ -1,3 +1,10 @@
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> 2005-09-25 Stefan Kost <ensonic@users.sf.net>
* docs/gst/.cvsignore: * docs/gst/.cvsignore:

View file

@ -38,7 +38,6 @@ thread_list
<FILE>gstbin</FILE> <FILE>gstbin</FILE>
<TITLE>GstBin</TITLE> <TITLE>GstBin</TITLE>
GstBin GstBin
GstBinClass
GstBinFlags GstBinFlags
GST_BIN_CHILDREN GST_BIN_CHILDREN
@ -415,7 +414,6 @@ GST_PADDING_INIT
<FILE>gstelement</FILE> <FILE>gstelement</FILE>
<TITLE>GstElement</TITLE> <TITLE>GstElement</TITLE>
GstElement GstElement
GstElementClass
GstElementFlags GstElementFlags
GstState GstState
GstStateChange GstStateChange
@ -513,6 +511,7 @@ gst_element_unlink
gst_element_unlink_many gst_element_unlink_many
gst_element_unlink_pads gst_element_unlink_pads
<SUBSECTION Standard> <SUBSECTION Standard>
GstElementClass
GST_ELEMENT GST_ELEMENT
GST_IS_ELEMENT GST_IS_ELEMENT
GST_ELEMENT_CLASS GST_ELEMENT_CLASS
@ -2141,7 +2140,6 @@ gst_xml_get_type
<TITLE>GstAdapter</TITLE> <TITLE>GstAdapter</TITLE>
<INCLUDE>gst/base/gstadapter.h</INCLUDE> <INCLUDE>gst/base/gstadapter.h</INCLUDE>
GstAdapter GstAdapter
GstAdapterClass
gst_adapter_new gst_adapter_new
gst_adapter_clear gst_adapter_clear
gst_adapter_push gst_adapter_push
@ -2151,6 +2149,7 @@ gst_adapter_available
gst_adapter_available_fast gst_adapter_available_fast
gst_adapter_take gst_adapter_take
<SUBSECTION Standard> <SUBSECTION Standard>
GstAdapterClass
GST_ADAPTER GST_ADAPTER
GST_IS_ADAPTER GST_IS_ADAPTER
GST_TYPE_ADAPTER GST_TYPE_ADAPTER
@ -2167,7 +2166,6 @@ gst_adapter_get_type
<TITLE>GstBaseSrc</TITLE> <TITLE>GstBaseSrc</TITLE>
<INCLUDE>gst/base/gstbasesrc.h</INCLUDE> <INCLUDE>gst/base/gstbasesrc.h</INCLUDE>
GstBaseSrc GstBaseSrc
GstBaseSrcClass
GstBaseSrcFlags GstBaseSrcFlags
gst_base_src_is_live gst_base_src_is_live
@ -2175,6 +2173,7 @@ gst_base_src_set_live
GST_BASE_SRC_PAD GST_BASE_SRC_PAD
<SUBSECTION Standard> <SUBSECTION Standard>
GstBaseSrcClass
GST_BASE_SRC GST_BASE_SRC
GST_IS_BASE_SRC GST_IS_BASE_SRC
GST_TYPE_BASE_SRC GST_TYPE_BASE_SRC
@ -2191,7 +2190,6 @@ gst_base_src_get_type
<TITLE>GstBaseSink</TITLE> <TITLE>GstBaseSink</TITLE>
<INCLUDE>gst/base/gstbasesink.h</INCLUDE> <INCLUDE>gst/base/gstbasesink.h</INCLUDE>
GstBaseSink GstBaseSink
GstBaseSinkClass
GST_BASE_SINK_CLOCK GST_BASE_SINK_CLOCK
GST_BASE_SINK_PAD GST_BASE_SINK_PAD
@ -2224,7 +2222,6 @@ gst_base_sink_get_type
<TITLE>GstBaseTransform</TITLE> <TITLE>GstBaseTransform</TITLE>
<INCLUDE>gst/base/gstbasetransform.h</INCLUDE> <INCLUDE>gst/base/gstbasetransform.h</INCLUDE>
GstBaseTransform GstBaseTransform
GstBaseTransformClass
gst_base_transform_is_passthrough gst_base_transform_is_passthrough
gst_base_transform_set_passthrough gst_base_transform_set_passthrough
@ -2235,6 +2232,7 @@ GST_BASE_TRANSFORM_SINK_NAME
GST_BASE_TRANSFORM_SRC_NAME GST_BASE_TRANSFORM_SRC_NAME
<SUBSECTION Standard> <SUBSECTION Standard>
GstBaseTransformClass
GST_BASE_TRANSFORM GST_BASE_TRANSFORM
GST_IS_BASE_TRANSFORM GST_IS_BASE_TRANSFORM
GST_TYPE_BASE_TRANSFORM GST_TYPE_BASE_TRANSFORM
@ -2251,7 +2249,6 @@ gst_base_transform_get_type
<TITLE>GstCollectPads</TITLE> <TITLE>GstCollectPads</TITLE>
<INCLUDE>gst/base/gstcollectpads.h</INCLUDE> <INCLUDE>gst/base/gstcollectpads.h</INCLUDE>
GstCollectPads GstCollectPads
GstCollectPadsClass
GstCollectPadsFunction GstCollectPadsFunction
gst_collectpads_new gst_collectpads_new
gst_collectpads_set_function gst_collectpads_set_function
@ -2272,6 +2269,7 @@ GST_COLLECTPADS_GET_COND
GST_COLLECTPADS_SIGNAL GST_COLLECTPADS_SIGNAL
GST_COLLECTPADS_WAIT GST_COLLECTPADS_WAIT
<SUBSECTION Standard> <SUBSECTION Standard>
GstCollectPadsClass
GST_COLLECTPADS GST_COLLECTPADS
GST_IS_COLLECTPADS GST_IS_COLLECTPADS
GST_TYPE_COLLECTPADS GST_TYPE_COLLECTPADS
@ -2288,8 +2286,8 @@ gst_collectpads_get_type
<TITLE>GstPushSrc</TITLE> <TITLE>GstPushSrc</TITLE>
<INCLUDE>gst/base/gstpushsrc.h</INCLUDE> <INCLUDE>gst/base/gstpushsrc.h</INCLUDE>
GstPushSrc GstPushSrc
GstPushSrcClass
<SUBSECTION Standard> <SUBSECTION Standard>
GstPushSrcClass
GST_PUSH_SRC GST_PUSH_SRC
GST_IS_PUSH_SRC GST_IS_PUSH_SRC
GST_TYPE_PUSH_SRC GST_TYPE_PUSH_SRC

View file

@ -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(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)) #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" #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" #define GST_BASE_TRANSFORM_SRC_NAME "src"
typedef struct _GstBaseTransform GstBaseTransform; typedef struct _GstBaseTransform GstBaseTransform;

View file

@ -193,6 +193,7 @@ typedef enum {
* The basic element of an index. * The basic element of an index.
*/ */
struct _GstIndexEntry { struct _GstIndexEntry {
/*< private >*/
GstIndexEntryType type; GstIndexEntryType type;
gint id; gint id;
@ -225,6 +226,7 @@ struct _GstIndexEntry {
*/ */
struct _GstIndexGroup { struct _GstIndexGroup {
/*< private >*/
/* unique ID of group in index */ /* unique ID of group in index */
gint groupnum; gint groupnum;

View file

@ -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(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)) #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" #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" #define GST_BASE_TRANSFORM_SRC_NAME "src"
typedef struct _GstBaseTransform GstBaseTransform; typedef struct _GstBaseTransform GstBaseTransform;