more doc build fixes

Original commit message from CVS:
more doc build fixes
This commit is contained in:
Thomas Vander Stichele 2004-04-08 14:45:13 +00:00
parent 357151e803
commit c1125590b2
35 changed files with 409 additions and 137 deletions

View file

@ -1,3 +1,41 @@
2004-04-08 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/.cvsignore:
* docs/gst/Makefile.am:
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstaggregator.sgml:
* docs/gst/tmpl/gstbuffer.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gstfakesink.sgml:
* docs/gst/tmpl/gstfakesrc.sgml:
* docs/gst/tmpl/gstfdsink.sgml:
* docs/gst/tmpl/gstfdsrc.sgml:
* docs/gst/tmpl/gstfilesink.sgml:
* docs/gst/tmpl/gstfilesrc.sgml:
* docs/gst/tmpl/gstidentity.sgml:
* docs/gst/tmpl/gstindex.sgml:
* docs/gst/tmpl/gstinfo.sgml:
* docs/gst/tmpl/gstmd5sink.sgml:
* docs/gst/tmpl/gstmultifilesrc.sgml:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstpipefilter.sgml:
* docs/gst/tmpl/gstpipeline.sgml:
* docs/gst/tmpl/gstpluginfeature.sgml:
* docs/gst/tmpl/gstqueue.sgml:
* docs/gst/tmpl/gstregistry.sgml:
* docs/gst/tmpl/gstscheduler.sgml:
* docs/gst/tmpl/gstshaper.sgml:
* docs/gst/tmpl/gstspider.sgml:
* docs/gst/tmpl/gstspideridentity.sgml:
* docs/gst/tmpl/gststatistics.sgml:
* docs/gst/tmpl/gstsystemclock.sgml:
* docs/gst/tmpl/gsttee.sgml:
* docs/gst/tmpl/gstthread.sgml:
* docs/gst/tmpl/gsttypefind.sgml:
* docs/gst/tmpl/gstutils.sgml:
further doc build fixes
2004-04-07 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/Makefile.am:

25
docs/gst/.gitignore vendored
View file

@ -1,21 +1,24 @@
Makefile
Makefile.in
html
sgml
gstreamer.signals
gstreamer.types
gstreamer.html
gstreamer.prerequisites
gstreamer.interfaces
gstreamer.hierarchy
gstreamer-unused.txt
gstreamer-undocumented.txt
gstreamer-decl-list.txt
gstreamer-decl.txt
gstreamer-undocumented.txt
gstreamer-unused.txt
gstreamer.args
gstreamer.hierarchy
gstreamer.interfaces
gstreamer.prerequisites
gstreamer.signals
html
sgml
*.stamp
gstreamer.html
gstreamer-presed-scan.c
gstreamer-scan.c
gstreamer-scan
gstreamer.args
tmpl.stamp
tmpl-build.stamp
sgml.stamp

View file

@ -63,7 +63,7 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
# Header files to ignore when scanning.
# Header files to ignore when scanning. Use base file name, no paths
IGNORE_HFILES= \
gettext.h \
gst-i18n-lib.h \
@ -73,9 +73,10 @@ IGNORE_HFILES= \
gstdata_private.h \
gstarch.h \
cothreads.h \
schedulers/cothreads_compat.h \
schedulers/gthread-cothreads.h \
parse/types.h \
cothreads_compat.h \
gthread-cothreads.h \
types.h \
grammar.tab.h \
elements/gstaggregator.h \
elements/gstbufferstore.h \
elements/gstfakesink.h \
@ -146,9 +147,13 @@ DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
SCANOBJ_FILES = \
$(DOC_MODULE).args \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).interfaces \
$(DOC_MODULE).prerequisites \
$(DOC_MODULE)-scan.o \
$(DOC_MODULE).signals
CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
if HAVE_GTK_DOC
all-local: html-build.stamp

View file

