more doc updates

Original commit message from CVS:
more doc updates
This commit is contained in:
Thomas Vander Stichele 2004-04-08 15:14:27 +00:00
parent c1125590b2
commit b9b50ea5d8
8 changed files with 36 additions and 617 deletions

View file

@ -41,13 +41,8 @@ DOC_SOURCE_DIR=$(top_srcdir)/gst
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=
# FIXME :
# there's something wrong with gstreamer-sections.txt not being in the dist
# maybe it doesn't resolve; we're adding it below for now
#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=trio
MKDB_OPTIONS=--sgml-mode --ignore-files=trio
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=
@ -77,6 +72,7 @@ IGNORE_HFILES= \
gthread-cothreads.h \
types.h \
grammar.tab.h \
gstmarshal.h \
elements/gstaggregator.h \
elements/gstbufferstore.h \
elements/gstfakesink.h \
@ -180,11 +176,11 @@ scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst"; \
fi; \
gtkdoc-scan \
$(SCAN_OPTIONS) $(EXTRA_HFILES) \
--module=$(DOC_MODULE) \
--source-dir=$(DOC_SOURCE_DIR) \
$$BUILT_OPTIONS \
--ignore-headers="$(IGNORE_HFILES)" \
$(SCAN_OPTIONS) $(EXTRA_HFILES)
--ignore-headers="$(IGNORE_HFILES)"
touch scan-build.stamp
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
@ -206,11 +202,11 @@ tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections
tmpl.stamp: tmpl-build.stamp
@true
#### sgml ####
#### xml ####
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
@echo '*** Building SGML ***'
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) | tee sgml-build.log
@echo '*** Building XML ***'
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) --output-format=xml $(MKDB_OPTIONS) | tee sgml-build.log
@if grep "WARNING:" sgml-build.log > /dev/null; then exit 1; fi
rm sgml-build.log
touch sgml-build.stamp
@ -235,11 +231,11 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
endif
clean-local:
rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
rm -rf xml html
rm -f *~ *.bak
rm -rf .libs
maintainer-clean-local: clean
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
# company: don't delete .sgml and -sections.txt as they're in CVS
# FIXME : thomas added all sgml files and some other things to make

View file

@ -1651,31 +1651,6 @@ gst_parse_error_get_type
GST_TYPE_PARSE_ERROR
</SECTION>
<SECTION>
<FILE>gstmarshal</FILE>
gst_marshal_VOID__VOID
gst_marshal_VOID__BOOLEAN
gst_marshal_VOID__INT
gst_marshal_VOID__STRING
gst_marshal_VOID__BOXED
gst_marshal_VOID__POINTER
gst_marshal_VOID__POINTER_OBJECT
gst_marshal_VOID__OBJECT
gst_marshal_VOID__OBJECT_PARAM
gst_marshal_VOID__OBJECT_POINTER
gst_marshal_VOID__OBJECT_BOXED
gst_marshal_VOID__OBJECT_OBJECT_STRING
gst_marshal_VOID__OBJECT_STRING
gst_marshal_VOID__INT_INT
gst_marshal_VOID__INT64
gst_marshal_VOID__UINT_BOXED
gst_marshal_VOID__UINT_POINTER
gst_marshal_BOOLEAN__VOID
gst_marshal_BOOLEAN__POINTER
gst_marshal_POINTER__POINTER
gst_marshal_BOXED__BOXED
</SECTION>
<SECTION>
<FILE>gstcpu</FILE>
GstCPUFlags

View file

@ -1,7 +1,6 @@
#include <gst/gst.h>
gst_object_get_type
gst_xml_get_type
gst_element_get_type
gst_bin_get_type
gst_clock_get_type

View file

