docs: misc fixes

This commit is contained in:
Tim-Philipp Müller 2016-11-16 10:55:29 +00:00
parent 06b015b62a
commit 0794b593af
5 changed files with 41 additions and 10 deletions

View file

@ -74,6 +74,7 @@ Windows. It is released under the GNU Library General Public License
<xi:include href="xml/gstcontrolbinding.xml" /> <xi:include href="xml/gstcontrolbinding.xml" />
<xi:include href="xml/gstcontrolsource.xml" /> <xi:include href="xml/gstcontrolsource.xml" />
<xi:include href="xml/gstdatetime.xml" /> <xi:include href="xml/gstdatetime.xml" />
<xi:include href="xml/gstdynamictypefactory.xml" />
<xi:include href="xml/gstelement.xml" /> <xi:include href="xml/gstelement.xml" />
<xi:include href="xml/gstelementfactory.xml" /> <xi:include href="xml/gstelementfactory.xml" />
<xi:include href="xml/gsterror.xml" /> <xi:include href="xml/gsterror.xml" />

View file

@ -81,6 +81,9 @@ gst_bin_iterate_all_by_interface
gst_bin_recalculate_latency gst_bin_recalculate_latency
gst_bin_get_suppressed_flags
gst_bin_set_suppressed_flags
<SUBSECTION> <SUBSECTION>
gst_bin_add_many gst_bin_add_many
gst_bin_remove_many gst_bin_remove_many
@ -272,6 +275,7 @@ GST_TYPE_BUFFER_FLAGS
GST_TYPE_BUFFER_COPY_FLAGS GST_TYPE_BUFFER_COPY_FLAGS
GST_BUFFER_CAST GST_BUFFER_CAST
GST_PARENT_BUFFER_META_INFO GST_PARENT_BUFFER_META_INFO
GST_PARENT_BUFFER_META_API_TYPE
GST_TYPE_PARENT_BUFFER_META_API_TYPE GST_TYPE_PARENT_BUFFER_META_API_TYPE
gst_parent_buffer_meta_get_info gst_parent_buffer_meta_get_info
<SUBSECTION Private> <SUBSECTION Private>
@ -758,6 +762,7 @@ GST_TYPE_CONTROL_BINDING
GST_CONTROL_BINDING_PSPEC GST_CONTROL_BINDING_PSPEC
<SUBSECTION Private> <SUBSECTION Private>
GstControlBindingConvert GstControlBindingConvert
GstControlBindingPrivate
gst_control_binding_get_type gst_control_binding_get_type
</SECTION> </SECTION>
@ -783,6 +788,23 @@ GST_TYPE_CONTROL_SOURCE
gst_control_source_get_type gst_control_source_get_type
</SECTION> </SECTION>
<SECTION>
<FILE>gstdynamictypefactory</FILE>
<TITLE>GstDynamicTypeFactory</TITLE>
GstDynamicTypeFactory
gst_dynamic_type_factory_load
gst_dynamic_type_register
<SUBSECTION Standard>
GstDynamicTypeFactoryClass
GST_TYPE_DYNAMIC_TYPE_FACTORY
GST_DYNAMIC_TYPE_FACTORY
GST_DYNAMIC_TYPE_CLASS
GST_IS_DYNAMIC_TYPE_FACTORY
GST_IS_DYNAMIC_TYPE_FACTORY_CLASS
GST_DYNAMIC_TYPE_FACTORY_CAST
<SUBSECTION Private>
gst_dynamic_type_factory_get_type
</SECTION>
<SECTION> <SECTION>
<FILE>gstelement</FILE> <FILE>gstelement</FILE>
@ -951,6 +973,8 @@ GST_STATE_WAIT_UNTIL
GST_STATE_SIGNAL GST_STATE_SIGNAL
GST_STATE_BROADCAST GST_STATE_BROADCAST
GST_ELEMENT_MESSAGE_MAKE_DETAILS
gst_element_get_type gst_element_get_type
gst_element_flags_get_type gst_element_flags_get_type
gst_state_get_type gst_state_get_type
@ -2858,6 +2882,7 @@ GST_TAG_COPYRIGHT
GST_TAG_COPYRIGHT_URI GST_TAG_COPYRIGHT_URI
GST_TAG_ENCODED_BY GST_TAG_ENCODED_BY
GST_TAG_COMPOSER GST_TAG_COMPOSER
GST_TAG_CONDUCTOR
GST_TAG_CONTACT GST_TAG_CONTACT
GST_TAG_LICENSE GST_TAG_LICENSE
GST_TAG_LICENSE_URI GST_TAG_LICENSE_URI

View file