@ -1501,21 +1501,6 @@ GST_IS_TYPE_FIND_ELEMENT_CLASS
GST_TYPE_FIND_ELEMENT_GET_CLASS
</SECTION>
<SECTION>
<FILE>grammar.tab</FILE>
PARSE_URL
IDENTIFIER
BINREF
PADREF
REF
ASSIGNMENT
LINK
yystype
YYSTYPE_IS_TRIVIAL
<SUBSECTION Standard>
YYSTYPE_IS_DECLARED
</SECTION>
<SECTION>
<FILE>gstxmlregistry</FILE>
<TITLE>GstXMLRegistry</TITLE>
@ -2118,49 +2103,3 @@ gst_autoplug_factories_filters_with_sink_caps
gst_autoplug_factories_at_most_templates
gst_autoplug_sp
</SECTION>
<SECTION>
<FILE>types</FILE>
link_t
chain_t
graph_t
gst_parse_strdup
gst_parse_strfree
gst_parse_link_new
gst_parse_link_free
gst_parse_chain_new
gst_parse_chain_free
</SECTION>
<SECTION>
<FILE>cothreads_compat</FILE>
COTHREADS_TYPE
COTHREADS_NAME
COTHREADS_NAME_CAPITAL
cothread
do_cothreads_init
do_cothreads_stackquery
do_cothread_switch
do_cothread_create
do_cothread_setfunc
do_cothread_destroy
do_cothread_context_init
do_cothread_context_destroy
do_cothread_get_current
do_cothread_get_main
</SECTION>
<SECTION>
<FILE>gthread-cothreads</FILE>
COTHREADS_TYPE
COTHREADS_NAME
COTHREADS_NAME_CAPITAL
cothread_func
cothread
cothread_context
do_cothread_create
do_cothread_get_current
do_cothread_get_main
do_cothread_setfunc
</SECTION>

View file

@ -24,3 +24,9 @@ methods to request buffers from its pads.
@AGGREGATOR_LOOP_SELECT:
@AGGREGATOR_CHAIN:
<!-- ##### STRUCT GstAggregator ##### -->
<para>
</para>

View file

@ -217,14 +217,6 @@ Gets the timestamp for this buffer.
@buf:
<!-- ##### MACRO GST_BUFFER_FORMAT ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_OFFSET ##### -->
<para>
Gets the offset in the source file of this buffer.
@ -429,6 +421,16 @@ If the refcount is 1, this function just returns the original buffer.
@Returns:
<!-- ##### FUNCTION gst_buffer_join ##### -->
<para>
</para>
@buf1:
@buf2:
@Returns:
<!-- ##### FUNCTION gst_buffer_merge ##### -->
<para>

View file

@ -21,6 +21,12 @@ clock so that the clock is always a good measure of the time in the pipeline.
#GstSystemClock
</para>
<!-- ##### STRUCT GstClock ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstClockTime ##### -->
<para>
A datatype to hold a time, measured in nanoseconds.

View file

@ -1132,45 +1132,6 @@ Sets the parent of an element.
<!-- clocking -->
<!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### -->
<para>
</para>
<!-- ##### MACRO GST_ELEMENT_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_ELEMENT_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_ELEMENT_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_ELEMENT_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### FUNCTION gst_element_factory_get_type ##### -->
<para>
@ -1323,6 +1284,59 @@ Sets the parent of an element.
@Returns:
<!-- ##### STRUCT GstElementFactory ##### -->
<para>
</para>
<!-- ##### STRUCT GstElementFactoryClass ##### -->
<para>
</para>
@parent_class:
@_gst_reserved:
<!-- ##### MACRO GST_TYPE_ELEMENT_FACTORY ##### -->
<para>
</para>
<!-- ##### MACRO GST_ELEMENT_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_ELEMENT_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_ELEMENT_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_ELEMENT_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### SIGNAL GstElement::eos ##### -->
<para>
Signal emited when the element goes to PAUSED due to an end-of-stream

View file

@ -16,6 +16,12 @@ with the buffer. (fakesink)
</para>
<!-- ##### STRUCT GstFakeSink ##### -->
<para>
</para>
<!-- ##### ENUM GstFakeSinkStateError ##### -->
<para>

View file

@ -14,6 +14,12 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>
<!-- ##### STRUCT GstFakeSrc ##### -->
<para>
</para>
<!-- ##### ENUM GstFakeSrcOutputType ##### -->
<para>

View file