@ -14,228 +14,3 @@ gstmarshal
</para>
<!-- ##### MACRO gst_marshal_VOID__VOID ##### -->
<para>
</para>
<!-- ##### MACRO gst_marshal_VOID__BOOLEAN ##### -->
<para>
</para>
<!-- ##### MACRO gst_marshal_VOID__INT ##### -->
<para>
</para>
<!-- ##### MACRO gst_marshal_VOID__STRING ##### -->
<para>
</para>
<!-- ##### MACRO gst_marshal_VOID__BOXED ##### -->
<para>
</para>
<!-- ##### MACRO gst_marshal_VOID__POINTER ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_marshal_VOID__POINTER_OBJECT ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### MACRO gst_marshal_VOID__OBJECT ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_PARAM ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_POINTER ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_BOXED ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_OBJECT_STRING ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_VOID__OBJECT_STRING ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_VOID__INT_INT ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_VOID__INT64 ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_VOID__UINT_BOXED ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### MACRO gst_marshal_VOID__UINT_POINTER ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_marshal_BOOLEAN__VOID ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_BOOLEAN__POINTER ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_POINTER__POINTER ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:
<!-- ##### FUNCTION gst_marshal_BOXED__BOXED ##### -->
<para>
</para>
@closure:
@return_value:
@n_param_values:
@param_values:
@invocation_hint:
@marshal_data:

View file

@ -1,94 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstParse
<!-- ##### SECTION Short_Description ##### -->
Parses pipeline syntax into elements
<!-- ##### SECTION Long_Description ##### -->
<para>
This method allows you to create a pipeline from a command
line syntax description. The following example creates a simple
mp3 player.
<programlisting>
GstElement *pipeline;
/* create a pipeline to hold our elements */
pipeline = gst_pipeline_new ("launch");
/* build a pipeline in the pipeline */
gst_parse_launch ("filesrc location=some.mp3 ! mad ! osssink", GST_BIN (pipeline));
/* play the thing */
gst_element_set_state (pipeline, GST_STATE_PLAYING);
while (gst_bin_iterate (GST_BIN (pipeline)));
gst_element_set_state (pipeline, GST_STATE_NULL);
</programlisting>
</para>
<para>
Elements are separated with a <option>!</option>, properties are set with
<replaceable>property</replaceable>=<replaceable>value</replaceable>, specific pads
of an element are selected by replacing the <option>!</option> with
<replaceable>padname</replaceable><option>!</option>.
</para>
<para>
Elements can be added to a bin by embracing them with <option>()</option>. Threads
can be made with <option>{}</option>.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_parse_error_quark ##### -->
<para>
Get the error quark passed in the GError messages.
</para>
@Returns: The parse error quark
<!-- ##### MACRO GST_PARSE_ERROR ##### -->
<para>
The error quark
</para>
<!-- ##### ENUM GstParseError ##### -->
<para>
The parsing errors.
</para>
@GST_PARSE_ERROR_SYNTAX: A syntax error was detected
@GST_PARSE_ERROR_NO_SUCH_ELEMENT: The pipeline description contains a non existing element
@GST_PARSE_ERROR_NO_SUCH_PROPERTY: The pipeline description contains a non existing element property
@GST_PARSE_ERROR_LINK: A pad link could not be made
@GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY:
@GST_PARSE_ERROR_EMPTY_BIN:
@GST_PARSE_ERROR_EMPTY:
<!-- ##### FUNCTION gst_parse_launch ##### -->
<para>
</para>
@pipeline_description:
@error:
@Returns:
<!-- ##### FUNCTION gst_parse_launchv ##### -->
<para>
</para>
@argv:
@error:
@Returns:

View file

