start pulling in base classes and elements for docs

Original commit message from CVS:
start pulling in base classes and elements for docs
parent acb843cb
2005-06-24 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/Makefile.am:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* docs/gst/gstreamer.types:
* docs/gst/tmpl/gstbasesink.sgml:
* docs/gst/tmpl/gstbasesrc.sgml:
* docs/gst/tmpl/gstbin.sgml:
* docs/gst/tmpl/gstcompat.sgml:
* docs/gst/tmpl/gstfakesink.sgml:
* docs/gst/tmpl/gstfakesrc.sgml:
* docs/gst/tmpl/gstfilesink.sgml:
* docs/gst/tmpl/gstfilesrc.sgml:
* docs/gst/tmpl/gstindex.sgml:
* docs/manual/appendix-quotes.xml:
* gst/base/gstbasesrc.h:
* gst/elements/gstfakesrc.h:
* gst/gstmessage.h:
start pulling in base classes and elements in our docs
2005-06-24 Stefan Kost <ensonic@users.sf.net>
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
fixed make distcheck with gtk-doc 1.3
fixed make distcheck with gtk-doc 1.3
2005-06-23 Wim Taymans <wim@fluendo.com>
......
......@@ -57,6 +57,9 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
SCANOBJ_DEPS = \
$(top_builddir)/gst/elements/libgstelements.la \
$(top_builddir)/gst/base/libgstbase-@GST_MAJORMINOR@.la
# Header files to ignore when scanning. Use base file name, no paths
IGNORE_HFILES= \
......@@ -75,12 +78,8 @@ IGNORE_HFILES= \
gstmarshal.h \
gstaggregator.h \
gstbufferstore.h \
gstfakesink.h \
gstfakesrc.h \
gstfdsink.h \
gstfdsrc.h \
gstfilesink.h \
gstfilesrc.h \
gstidentity.h \
gstmd5sink.h \
gstmultifilesrc.h \
......
......@@ -55,12 +55,15 @@
<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
<!--
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
<!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
<!ENTITY GstDiskSink SYSTEM "xml/gstdisksink.xml">
<!ENTITY GstFileSink SYSTEM "xml/gstfilesink.xml">
<!--
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
<!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
<!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
......@@ -154,32 +157,31 @@
<chapter id="gstreamer-compat">
<title>GStreamer Core Compatibility</title>
<para>
Theses elements are defined for compatibillity with older code.
The must not be use in new code!
These elements are defined for compatibility with older code.
They must not be used in new code!
</para>
&GstCompat;
</chapter>
<!--
FIXME: why is this commented out (reason #1: no public API)
<chapter id="element-types">
<title>GStreamer Standard Elements</title>
<title>GStreamer Core Elements</title>
<para>
libgstelements.la provide some basic elements like a disk source
libgstelements.so provide some basic elements like a file source
and sink. The use of these elements is strictly though the g_object_get() and
g_object_set() functions and the GStreamer Core Library functions.
</para>
&GstAggregator;
&GstFakeSrc;
&GstFakeSink;
&GstFileSrc;
&GstDiskSink;
&GstFileSink;
<!--
&GstAggregator;
&GstFdSrc;
&GstFdSink;
......@@ -191,8 +193,19 @@
&GstMD5Sink;
&GstTee;
-->
</chapter>
<chapter id="gstreamer-base">
<title>GStreamer Base Classes</title>
<para>
These base classes are provided to be extended by elements.
</para>
&GstBaseSrc;
&GstBaseSink;
</chapter>
-->
<chapter id="gstreamer-hierarchy">
......
......@@ -1852,3 +1852,102 @@ gst_xml_get_type
<TITLE>GstEnumTypes</TITLE>
</SECTION>
<SECTION>
<FILE>gstfakesrc</FILE>
<TITLE>GstFakeSrc</TITLE>
GstFakeSrc
<SUBSECTION Standard>
GstFakeSrcClass
GST_FAKESRC
GST_IS_FAKESRC
GST_TYPE_FAKESRC
GST_FAKESRC_CLASS
GST_IS_FAKESRC_CLASS
GST_FAKESRC_GET_CLASS
<SUBSECTION Private>
gst_fakesrc_get_type
</SECTION>
<SECTION>
<FILE>gstfakesink</FILE>
<TITLE>GstFakeSink</TITLE>
GstFakeSink
<SUBSECTION Standard>
GstFakeSinkClass
GST_FAKESINK
GST_IS_FAKESINK
GST_TYPE_FAKESINK
GST_FAKESINK_CLASS
GST_IS_FAKESINK_CLASS
GST_FAKESINK_GET_CLASS
<SUBSECTION Private>
gst_fakesink_get_type
</SECTION>
<SECTION>
<FILE>gstbasesrc</FILE>
<TITLE>GstBaseSrc</TITLE>
GstBaseSrc
<SUBSECTION Standard>
GstBaseSrcClass
GST_BASESRC
GST_IS_BASESRC
GST_TYPE_BASESRC
GST_BASESRC_CLASS
GST_IS_BASESRC_CLASS
GST_BASESRC_GET_CLASS
<SUBSECTION Private>
gst_basesrc_get_type
</SECTION>
<SECTION>
<FILE>gstfilesrc</FILE>
<TITLE>GstFileSrc</TITLE>
GstFileSrc
<SUBSECTION Standard>
GstFileSrcClass
GST_FILESRC
GST_IS_FILESRC
GST_TYPE_FILESRC
GST_FILESRC_CLASS
GST_IS_FILESRC_CLASS
GST_FILESRC_GET_CLASS
<SUBSECTION Private>
gst_filesrc_get_type
</SECTION>
<SECTION>
<FILE>gstfilesink</FILE>
<TITLE>GstFileSink</TITLE>
GstFileSink
<SUBSECTION Standard>
GstFileSinkClass
GST_FILESINK
GST_IS_FILESINK
GST_TYPE_FILESINK
GST_FILESINK_CLASS
GST_IS_FILESINK_CLASS
GST_FILESINK_GET_CLASS
<SUBSECTION Private>
gst_filesink_get_type
</SECTION>
<SECTION>
<FILE>gstbasesink</FILE>
<TITLE>GstBaseSink</TITLE>
GstBaseSink
<SUBSECTION Standard>
GstBaseSinkClass
GST_BASESINK
GST_IS_BASESINK
GST_TYPE_BASESINK
GST_BASESINK_CLASS
GST_IS_BASESINK_CLASS
GST_BASESINK_GET_CLASS
<SUBSECTION Private>
gst_basesink_get_type
</SECTION>
% add a _get_type for every GObject whose properties and signals you want
% documented
% add the relevant includes to be able to call those _get_type functions
% adding a get_type here will:
% - change output file name from gstreamer-(whatever).html to (whatever).html
% - document properties and signals
#include <gst/gst.h>
#include <gst/gstqueue.h>
......@@ -21,3 +29,22 @@ gst_tag_setter_get_type
gst_type_find_factory_get_type
gst_xml_get_type
% base classes
#include <gst/base/gstbasesrc.h>
#include <gst/base/gstbasesink.h>
gst_basesrc_get_type
gst_basesink_get_type
% elements
#include <gst/elements/gstfakesrc.h>
#include <gst/elements/gstfakesink.h>
#include <gst/elements/gstfilesrc.h>
#include <gst/elements/gstfilesink.h>
gst_fakesrc_get_type
gst_fakesink_get_type
gst_filesrc_get_type
gst_filesink_get_type
<!-- ##### SECTION Title ##### -->
GstBaseSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstBaseSink ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSink:has-chain ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSink:has-loop ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSink:preroll-queue-len ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstBaseSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstBaseSrc ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSrc:blocksize ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSrc:has-getrange ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSrc:has-loop ##### -->
<para>
</para>
......@@ -66,19 +66,19 @@ clock providers in the bin.
<!-- ##### SIGNAL GstBin::element-added ##### -->
<para>
Will be emmited if a new element was removed/added to this bin.
Will be emitted if a new element was removed/added to this bin.
</para>
@gstbin: the object which received the signal.
@arg1: the element that was added to the bin
@arg1: the element that was added to the bin.
<!-- ##### SIGNAL GstBin::element-removed ##### -->
<para>
Will be emmited if an element was removed from this bin.
Will be emitted if an element was removed from this bin.
</para>
@gstbin: the object which received the signal.
@arg1: the element that was removed from the bin
@arg1: the element that was removed from the bin.
<!-- ##### ENUM GstBinFlags ##### -->
<para>
......
......@@ -6,8 +6,9 @@ Deprecated API entries.
<!-- ##### SECTION Long_Description ##### -->
<para>
Please do not use in new code. This symbols are hidden by the GST_DISABLE_DEPRECATED define.
One would have to add this to the CFLAGS when compiling old code.
Please do not use these in new code.
These symbols are only available by defining GST_DISABLE_DEPRECATED.
This can be done in CFLAGS for compiling old code.
</para>
<!-- ##### SECTION See_Also ##### -->
......
<!-- ##### SECTION Title ##### -->
GstFakeSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFakeSink ##### -->
<para>
</para>
<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
<para>
</para>
@gstfakesink: the object which received the signal.
@arg1:
@arg2:
<!-- ##### ARG GstFakeSink:dump ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:last-message ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:signal-handoffs ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:silent ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:state-error ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:sync ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstFakeSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFakeSrc ##### -->
<para>
</para>
<!-- ##### SIGNAL GstFakeSrc::handoff ##### -->
<para>
</para>
@gstfakesrc: the object which received the signal.
@arg1:
<!-- ##### ARG GstFakeSrc:data ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:datarate ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:dump ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:eos ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:filltype ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:has-getrange ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:has-loop ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:last-message ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:num-buffers ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:output ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:parentsize ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:pattern ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:signal-handoffs ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:silent ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:sizemax ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:sizemin ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:sizetype ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:sync ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstFileSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFileSink ##### -->
<para>
</para>
<!-- ##### ARG GstFileSink:location ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstFileSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFileSrc ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:fd ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:location ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:mmapsize ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:touch ##### -->
<para>
</para>
......@@ -23,7 +23,7 @@ in a pipeline.
<!-- ##### SIGNAL GstIndex::entry-added ##### -->
<para>
Is emited when a new entry is added to the index.
Is emitted when a new entry is added to the index.