@ -14,3 +14,9 @@ Write data to a file descriptor.
</para>
<!-- ##### STRUCT GstFdSink ##### -->
<para>
</para>

View file

@ -14,3 +14,9 @@ Read buffers from a file descriptor.
</para>
<!-- ##### STRUCT GstFdSrc ##### -->
<para>
</para>

View file

@ -14,6 +14,12 @@ GstFileSink
</para>
<!-- ##### STRUCT GstFileSink ##### -->
<para>
</para>
<!-- ##### ENUM GstFileSinkFlags ##### -->
<para>

View file

@ -15,6 +15,12 @@ and subbuffers.
</para>
<!-- ##### STRUCT GstFileSrc ##### -->
<para>
</para>
<!-- ##### ENUM GstFileSrcFlags ##### -->
<para>

View file

@ -14,3 +14,9 @@ Pass data without modification.
</para>
<!-- ##### STRUCT GstIdentity ##### -->
<para>
</para>

View file

@ -15,6 +15,12 @@ in a pipeline.
#GstIndexFactory
</para>
<!-- ##### STRUCT GstIndex ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_INDEX_ENTRY ##### -->
<para>
@ -466,6 +472,20 @@ Check if the index can be written to
@obj:
<!-- ##### STRUCT GstIndexFactory ##### -->
<para>
The GstIndexFactory object
</para>
<!-- ##### STRUCT GstIndexFactoryClass ##### -->
<para>
</para>
@parent:
@_gst_reserved:
<!-- ##### FUNCTION gst_index_factory_get_type ##### -->
<para>

View file

@ -810,3 +810,18 @@ Returns: The name of the function
<!-- ##### MACRO GST_TIME_FORMAT ##### -->
<para>
</para>
<!-- ##### MACRO GST_TIME_ARGS ##### -->
<para>
</para>
@t:

View file

@ -14,3 +14,9 @@ GstMD5Sink
</para>
<!-- ##### STRUCT GstMD5Sink ##### -->
<para>
</para>

View file

@ -14,6 +14,12 @@ GstMultiFileSrc
</para>
<!-- ##### STRUCT GstMultiFileSrc ##### -->
<para>
</para>
<!-- ##### ENUM GstMultiFileSrcFlags ##### -->
<para>

View file

@ -57,6 +57,38 @@ Last reviewed on December 13th, 2002 (0.5.0.1)
#GstPadTemplate, #GstElement, #GstEvent
</para>
<!-- ##### STRUCT GstRealPad ##### -->
<para>
</para>
<!-- ##### STRUCT GstGhostPad ##### -->
<para>
</para>
<!-- ##### STRUCT GstRealPadClass ##### -->
<para>
</para>
@parent_class:
@caps_nego_failed:
@linked:
@unlinked:
@appfixatefunc:
@_gst_reserved:
<!-- ##### STRUCT GstGhostPadClass ##### -->
<para>
</para>
@parent_class:
@_gst_reserved:
<!-- ##### MACRO GST_IS_PAD_FAST ##### -->
<para>
@ -1462,18 +1494,6 @@ Check if the properties of the padtemplate are fixed
@Returns:
<!-- ##### FUNCTION gst_pad_selectv ##### -->
<para>
</para>
@padlist:
@Returns:
<!-- # Unused Parameters # -->
@pad:
@Varargs:
<!-- ##### FUNCTION gst_pad_select ##### -->
<para>
@ -1486,6 +1506,18 @@ Check if the properties of the padtemplate are fixed
@padlist:
<!-- ##### FUNCTION gst_pad_selectv ##### -->
<para>
</para>
@padlist:
@Returns:
<!-- # Unused Parameters # -->
@pad:
@Varargs:
<!-- ##### FUNCTION gst_pad_select_valist ##### -->
<para>
@ -1496,6 +1528,38 @@ Check if the properties of the padtemplate are fixed
@Returns:
<!-- ##### FUNCTION gst_pad_collect ##### -->
<para>
</para>
@selected:
@pad:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_pad_collectv ##### -->
<para>
</para>
@selected:
@padlist:
@Returns:
<!-- ##### FUNCTION gst_pad_collect_valist ##### -->
<para>
</para>
@selected:
@pad:
@varargs:
@Returns:
<!-- ##### FUNCTION gst_pad_set_formats_function ##### -->
<para>