@ -144,6 +144,10 @@ struct _GstBin {
* @add_element: method to add an element to a bin * @add_element: method to add an element to a bin
* @remove_element: method to remove an element from a bin * @remove_element: method to remove an element from a bin
* @handle_message: method to handle a message from the children * @handle_message: method to handle a message from the children
* @deep_element_added: method called when an element was added somewhere
* in the bin hierarchy
* @deep_element_removed: method called when an element was removed somewhere
* in the bin hierarchy
* *
* Subclasses can override the @add_element and @remove_element to * Subclasses can override the @add_element and @remove_element to
* update the list of children in the bin. * update the list of children in the bin.
@ -152,7 +156,7 @@ struct _GstBin {
* message handling. @handle_message takes ownership of the message, just like * message handling. @handle_message takes ownership of the message, just like
* #gst_element_post_message. * #gst_element_post_message.
* *
* The @element_added_deep vfunc will be called when a new element has been * The @deep_element_added vfunc will be called when a new element has been
* added to any bin inside this bin, so it will also be called if a new child * added to any bin inside this bin, so it will also be called if a new child
* was added to a sub-bin of this bin. #GstBin implementations that override * was added to a sub-bin of this bin. #GstBin implementations that override
* this message should chain up to the parent class implementation so the * this message should chain up to the parent class implementation so the

View file

@ -429,7 +429,7 @@ G_STMT_START { \
parentheses) parentheses)
* @debug: debugging information for the message (format string and args * @debug: debugging information for the message (format string and args
enclosed in parentheses) enclosed in parentheses)
* @args optional name, type, value triplets, which will be stored * @args: optional name, type, value triplets, which will be stored
* in the associated GstStructure. NULL terminator required. * in the associated GstStructure. NULL terminator required.
* Must be enclosed within parentheses. * Must be enclosed within parentheses.
* *
@ -490,7 +490,7 @@ G_STMT_START { \
parentheses) parentheses)
* @debug: debugging information for the message (format string and args * @debug: debugging information for the message (format string and args
enclosed in parentheses) enclosed in parentheses)
* @args optional name, type, value triplets, which will be stored * @args: optional name, type, value triplets, which will be stored
* in the associated GstStructure. NULL terminator required. * in the associated GstStructure. NULL terminator required.
* Must be enclosed within parentheses. * Must be enclosed within parentheses.
* *
@ -551,7 +551,7 @@ G_STMT_START { \
parentheses) parentheses)
* @debug: debugging information for the message (format string and args * @debug: debugging information for the message (format string and args
enclosed in parentheses) enclosed in parentheses)
* @args optional name, type, value triplets, which will be stored * @args: optional name, type, value triplets, which will be stored
* in the associated GstStructure. NULL terminator required. * in the associated GstStructure. NULL terminator required.
* Must be enclosed within parentheses. * Must be enclosed within parentheses.
* *
@ -663,6 +663,7 @@ G_STMT_START { \
* @numsinkpads: number of sink pads of the element. * @numsinkpads: number of sink pads of the element.
* @sinkpads: (element-type Gst.Pad): list of sink pads * @sinkpads: (element-type Gst.Pad): list of sink pads
* @pads_cookie: updated whenever the a pad is added or removed * @pads_cookie: updated whenever the a pad is added or removed
* @contexts: (element-type Gst.Context): list of contexts
* *
* GStreamer element abstract base class. * GStreamer element abstract base class.
*/ */

View file

@ -330,14 +330,14 @@ static inline guint16 __gst_slow_read16_le (const guint8 * data) {
/** /**
* GST_WRITE_UINT64_BE: * GST_WRITE_UINT64_BE:
* @data: memory location * @data: memory location
* @num: value to store * @val: value to store
* *
* Store a 64 bit unsigned integer value in big endian format into the memory buffer. * Store a 64 bit unsigned integer value in big endian format into the memory buffer.
*/ */
/** /**
* GST_WRITE_UINT64_LE: * GST_WRITE_UINT64_LE:
* @data: memory location * @data: memory location
* @num: value to store * @val: value to store
* *
* Store a 64 bit unsigned integer value in little endian format into the memory buffer. * Store a 64 bit unsigned integer value in little endian format into the memory buffer.
*/ */
@ -380,14 +380,14 @@ static inline guint16 __gst_slow_read16_le (const guint8 * data) {
/** /**
* GST_WRITE_UINT32_BE: * GST_WRITE_UINT32_BE:
* @data: memory location * @data: memory location
* @num: value to store * @val: value to store
* *
* Store a 32 bit unsigned integer value in big endian format into the memory buffer. * Store a 32 bit unsigned integer value in big endian format into the memory buffer.
*/ */
/** /**
* GST_WRITE_UINT32_LE: * GST_WRITE_UINT32_LE:
* @data: memory location * @data: memory location
* @num: value to store * @val: value to store
* *
* Store a 32 bit unsigned integer value in little endian format into the memory buffer. * Store a 32 bit unsigned integer value in little endian format into the memory buffer.
*/ */
@ -452,14 +452,14 @@ static inline guint16 __gst_slow_read16_le (const guint8 * data) {
/** /**
* GST_WRITE_UINT16_BE: * GST_WRITE_UINT16_BE:
* @data: memory location * @data: memory location
* @num: value to store * @val: value to store
* *
* Store a 16 bit unsigned integer value in big endian format into the memory buffer. * Store a 16 bit unsigned integer value in big endian format into the memory buffer.
*/ */
/** /**
* GST_WRITE_UINT16_LE: * GST_WRITE_UINT16_LE:
* @data: memory location * @data: memory location
* @num: value to store * @val: value to store
* *
* Store a 16 bit unsigned integer value in little endian format into the memory buffer. * Store a 16 bit unsigned integer value in little endian format into the memory buffer.
*/ */