summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWim Taymans <wim.taymans@collabora.co.uk>2012-01-03 15:03:38 +0100
committerWim Taymans <wim.taymans@collabora.co.uk>2012-01-03 15:03:38 +0100
commit6ac237191019476b25e2916961667be9ae242a11 (patch)
treee658e099799a620908a53dd542e70b6dc582ade9
parent6b9d34b9262eb6827d603e38e5cf2a0c8b75a5c2 (diff)
docs: fix some docs
-rw-r--r--docs/gst/gstreamer-docs.sgml1
-rw-r--r--docs/gst/gstreamer-sections.txt52
-rw-r--r--gst/gstcompat.h2
-rw-r--r--gst/gstelement.h2
-rw-r--r--gst/gstmemory.c7
-rw-r--r--gst/gstregistry.c5
-rw-r--r--gst/gstsample.c6
7 files changed, 56 insertions, 19 deletions
diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index 3b64c1aa3e..e35097044c 100644
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -64,6 +64,7 @@ Windows. It is released under the GNU Library General Public License
<xi:include href="xml/gstbufferpool.xml" />
<xi:include href="xml/gstbus.xml" />
<xi:include href="xml/gstcaps.xml" />
+ <xi:include href="xml/gstsample.xml" />
<xi:include href="xml/gstchildproxy.xml" />
<xi:include href="xml/gstclock.xml" />
<xi:include href="xml/gstconfig.xml" />
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 1af0570cc2..8bea483f9a 100644
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -245,14 +245,24 @@ gst_buffer_copy_flags_get_type
<FILE>gstmeta</FILE>
<TITLE>GstMeta</TITLE>
GstMeta
+GstMetaFlags
+GST_META_FLAGS
+GST_META_FLAG_IS_SET
+GST_META_FLAG_SET
+GST_META_FLAG_UNSET
GstMetaInfo
-GST_META_TRACE_NAME
GstMetaInitFunction
GstMetaFreeFunction
GstMetaCopyFunction
GstMetaTransformFunction
gst_meta_register
gst_meta_get_info
+<SUBSECTION Standard>
+GST_META_CAST
+GST_META_TRACE_NAME
+<SUBSECTION Private>
+GST_TYPE_META_FLAGS
+gst_meta_flags_get_type
</SECTION>
@@ -409,6 +419,29 @@ gst_caps_intersect_mode_get_type
</SECTION>
<SECTION>
+<FILE>gstsample</FILE>
+<TITLE>GstSample</TITLE>
+GstSample
+gst_sample_get_buffer
+gst_sample_get_caps
+gst_sample_get_info
+gst_sample_get_segment
+gst_sample_new
+gst_sample_ref
+gst_sample_unref
+gst_value_get_sample
+gst_value_set_sample
+gst_value_take_sample
+<SUBSECTION Standard>
+GST_SAMPLE_TRACE_NAME
+GST_IS_SAMPLE
+GST_SAMPLE
+GST_TYPE_SAMPLE
+gst_sample_get_type
+GST_SAMPLE_CAST
+</SECTION>
+
+<SECTION>
<FILE>gstchildproxy</FILE>
<TITLE>GstChildProxy</TITLE>
GstChildProxy
@@ -1242,11 +1275,13 @@ gst_allocator_find
gst_allocator_register
gst_allocator_set_default
<SUBSECTION Standard>
+GST_TYPE_MEMORY
GST_MEMORY_TRACE_NAME
GST_TYPE_MAP_FLAGS
GST_TYPE_MEMORY_FLAGS
gst_map_flags_get_type
gst_memory_flags_get_type
+gst_memory_get_type
</SECTION>
<SECTION>
@@ -2091,7 +2126,7 @@ gst_buffering_mode_get_type
<FILE>gstregistry</FILE>
<TITLE>GstRegistry</TITLE>
GstRegistry
-gst_registry_get_default
+gst_registry_get
gst_registry_get_feature_list
gst_registry_get_feature_list_cookie
gst_registry_get_feature_list_by_plugin
@@ -2109,16 +2144,7 @@ gst_registry_scan_path
gst_registry_lookup
gst_registry_remove_feature
gst_registry_add_feature
-<SUBSECTION Default Registry>
-gst_default_registry_check_feature_version
-gst_default_registry_get_path_list
-gst_default_registry_add_plugin
-gst_default_registry_add_path
-gst_default_registry_find_plugin
-gst_default_registry_find_feature
-gst_default_registry_get_plugin_list
-gst_default_registry_get_feature_list_cookie
-gst_default_registry_feature_filter
+gst_registry_check_feature_version
<SUBSECTION Standard>
GstRegistryClass
GST_REGISTRY
@@ -2372,6 +2398,8 @@ gst_tag_list_insert
gst_tag_list_merge
gst_tag_list_free
gst_tag_list_get_tag_size
+gst_tag_list_n_tags
+gst_tag_list_nth_tag_name
gst_tag_list_add
gst_tag_list_add_value
gst_tag_list_add_values
diff --git a/gst/gstcompat.h b/gst/gstcompat.h
index 5b607bf126..8f787c98b5 100644
--- a/gst/gstcompat.h
+++ b/gst/gstcompat.h
@@ -51,7 +51,7 @@ G_BEGIN_DECLS
#define gst_buffer_new_and_alloc(s) gst_buffer_new_allocate(NULL, s, 0)
-#define GST_FLOW_UNEXPECTED GST_FLOW_EOS
+//#define GST_FLOW_UNEXPECTED GST_FLOW_EOS
#define GST_BUFFER_TIMESTAMP GST_BUFFER_PTS
#define GST_BUFFER_TIMESTAMP_IS_VALID GST_BUFFER_PTS_IS_VALID
diff --git a/gst/gstelement.h b/gst/gstelement.h
index 17571e278a..f923f49473 100644
--- a/gst/gstelement.h
+++ b/gst/gstelement.h
@@ -597,8 +597,6 @@ struct _GstElement
* @set_bus: set a #GstBus on the element
* @provide_clock: gets the #GstClock provided by the element
* @set_clock: set the #GstClock on the element
- * @get_index: set a #GstIndex on the element
- * @set_index: get the #GstIndex of an element
* @send_event: send a #GstEvent to the element
* @query: perform a #GstQuery on the element
* @state_changed: called immediately after a new state was set.
diff --git a/gst/gstmemory.c b/gst/gstmemory.c
index b2ac925929..26efc88a49 100644
--- a/gst/gstmemory.c
+++ b/gst/gstmemory.c
@@ -64,8 +64,11 @@
G_DEFINE_BOXED_TYPE (GstMemory, gst_memory, (GBoxedCopyFunc) gst_memory_ref,
(GBoxedFreeFunc) gst_memory_unref);
-/* buffer alignment in bytes - 1
- * an alignment of 7 would be the same as malloc() guarantees
+/**
+ * gst_memory_alignment:
+ *
+ * The default memory alignment in bytes - 1
+ * an alignment of 7 would be the same as what malloc() guarantees.
*/
#if defined(MEMORY_ALIGNMENT_MALLOC)
size_t gst_memory_alignment = 7;
diff --git a/gst/gstregistry.c b/gst/gstregistry.c
index d4f0780289..9fc69d33a3 100644
--- a/gst/gstregistry.c
+++ b/gst/gstregistry.c
@@ -1401,13 +1401,14 @@ _priv_gst_registry_cleanup (void)
/**
* gst_registry_check_feature_version:
+ * @registry: a #GstRegistry
* @feature_name: the name of the feature (e.g. "oggdemux")
* @min_major: the minimum major version number
* @min_minor: the minimum minor version number
* @min_micro: the minimum micro version number
*
- * Checks whether a plugin feature by the given name exists in the
- * default registry and whether its version is at least the
+ * Checks whether a plugin feature by the given name exists in
+ * @registry and whether its version is at least the
* version required.
*
* Returns: #TRUE if the feature could be found and the version is
diff --git a/gst/gstsample.c b/gst/gstsample.c
index 3a09460410..4c5681fee9 100644
--- a/gst/gstsample.c
+++ b/gst/gstsample.c
@@ -81,6 +81,12 @@ _gst_sample_free (GstSample * sample)
/**
* gst_sample_new:
+ * @buffer: a #GstBuffer
+ * @caps: a #GstCaps
+ * @segment: a #GstSegment
+ * @info: a #GstStructure
+ *
+ * Create a new #GstSample with the provided details.
*
* Free-function: gst_sample_unref
*