View file

@ -15,6 +15,12 @@ buffers from its output.
</para>
<!-- ##### STRUCT GstPipefilter ##### -->
<para>
</para>
<!-- ##### ENUM GstPipeFilterFlags ##### -->
<para>

View file

@ -21,6 +21,12 @@ the pipeline, use gst_element_unref() to free its resources.
#GstBin
</para>
<!-- ##### STRUCT GstPipeline ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_pipeline_new ##### -->
<para>

View file

@ -14,6 +14,12 @@ This is a base class for anything that can be added to a #GstPlugin.
#GstPlugin
</para>
<!-- ##### STRUCT GstPluginFeature ##### -->
<para>
</para>
<!-- ##### MACRO GST_PLUGIN_FEATURE_NAME ##### -->
<para>
Get the name of the feature

View file

@ -25,3 +25,18 @@ The queue blocks by default.
</para>
<!-- ##### STRUCT GstQueue ##### -->
<para>
</para>
<!-- ##### STRUCT GstQueueSize ##### -->
<para>
</para>
@buffers:
@bytes:
@time:

View file

@ -14,6 +14,12 @@ The registry holds the available plugins in the system.
#GstPlugin, #GstPluginFeature
</para>
<!-- ##### STRUCT GstRegistry ##### -->
<para>
</para>
<!-- ##### MACRO GLOBAL_REGISTRY_DIR ##### -->
<para>

View file

@ -20,6 +20,7 @@ Flags for the scheduler
</para>
@GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock
@GST_SCHEDULER_FLAG_NEW_API:
@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
from here.
@ -321,6 +322,20 @@ The state of the scheduler
<!-- ##### STRUCT GstSchedulerFactory ##### -->
<para>
</para>
<!-- ##### STRUCT GstSchedulerFactoryClass ##### -->
<para>
</para>
@parent:
@_gst_reserved:
<!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
<para>

View file

@ -14,6 +14,12 @@ GstShaper
</para>
<!-- ##### STRUCT GstShaper ##### -->
<para>
</para>
<!-- ##### ENUM GstShaperPolicyType ##### -->
<para>

View file

@ -14,6 +14,12 @@ GstSpider
</para>
<!-- ##### STRUCT GstSpider ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstSpiderConnection ##### -->
<para>

View file

@ -14,6 +14,12 @@ GstSpiderIdentity
</para>
<!-- ##### STRUCT GstSpiderIdentity ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_spider_identity_new_sink ##### -->
<para>

View file

@ -15,6 +15,12 @@ the data stream, such as buffers/bytes/events etc.
</para>
<!-- ##### STRUCT GstStatistics ##### -->
<para>
</para>
<!-- ##### STRUCT stats ##### -->
<para>

View file

@ -15,6 +15,16 @@ system time.
#GstClock
</para>
<!-- ##### STRUCT GstSystemClock ##### -->
<para>
</para>
@clock:
@mutex:
@cond:
@_gst_reserved:
<!-- ##### FUNCTION gst_system_clock_obtain ##### -->
<para>

View file

@ -14,3 +14,9 @@ A tee can be used to split out the filter graph.
</para>
<!-- ##### STRUCT GstTee ##### -->
<para>
</para>

View file

@ -18,6 +18,12 @@ A Thread can act as a toplevel bin as it has its own scheduler.
#GstBin, #GstPipeline
</para>
<!-- ##### STRUCT GstThread ##### -->
<para>
</para>
<!-- ##### VARIABLE gst_thread_current ##### -->
<para>

View file

@ -16,3 +16,9 @@ GstTypeFindElement
</para>
<!-- ##### STRUCT GstTypeFindElement ##### -->
<para>
</para>

View file

@ -9,13 +9,11 @@ gstutils
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_util_set_value_from_string ##### -->
<para>
@ -72,6 +70,8 @@ gstutils
@type:
@type_as_function:
@parent_type:
@\
parent_type_macro:
@\
parent_type_macro:
@additional_initializations: