diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am index 614389a1aa..f8a8d2a2dd 100644 --- a/docs/gst/Makefile.am +++ b/docs/gst/Makefile.am @@ -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 diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 8c3f94cf26..51f9d05289 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -1651,31 +1651,6 @@ gst_parse_error_get_type GST_TYPE_PARSE_ERROR -
-gstmarshal -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 -
-
gstcpu GstCPUFlags diff --git a/docs/gst/gstreamer.types b/docs/gst/gstreamer.types index 03825dff6e..ae5626c6d4 100644 --- a/docs/gst/gstreamer.types +++ b/docs/gst/gstreamer.types @@ -1,7 +1,6 @@ #include gst_object_get_type -gst_xml_get_type gst_element_get_type gst_bin_get_type gst_clock_get_type diff --git a/docs/gst/tmpl/gstmarshal.sgml b/docs/gst/tmpl/gstmarshal.sgml index 31c8588cfb..3b6e5d66b4 100644 --- a/docs/gst/tmpl/gstmarshal.sgml +++ b/docs/gst/tmpl/gstmarshal.sgml @@ -14,228 +14,3 @@ gstmarshal - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - - - - - - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml deleted file mode 100644 index 2543f2e360..0000000000 --- a/docs/gst/tmpl/gstparse.sgml +++ /dev/null @@ -1,94 +0,0 @@ - -GstParse - - -Parses pipeline syntax into elements - - - -This method allows you to create a pipeline from a command -line syntax description. The following example creates a simple -mp3 player. - - 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); - - - - - -Elements are separated with a , properties are set with -property=value, specific pads -of an element are selected by replacing the with -padname. - - -Elements can be added to a bin by embracing them with . Threads -can be made with . - - - - - - - - - -Get the error quark passed in the GError messages. - - -@Returns: The parse error quark - - - - -The error quark - - - - - - -The parsing errors. - - -@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: - - - - - - -@pipeline_description: -@error: -@Returns: - - - - - - - -@argv: -@error: -@Returns: - - diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml deleted file mode 100644 index 2ba16cfa1b..0000000000 --- a/docs/gst/tmpl/gsttypes.sgml +++ /dev/null @@ -1,249 +0,0 @@ - -gsttypes - - - - - - - - - - - - - - - - -The GstObject - - - - - - - - -@parent_class: -@path_string_separator: -@signal_object: -@parent_set: -@parent_unset: -@object_saved: -@deep_notify: -@destroy: -@save_thyself: -@restore_thyself: -@_gst_reserved: - - - -The GstPad object - - - - - - - - -@parent_class: -@_gst_reserved: - - - -The padtemplate object. - - - - - - - - -@parent_class: -@pad_created: -@_gst_reserved: - - - -The element object - - - - - - - - -@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: - - - -The GstBin object - - - - - - - - -@parent_class: -@add_element: -@remove_element: -@child_state_change: -@iterate: -@element_added: -@element_removed: -@_gst_reserved: - - - - - - - - - - - - -@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: - - - - - - -@data: -@type: -@timestamp: -@src: - - - -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. - - - -@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. - - - -This enum defines the standard return values that an element -can return after a state change. - - - -@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 - - - - - - -@GST_RESULT_OK: -@GST_RESULT_NOK: -@GST_RESULT_NOT_IMPL: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml index a3f786d77a..b84ca0b930 100644 --- a/docs/gst/tmpl/gstutils.sgml +++ b/docs/gst/tmpl/gstutils.sgml @@ -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: @\ diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index 65734d63e7..9c2ab3c4cb 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -14,6 +14,12 @@ GstXML + + + + + + @@ -115,16 +121,11 @@ GstXML +@: +@: +@: + @gstxml: the object which received the signal. @arg1: @arg2: - - - - - -@: -@: -@: -