diff options
author | Thomas Vander Stichele <thomas@apestaart.org> | 2005-06-19 10:54:12 +0000 |
---|---|---|
committer | Thomas Vander Stichele <thomas@apestaart.org> | 2005-06-19 10:54:12 +0000 |
commit | 0944ac134b54042e811616ee51fcf851cdd4a6b5 (patch) | |
tree | 8ed1a3ec888428b7e2038e518c482c5021c1b722 | |
parent | 67fcf372098844f0e42cebfab674a51f2fdef4d6 (diff) |
some more docs cleanup
Original commit message from CVS:
some more docs cleanup
-rw-r--r-- | docs/gst/gstreamer-sections.txt | 79 | ||||
-rw-r--r-- | docs/gst/tmpl/gstbin.sgml | 63 | ||||
-rw-r--r-- | docs/gst/tmpl/gstbuffer.sgml | 84 | ||||
-rw-r--r-- | docs/gst/tmpl/gstcaps.sgml | 58 | ||||
-rw-r--r-- | docs/gst/tmpl/gststructure.sgml | 22 | ||||
-rw-r--r-- | gst/gstbin.h | 8 | ||||
-rw-r--r-- | gst/gstbuffer.h | 2 |
7 files changed, 183 insertions, 133 deletions
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 565c4ea4a..b833bc30a 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -4,6 +4,10 @@ # <SECTION> # <FILE>gstxxx</FILE> # <TITLE>GstXxx</TITLE> +# typedefs +# macros +# constructor +# methods # <SUBSECTION Standard> # <SUBSECTION Private> # </SECTION> @@ -18,10 +22,6 @@ gst_init_check gst_init_with_popt_table gst_init_check_with_popt_table gst_init_get_popt_table -gst_use_threads -gst_has_threads -gst_main -gst_main_quit <SUBSECTION Private> #GstPoptOption </SECTION> @@ -31,22 +31,24 @@ gst_main_quit <TITLE>GstBin</TITLE> GstBin GstBinFlags + gst_bin_new gst_bin_add -gst_bin_add_many gst_bin_remove -gst_bin_remove_many + gst_bin_get_by_name gst_bin_get_by_name_recurse_up -gst_bin_get_list gst_bin_get_by_interface -gst_bin_get_all_by_interface -gst_bin_iterate -gst_bin_use_clock -gst_bin_get_clock -gst_bin_auto_clock -gst_bin_sync_children_state -gst_bin_child_state_change + +gst_bin_iterate_elements +gst_bin_iterate_recurse +gst_bin_iterate_sinks +gst_bin_iterate_all_by_interface + +<SUBSECTION> +gst_bin_add_many +gst_bin_remove_many + <SUBSECTION Standard> GstBinClass GST_BIN @@ -56,15 +58,18 @@ GST_BIN_CLASS GST_IS_BIN_CLASS GST_BIN_GET_CLASS GST_TYPE_BIN_FLAGS + <SUBSECTION Private> gst_bin_get_type gst_bin_flags_get_type + </SECTION> <SECTION> <FILE>gstbuffer</FILE> <TITLE>GstBuffer</TITLE> GstBuffer + gst_buffer_new gst_buffer_new_and_alloc @@ -77,42 +82,37 @@ GST_BUFFER_FLAG_UNSET gst_buffer_set_data GST_BUFFER_DATA GST_BUFFER_SIZE -GST_BUFFER_MAXSIZE GST_BUFFER_TIMESTAMP GST_BUFFER_DURATION GST_BUFFER_OFFSET GST_BUFFER_OFFSET_END gst_buffer_ref -gst_buffer_ref_by_count gst_buffer_unref -gst_buffer_stamp + gst_buffer_copy gst_buffer_is_writable -gst_buffer_copy_on_write +gst_buffer_make_writable +gst_buffer_replace + +gst_buffer_get_caps +gst_buffer_set_caps + gst_buffer_create_sub -gst_buffer_join -gst_buffer_merge -gst_buffer_span gst_buffer_is_span_fast -gst_buffer_default_free -gst_buffer_default_copy +gst_buffer_span GST_BUFFER_TRACE_NAME -GST_BUFFER_REFCOUNT -GST_BUFFER_REFCOUNT_VALUE -GST_BUFFER_COPY_FUNC -GST_BUFFER_FREE_FUNC -GST_BUFFER_FREE_DATA_FUNC -GstBufferFreeDataFunc -GST_BUFFER_PRIVATE GST_BUFFER_OFFSET_NONE -GST_BUFFER_MAXSIZE_NONE GST_BUFFER_DURATION_IS_VALID GST_BUFFER_TIMESTAMP_IS_VALID GST_BUFFER_OFFSET_IS_VALID GST_BUFFER_OFFSET_END_IS_VALID -GST_BUFFER_MAXSIZE_IS_VALID + +<SUBSECTION> +gst_buffer_stamp +gst_buffer_join +gst_buffer_merge <SUBSECTION Standard> GST_BUFFER @@ -127,6 +127,9 @@ gst_buffer_flag_get_type <SECTION> <FILE>gstcaps</FILE> <TITLE>GstCaps</TITLE> +GstCaps +GstStaticCaps + GST_CAPS_FLAGS_ANY GST_CAPS_ANY GST_CAPS_NONE @@ -136,44 +139,34 @@ GST_CAPS_IS_SIMPLE gst_caps_is_simple GST_DEBUG_CAPS GST_STATIC_CAPS -GstCaps -GstStaticCaps gst_caps_new_empty gst_caps_new_any gst_caps_new_simple gst_caps_new_full gst_caps_new_full_valist gst_caps_copy -gst_caps_free gst_static_caps_get gst_caps_append gst_caps_append_structure -gst_caps_split_one gst_caps_get_size gst_caps_get_structure -gst_caps_copy_1 gst_caps_set_simple gst_caps_set_simple_valist gst_caps_is_any gst_caps_is_empty -gst_caps_is_chained gst_caps_is_fixed gst_caps_is_equal -gst_caps_is_equal_fixed gst_caps_is_always_compatible gst_caps_is_subset gst_caps_intersect gst_caps_union gst_caps_normalize -gst_caps_simplify gst_caps_do_simplify gst_caps_save_thyself gst_caps_load_thyself gst_caps_replace gst_caps_to_string gst_caps_from_string -gst_caps_structure_fixate_field_nearest_int -gst_caps_structure_fixate_field_nearest_double gst_caps_subtract <SUBSECTION Standard> GST_CAPS @@ -1423,6 +1416,8 @@ gst_structure_get_double gst_structure_get_string gst_structure_to_string gst_structure_from_string +gst_caps_structure_fixate_field_nearest_int +gst_caps_structure_fixate_field_nearest_double <SUBSECTION Standard> GST_STRUCTURE GST_IS_STRUCTURE diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 74c7a5308..3a2cac717 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -106,57 +106,74 @@ Will be emmited if an element was removed from this bin. @Returns: -<!-- ##### FUNCTION gst_bin_add_many ##### --> +<!-- ##### FUNCTION gst_bin_remove ##### --> <para> </para> @bin: -@element_1: -@Varargs: +@element: +@Returns: -<!-- ##### FUNCTION gst_bin_remove ##### --> +<!-- ##### FUNCTION gst_bin_get_by_name ##### --> <para> </para> @bin: -@element: +@name: @Returns: -<!-- ##### FUNCTION gst_bin_remove_many ##### --> +<!-- ##### FUNCTION gst_bin_get_by_name_recurse_up ##### --> <para> </para> @bin: -@element_1: -@Varargs: +@name: +@Returns: -<!-- ##### FUNCTION gst_bin_get_by_name ##### --> +<!-- ##### FUNCTION gst_bin_get_by_interface ##### --> <para> </para> @bin: -@name: +@interface: @Returns: -<!-- ##### FUNCTION gst_bin_get_by_name_recurse_up ##### --> +<!-- ##### FUNCTION gst_bin_iterate_elements ##### --> <para> </para> @bin: -@name: @Returns: -<!-- ##### FUNCTION gst_bin_get_by_interface ##### --> +<!-- ##### FUNCTION gst_bin_iterate_recurse ##### --> +<para> + +</para> + +@bin: +@Returns: + + +<!-- ##### FUNCTION gst_bin_iterate_sinks ##### --> +<para> + +</para> + +@bin: +@Returns: + + +<!-- ##### FUNCTION gst_bin_iterate_all_by_interface ##### --> <para> </para> @@ -166,3 +183,23 @@ Will be emmited if an element was removed from this bin. @Returns: +<!-- ##### FUNCTION gst_bin_add_many ##### --> +<para> + +</para> + +@bin: +@element_1: +@Varargs: + + +<!-- ##### FUNCTION gst_bin_remove_many ##### --> +<para> + +</para> + +@bin: +@element_1: +@Varargs: + + diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index cd5641d7c..44c37de1f 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -241,15 +241,6 @@ will be freed. @buf: a #GstBuffer to unref. -<!-- ##### FUNCTION gst_buffer_stamp ##### --> -<para> - -</para> - -@dest: -@src: - - <!-- ##### MACRO gst_buffer_copy ##### --> <para> Copies the given buffer using the copy function of the parent GstData structure. @@ -267,46 +258,49 @@ Tests if you can safely write data into a buffer's data array. @buf: a #GstBuffer to check -<!-- ##### FUNCTION gst_buffer_create_sub ##### --> +<!-- ##### MACRO gst_buffer_make_writable ##### --> <para> </para> -@parent: -@offset: -@size: -@Returns: +@buf: -<!-- ##### FUNCTION gst_buffer_join ##### --> +<!-- ##### MACRO gst_buffer_replace ##### --> <para> </para> -@buf1: -@buf2: -@Returns: +@obuf: +@nbuf: -<!-- ##### FUNCTION gst_buffer_merge ##### --> +<!-- ##### FUNCTION gst_buffer_get_caps ##### --> <para> </para> -@buf1: -@buf2: +@buffer: @Returns: -<!-- ##### FUNCTION gst_buffer_span ##### --> +<!-- ##### FUNCTION gst_buffer_set_caps ##### --> <para> </para> -@buf1: +@buffer: +@caps: + + +<!-- ##### FUNCTION gst_buffer_create_sub ##### --> +<para> + +</para> + +@parent: @offset: -@buf2: -@len: +@size: @Returns: @@ -320,21 +314,26 @@ Tests if you can safely write data into a buffer's data array. @Returns: -<!-- ##### MACRO GST_BUFFER_TRACE_NAME ##### --> +<!-- ##### FUNCTION gst_buffer_span ##### --> <para> -The name used for tracing memory allocations + </para> +@buf1: +@offset: +@buf2: +@len: +@Returns: -<!-- ##### MACRO GST_BUFFER_OFFSET_NONE ##### --> +<!-- ##### MACRO GST_BUFFER_TRACE_NAME ##### --> <para> - +The name used for tracing memory allocations </para> -<!-- ##### MACRO GST_BUFFER_MAXSIZE_NONE ##### --> +<!-- ##### MACRO GST_BUFFER_OFFSET_NONE ##### --> <para> </para> @@ -373,11 +372,32 @@ Tests if the timestamp is known. @buffer: -<!-- ##### MACRO GST_BUFFER_MAXSIZE_IS_VALID ##### --> +<!-- ##### FUNCTION gst_buffer_stamp ##### --> <para> </para> -@buffer: +@dest: +@src: + + +<!-- ##### FUNCTION gst_buffer_join ##### --> +<para> + +</para> + +@buf1: +@buf2: +@Returns: + + +<!-- ##### FUNCTION gst_buffer_merge ##### --> +<para> + +</para> + +@buf1: +@buf2: +@Returns: diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index a3ff6729b..853fd34c6 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -14,6 +14,24 @@ Structure describing sets of media formats </para> +<!-- ##### STRUCT GstCaps ##### --> +<para> + +</para> + +@type: +@refcount: +@flags: +@structs: + +<!-- ##### STRUCT GstStaticCaps ##### --> +<para> + +</para> + +@caps: +@string: + <!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### --> <para> Flags that this caps has no specific content, but can contain anything. @@ -91,24 +109,6 @@ templates. @Returns: a new #GstCaps instance -<!-- ##### STRUCT GstCaps ##### --> -<para> - -</para> - -@type: -@refcount: -@flags: -@structs: - -<!-- ##### STRUCT GstStaticCaps ##### --> -<para> - -</para> - -@caps: -@string: - <!-- ##### FUNCTION gst_caps_new_empty ##### --> <para> @@ -376,28 +376,6 @@ templates. @Returns: -<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### --> -<para> - -</para> - -@structure: -@field_name: -@target: -@Returns: - - -<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### --> -<para> - -</para> - -@structure: -@field_name: -@target: -@Returns: - - <!-- ##### FUNCTION gst_caps_subtract ##### --> <para> diff --git a/docs/gst/tmpl/gststructure.sgml b/docs/gst/tmpl/gststructure.sgml index 827f34523..bdff1852e 100644 --- a/docs/gst/tmpl/gststructure.sgml +++ b/docs/gst/tmpl/gststructure.sgml @@ -368,3 +368,25 @@ Generic structure containing fields of names and values @Returns: +<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### --> +<para> + +</para> + +@structure: +@field_name: +@target: +@Returns: + + +<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### --> +<para> + +</para> + +@structure: +@field_name: +@target: +@Returns: + + diff --git a/gst/gstbin.h b/gst/gstbin.h index 6f0d94818..91c22348a 100644 --- a/gst/gstbin.h +++ b/gst/gstbin.h @@ -72,13 +72,13 @@ typedef enum { #define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie); struct _GstBin { - GstElement element; + GstElement element; /*< public >*/ /* with LOCK */ /* our children, subclass are supposed to update these * fields to reflect their state with _iterate_*() */ - gint numchildren; - GList *children; + gint numchildren; + GList *children; guint32 children_cookie; /*< private >*/ @@ -118,7 +118,7 @@ GstElement* gst_bin_get_by_interface (GstBin *bin, GType interface); GstIterator* gst_bin_iterate_elements (GstBin *bin); GstIterator* gst_bin_iterate_recurse (GstBin *bin); -GstIterator* gst_bin_iterate_sinks (GstBin *bin); +GstIterator* gst_bin_iterate_sinks (GstBin *bin); GstIterator* gst_bin_iterate_all_by_interface (GstBin *bin, GType interface); G_END_DECLS diff --git a/gst/gstbuffer.h b/gst/gstbuffer.h index 909cc0643..7105b18cf 100644 --- a/gst/gstbuffer.h +++ b/gst/gstbuffer.h @@ -58,13 +58,11 @@ typedef struct _GstBufferClass GstBufferClass; #define GST_BUFFER_MALLOCDATA(buf) (GST_BUFFER(buf)->malloc_data) #define GST_BUFFER_OFFSET_NONE ((guint64)-1) -#define GST_BUFFER_MAXSIZE_NONE ((guint)0) #define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer))) #define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer))) #define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE) #define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE) -#define GST_BUFFER_MAXSIZE_IS_VALID(buffer) (GST_BUFFER_MAXSIZE (buffer) != GST_BUFFER_MAXSIZE_NONE) /** * GstBufferFlag: |