+2004-02-03 Thomas Vander Stichele <thomas at apestaart dot org>
+
+ * docs/README:
+ add some error fixing notes
+ * docs/gst/gstreamer-sections.txt:
+ remove double entries
+ * docs/gst/tmpl/gstbin.sgml:
+ * docs/gst/tmpl/gstclock.sgml:
+ remove override
+ * docs/gst/tmpl/gstelement.sgml:
+ * docs/gst/tmpl/gstindex.sgml:
+ * docs/gst/tmpl/gstobject.sgml:
+ * docs/gst/tmpl/gstpadtemplate.sgml:
+ * docs/gst/tmpl/gstreamer-unused.sgml:
+ * docs/gst/tmpl/gsttag.sgml:
+ * docs/gst/tmpl/gstthread.sgml:
+ * docs/gst/tmpl/gstxml.sgml:
+ * gst/gsttag.h:
+ sync header prototypes with c decls
+ * gst/gsttaginterface.c:
+ fix doc headers
+
2004-02-03 Benjamin Otte <in7y118@public.uni-hamburg.de>
* gst/parse/Makefile.am:
- add both an entity and use the entity in gstreamer-docs.sgml
- add a new section to gstreamer-sections.txt
- add all documented symbols to gstreamer-sections.txt in the proper section
+
+ - signals: document them properly in tmpl/.sgml
* checklist:
- make sure -sections.txt has a <TITLE> set for each <FILE>
(FIXME: why is there gstreamer.types.in and gst-plugins.types.in ?)
+* Possible errors and how to fix them
+ - Warning: multiple "IDs" for constraint linkend: gst-tag-register.
+ - check if gst_tag_register is listed more than once in -sections.txt
WBSITE DOCUMENTATION
====================
gst_element_state_get_name
gst_element_wait_state_change
-gst_element_error
gst_element_set_eos
gst_element_interrupt
gst_element_yield
gst_element_default_deep_notify
gst_element_default_error
+GST_ELEMENT_ERROR
+
GstElementState
GstElementStateReturn
GST_NUM_STATES
gst_tag_register
gst_tag_merge_use_first
gst_tag_merge_strings_with_comma
-
-
-gst_tag_initialize
-gst_tag_register
-gst_tag_merge_use_first
-gst_tag_merge_strings_with_comma
gst_tag_exists
gst_tag_get_type
gst_tag_get_nick
gst_caps_save_thyself
gst_caps_load_thyself
-gst_caps_debug
gst_caps_union
+
<SUBSECTION Standard>
</SECTION>
</para>
-<!-- ##### SIGNAL GstBin::element-added ##### -->
-<para>
-
-</para>
-
-@gstbin: the object which received the signal.
-@arg1: the element that was added to the bin
-
-<!-- ##### SIGNAL GstBin::element-removed ##### -->
-<para>
-
-</para>
-
-@gstbin: the object which received the signal.
-@arg1: the element that was removed from the bin
-
-<!-- ##### SIGNAL GstBin::iterate ##### -->
-<para>
-This signal is emitted when a bin iterates, either automatically or
-due to a #gst_bin_iterate() call. The return value is used to
-determine if the object method handler processed any data.
-In most normal cases, a user-provided signal handler should return
-FALSE.
-</para>
-
-@gstbin: the object which received the signal.
-@Returns: TRUE if the state of the bin was advanced.
-
<!-- ##### USER_FUNCTION GstBinPrePostIterateFunction ##### -->
<para>
The signature of the callback for the post and pre iterate function as set with
@clock:
+<!-- ##### SIGNAL GstBin::element-added ##### -->
+<para>
+
+</para>
+
+@gstbin: the object which received the signal.
+@arg1: the element that was added to the bin
+
+<!-- ##### SIGNAL GstBin::element-removed ##### -->
+<para>
+
+</para>
+
+@gstbin: the object which received the signal.
+@arg1: the element that was removed from the bin
+
+<!-- ##### SIGNAL GstBin::iterate ##### -->
+<para>
+This signal is emitted when a bin iterates, either automatically or
+due to a #gst_bin_iterate() call. The return value is used to
+determine if the object method handler processed any data.
+In most normal cases, a user-provided signal handler should return
+FALSE.
+</para>
+
+@gstbin: the object which received the signal.
+@Returns: TRUE if the state of the bin was advanced.
+
@clock: the clock to query
-<!-- ##### STRUCT GstClock ##### -->
-<para>
-The GstClock object
-</para>
-
-
-<!-- ##### ARG GstClock:event-diff ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstClock:max-diff ##### -->
-<para>
-Maximum allowed diff for clock sync requests against the real time.
-</para>
-
-<!-- ##### ARG GstClock:stats ##### -->
-<para>
-Boolean property to activate stat generation on the clock.
-</para>
-
<!-- ##### FUNCTION gst_clock_set_speed ##### -->
<para>
@id:
+<!-- ##### ARG GstClock:event-diff ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GstClock:max-diff ##### -->
+<para>
+Maximum allowed diff for clock sync requests against the real time.
+</para>
+
+<!-- ##### ARG GstClock:stats ##### -->
+<para>
+Boolean property to activate stat generation on the clock.
+</para>
+
</para>
-<!-- ##### SIGNAL GstElement::eos ##### -->
-<para>
-Signal emited when the element goes to PAUSED due to an end-of-stream
-condition.
-</para>
-
-@gstelement: the object which received the signal.
-
-<!-- ##### SIGNAL GstElement::error ##### -->
-<para>
-Is triggered whenever an error occured.
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: the error message
-@arg2:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-
-<!-- ##### SIGNAL GstElement::found-tag ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1:
-@arg2:
-
-<!-- ##### SIGNAL GstElement::new-pad ##### -->
-<para>
-Is triggered whenever a new pad is added to an element.
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: the new pad that was added
-
-<!-- ##### SIGNAL GstElement::pad-removed ##### -->
-<para>
-Is triggered whenever a pad has been removed from the element.
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: The pad that was removed.
-
-<!-- ##### SIGNAL GstElement::state-change ##### -->
-<para>
-Is triggered whenever the state of an element changes.
-</para>
-
-@gstelement: the object which received the signal.
-@arg1: the new state of the object
-@arg2:
-
<!-- ##### MACRO gst_element_get_name ##### -->
<para>
Gets the name of the element.
@debug:
+<!-- ##### MACRO GST_ELEMENT_ERROR ##### -->
+<para>
+
+</para>
+
+@el:
+@domain:
+@code:
+@message:
+@debug:
+
+
<!-- ##### ENUM GstElementState ##### -->
<para>
This enum defines the standard states an element may be in. You will normally
@...: list of query types.
+<!-- ##### SIGNAL GstElement::eos ##### -->
+<para>
+Signal emited when the element goes to PAUSED due to an end-of-stream
+condition.
+</para>
+
+@gstelement: the object which received the signal.
+
+<!-- ##### SIGNAL GstElement::error ##### -->
+<para>
+This signal is emitted when an element has encountered an error that caused
+it to fail performing its function.
+</para>
+
+@gstelement: the object which received the signal.
+@arg1: the original #GstElement that generated the error.
+@arg2: a #GError containing the translated error message.
+@arg3: a debug string providing additional untranslated debug information, or NULL.
+
+<!-- ##### SIGNAL GstElement::found-tag ##### -->
+<para>
+
+</para>
+
+@gstelement: the object which received the signal.
+@arg1:
+@arg2:
+
+<!-- ##### SIGNAL GstElement::new-pad ##### -->
+<para>
+Is triggered whenever a new pad is added to an element.
+</para>
+
+@gstelement: the object which received the signal.
+@arg1: the new pad that was added
+
+<!-- ##### SIGNAL GstElement::pad-removed ##### -->
+<para>
+Is triggered whenever a pad has been removed from the element.
+</para>
+
+@gstelement: the object which received the signal.
+@arg1: The pad that was removed.
+
+<!-- ##### SIGNAL GstElement::state-change ##### -->
+<para>
+Is triggered whenever the state of an element changes.
+</para>
+
+@gstelement: the object which received the signal.
+@arg1: the new state of the object
+@arg2:
+
</para>
-<!-- ##### SIGNAL GstIndex::entry-added ##### -->
-<para>
-Is emited when a new entry is added to the index.
-</para>
-
-@gstindex: the object which received the signal.
-@arg1: The entry added to the index.
-
-<!-- ##### ARG GstIndex:resolver ##### -->
-<para>
-
-</para>
-
<!-- ##### FUNCTION gst_index_new ##### -->
<para>
@id:
+<!-- ##### SIGNAL GstIndex::entry-added ##### -->
+<para>
+Is emited when a new entry is added to the index.
+</para>
+
+@gstindex: the object which received the signal.
+@arg1: The entry added to the index.
+
+<!-- ##### ARG GstIndex:resolver ##### -->
+<para>
+
+</para>
+
</para>
-<!-- ##### SIGNAL GstObject::deep-notify ##### -->
-<para>
-The deep notify signal is used to be notified of property changes.
-it is typically attached to the toplevel bin to receive notifications
-from all the elements contained in that bin.
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: the object that originated the signal
-@arg2: the property that changed
-
-<!-- ##### SIGNAL GstObject::object-saved ##### -->
-<para>
-Is trigered whenever a new object is saved to XML. You can connect to
-this signal to insert custom XML tags into the core XML.
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: the xmlNodePtr of the parent node
-
-<!-- ##### SIGNAL GstObject::parent-set ##### -->
-<para>
-Is emitted when the parent of an object is set.
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: the new parent
-
-<!-- ##### SIGNAL GstObject::parent-unset ##### -->
-<para>
-Is emitted when the parent of an object is unset.
-</para>
-
-@gstobject: the object which received the signal.
-@arg1: the old parent
-
-<!-- ##### ARG GstObject:name ##### -->
-<para>
-The name of the object
-</para>
-
<!-- ##### MACRO GST_FLAGS ##### -->
<para>
This macro returns the entire set of flags for the object.
@Returns:
+<!-- ##### SIGNAL GstObject::deep-notify ##### -->
+<para>
+The deep notify signal is used to be notified of property changes.
+it is typically attached to the toplevel bin to receive notifications
+from all the elements contained in that bin.
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: the object that originated the signal
+@arg2: the property that changed
+
+<!-- ##### SIGNAL GstObject::object-saved ##### -->
+<para>
+Is trigered whenever a new object is saved to XML. You can connect to
+this signal to insert custom XML tags into the core XML.
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: the xmlNodePtr of the parent node
+
+<!-- ##### SIGNAL GstObject::parent-set ##### -->
+<para>
+Is emitted when the parent of an object is set.
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: the new parent
+
+<!-- ##### SIGNAL GstObject::parent-unset ##### -->
+<para>
+Is emitted when the parent of an object is unset.
+</para>
+
+@gstobject: the object which received the signal.
+@arg1: the old parent
+
+<!-- ##### ARG GstObject:name ##### -->
+<para>
+The name of the object
+</para>
+
</para>
-<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
-<para>
-This signal is fired when an element creates a pad from this
-template.
-</para>
-
-@gstpadtemplate: the object which received the signal.
-@arg1: The pad that was created.
-
<!-- ##### ENUM GstPadTemplateFlags ##### -->
<para>
Flags for the padtemplate
@Returns:
+<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
+<para>
+This signal is fired when an element creates a pad from this
+template.
+</para>
+
+@gstpadtemplate: the object which received the signal.
+@arg1: The pad that was created.
+
@arg1:
@arg2:
-<!-- ##### SIGNAL GstElement::error-2 ##### -->
-<para>
-
-</para>
-
-@gstelement: the object which received the signal.
-@arg1:
-@arg2:
-@arg3:
-
<!-- ##### SIGNAL GstElement::event ##### -->
<para>
</para>
-<!-- ##### SIGNAL GstXML::object-loaded ##### -->
-<para>
-
-</para>
-
-@gstxml: the object which received the signal.
-@arg1:
-@arg2:
-
<!-- ##### USER_FUNCTION GstXMLRegistryAddPathList ##### -->
<para>
</para>
@dest:
-@values:
+@src:
<!-- ##### FUNCTION gst_tag_merge_strings_with_comma ##### -->
</para>
@dest:
-@values:
-
-
-<!-- ##### FUNCTION gst_tag_register ##### -->
-<para>
-
-</para>
-
-@name:
-@flag:
-@type:
-@nick:
-@blurb:
-@func:
-
-
-<!-- ##### FUNCTION gst_tag_merge_use_first ##### -->
-<para>
-
-</para>
-
-@dest:
-@values:
-
-
-<!-- ##### FUNCTION gst_tag_merge_strings_with_comma ##### -->
-<para>
-
-</para>
-
-@dest:
-@values:
+@src:
<!-- ##### FUNCTION gst_tag_exists ##### -->
</para>
-<!-- ##### SIGNAL GstThread::shutdown ##### -->
+<!-- ##### FUNCTION gst_thread_new ##### -->
<para>
</para>
-@gstthread: the object which received the signal.
+@name:
+@Returns:
-<!-- ##### ARG GstThread:priority ##### -->
-<para>
-The thread priority
-</para>
-<!-- ##### FUNCTION gst_thread_new ##### -->
+<!-- ##### SIGNAL GstThread::shutdown ##### -->
<para>
</para>
-@name:
-@Returns:
+@gstthread: the object which received the signal.
+<!-- ##### ARG GstThread:priority ##### -->
+<para>
+The thread priority
+</para>
@Returns:
+<!-- ##### SIGNAL GstXML::object-loaded ##### -->
+<para>
+
+</para>
+
+@gstxml: the object which received the signal.
+@arg1:
+@arg2:
+
+<!-- ##### SIGNAL GstXML::object-loaded ##### -->
+<para>
+
+</para>
+
+@:
+@:
+@:
+
GstTagMergeFunc func);
/* some default merging functions */
void gst_tag_merge_use_first (GValue * dest,
- const GValue * values);
+ const GValue * src);
void gst_tag_merge_strings_with_comma (GValue * dest,
- const GValue * values);
+ const GValue * src);
/* basic tag support */
gboolean gst_tag_exists (const gchar * tag);
/**
* gst_tag_setter_set_merge_mode:
* @setter: a #GstTagSetter
- * @overwrite: The mode with which tags are added
+ * @mode: The mode with which tags are added
*
* Sets the given merge mode that is used for adding tags from events to tags
* specified by this interface. The default is #GST_TAG_MERGE_KEEP, which keeps
GstTagMergeFunc func);
/* some default merging functions */
void gst_tag_merge_use_first (GValue * dest,
- const GValue * values);
+ const GValue * src);
void gst_tag_merge_strings_with_comma (GValue * dest,
- const GValue * values);
+ const GValue * src);
/* basic tag support */
gboolean gst_tag_exists (const gchar * tag);
/**
* gst_tag_setter_set_merge_mode:
* @setter: a #GstTagSetter
- * @overwrite: The mode with which tags are added
+ * @mode: The mode with which tags are added
*
* Sets the given merge mode that is used for adding tags from events to tags
* specified by this interface. The default is #GST_TAG_MERGE_KEEP, which keeps
projects / platform / upstream / gstreamer.git / commitdiff