@ -1,249 +0,0 @@
<!-- ##### SECTION Title ##### -->
gsttypes
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstObject ##### -->
<para>
The GstObject
</para>
<!-- ##### STRUCT GstObjectClass ##### -->
<para>
</para>
@parent_class:
@path_string_separator:
@signal_object:
@parent_set:
@parent_unset:
@object_saved:
@deep_notify:
@destroy:
@save_thyself:
@restore_thyself:
@_gst_reserved:
<!-- ##### STRUCT GstPad ##### -->
<para>
The GstPad object
</para>
<!-- ##### STRUCT GstPadClass ##### -->
<para>
</para>
@parent_class:
@_gst_reserved:
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
The padtemplate object.
</para>
<!-- ##### STRUCT GstPadTemplateClass ##### -->
<para>
</para>
@parent_class:
@pad_created:
@_gst_reserved:
<!-- ##### STRUCT GstElement ##### -->
<para>
The element object
</para>
<!-- ##### STRUCT GstElementClass ##### -->
<para>
</para>
@parent_class:
@details:
@elementfactory:
@padtemplates:
@numpadtemplates:
@state_change:
@new_pad:
@pad_removed:
@error:
@eos:
@found_tag:
@set_property:
@get_property:
@release_locks:
@get_event_masks:
@send_event:
@get_formats:
@convert:
@get_query_types:
@query:
@change_state:
@request_new_pad:
@release_pad:
@get_clock:
@set_clock:
@get_index:
@set_index:
@set_state:
@_gst_reserved:
<!-- ##### STRUCT GstBin ##### -->
<para>
The GstBin object
</para>
<!-- ##### STRUCT GstBinClass ##### -->
<para>
</para>
@parent_class:
@add_element:
@remove_element:
@child_state_change:
@iterate:
@element_added:
@element_removed:
@_gst_reserved:
<!-- ##### STRUCT GstScheduler ##### -->
<para>
</para>
<!-- ##### STRUCT GstSchedulerClass ##### -->
<para>
</para>
@parent_class:
@setup:
@reset:
@add_element:
@remove_element:
@add_scheduler:
@remove_scheduler:
@state_transition:
@scheduling_change:
@lock_element:
@unlock_element:
@yield:
@interrupt:
@error:
@pad_link:
@pad_unlink:
@pad_select:
@clock_wait:
@iterate:
@show:
@object_sync:
@_gst_reserved:
<!-- ##### STRUCT GstEvent ##### -->
<para>
</para>
@data:
@type:
@timestamp:
@src:
<!-- ##### ENUM GstElementState ##### -->
<para>
This enum defines the standard states an element may be in. You will normally
use gst_element_set_state() to change the state of an element.
</para>
@GST_STATE_VOID_PENDING:
@GST_STATE_NULL: Reset the state of an element.
@GST_STATE_READY: will make the element ready to start processing data. some
elements might have a non trivial way to initialize themselves.
@GST_STATE_PAUSED: means there really is data flowing temporary stops the data flow.
@GST_STATE_PLAYING: means there really is data flowing through the graph.
<!-- ##### ENUM GstElementStateReturn ##### -->
<para>
This enum defines the standard return values that an element
can return after a state change.
</para>
@GST_STATE_FAILURE: the element could not perform the state change
@GST_STATE_SUCCESS: the element successfully changed its state
@GST_STATE_ASYNC: the element will asynchronously change its state as soon as possible
<!-- ##### ENUM GstResult ##### -->
<para>
</para>
@GST_RESULT_OK:
@GST_RESULT_NOK:
@GST_RESULT_NOT_IMPL:
<!-- ##### MACRO GST_RANK_PRIMARY ##### -->
<para>
</para>
<!-- ##### MACRO GST_RANK_SECONDARY ##### -->
<para>
</para>
<!-- ##### MACRO GST_RANK_MARGINAL ##### -->
<para>
</para>
<!-- ##### MACRO GST_RANK_NONE ##### -->
<para>
</para>
<!-- ##### MACRO GST_PADDING ##### -->
<para>
</para>
<!-- ##### MACRO GST_PADDING_INIT ##### -->
<para>
</para>

View file

@ -70,6 +70,22 @@ gstutils
@type:
@type_as_function:
@parent_type:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\

View file

@ -14,6 +14,12 @@ GstXML
</para>
<!-- ##### STRUCT GstXML ##### -->
<para>
</para>
<!-- ##### STRUCT GstXMLNs ##### -->
<para>
@ -115,16 +121,11 @@ GstXML
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
<para>
</para>
@:
@:
@: