mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-06 08:09:56 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs/: Remove cruft and do some cleanups.

Browse source 
Original commit message from CVS:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
Remove cruft and do some cleanups.
* docs/gst/gstreamer-docs.sgml:
* docs/libs/gstreamer-libs-docs.sgml:
Prepare for comming gtkdoc features (rebase against online docs).
This commit is contained in:
Stefan Kost 2007-08-10 17:35:30 +00:00
parent e84de48ff9
commit 2cf1e35694
5 changed files with 45 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
ChangeLog
View file

@ -1,3 +1,13 @@
2007-08-10 Stefan Kost <ensonic@users.sf.net>
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
Remove cruft and do some cleanups.
* docs/gst/gstreamer-docs.sgml:
* docs/libs/gstreamer-libs-docs.sgml:
Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 Michael Smith <msmith@fluendo.com>
* docs/gst/gstreamer-sections.txt:

62
docs/gst/Makefile.am
View file

@ -35,23 +35,24 @@ include $(top_srcdir)/common/upload.mak
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --ignore-files=parse
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html
# The files containing the source code. Relative to $(top_srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR = $(top_srcdir)/gst
DOC_BUILD_DIR = $(top_builddir)/gst
HFILE_GLOB=$(top_srcdir)/gst/*.h $(top_srcdir)/libs/gst/*/*.h
CFILE_GLOB=$(top_srcdir)/gst/*.c $(top_srcdir)/libs/gst/*/*.c
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=parse
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html
# Used for dependencies.
HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
SCANOBJ_DEPS = \
$(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
@ -60,40 +61,17 @@ SCANOBJ_DEPS = \
# Header files to ignore when scanning. Use base file name, no paths
IGNORE_HFILES= \
gettext.h \
gst-i18n-lib.h \
gst-i18n-app.h \
gst_private.h \
gstdata_private.h \
gstarch.h \
cothreads.h \
cothreads_compat.h \
gthread-cothreads.h \
faircothreads.h \
types.h \
glib-compat-private.h \
glib-compat.h \
gst-i18n-app.h \
gst-i18n-lib.h \
gst_private.h \
gstmarshal.h \
gstmacros.h \
\
grammar.tab.h \
grammar.tab.pre.h \
gstmarshal.h \
gstaggregator.h \
gstbufferstore.h \
gstfdsink.h \
gstfdsrc.h \
gstidentity.h \
gstmacros.h \
gstmd5sink.h \
gstmultifilesrc.h \
gstmultifdsink.h \
gstpipefilter.h \
gstshaper.h \
gststatistics.h \
gsttee.h \
gsttrashstack.h \
gsttypefindelement.h \
gstspider.h \
gstspideridentity.h \
gstsearchfuncs.h \
gsttrashstack.h \
gstxmlregistry.h
types.h
# Images to copy into HTML directory.
HTML_IMAGES =

6
docs/gst/gstreamer-docs.sgml
View file

@ -73,7 +73,11 @@
<book id="index">
<bookinfo>
<title>GStreamer &GST_MAJORMINOR; Core Reference Manual</title>
<releaseinfo>for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
<releaseinfo>
for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/</ulink>.
</releaseinfo>
</bookinfo>
<chapter id="gstreamer">

2
docs/libs/Makefile.am
View file

@ -48,7 +48,7 @@ SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
#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= --output-format=xml --sgml-mode --ignore-files=trio
MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \

15
docs/libs/gstreamer-libs-docs.sgml
View file

@ -35,7 +35,10 @@
<book id="index">
<bookinfo>
<title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
<releaseinfo>for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
<releaseinfo>
for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/</ulink>.
</releaseinfo>
</bookinfo>
<part id="gstreamer-libs">
<title>GStreamer Libraries</title>
@ -54,12 +57,12 @@
libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
by elements and utillity classes that are most useful for plugin developers.
</para>
&GstBaseSrc;
&GstBaseSink;
&GstBaseTransform;
&GstPushSrc;
&GstAdapter;
&GstCollectPads;
&GstTypeFindHelper;
@ -85,19 +88,19 @@
<para>
libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
</para>
&GstNetClientClock;
&GstNetTimePacket;
&GstNetTimeProvider;
</chapter>
<chapter id="gstreamer-check">
<title>GStreamer Check Unit Testing</title>
<para>
libgstcheck-&GST_MAJORMINOR;.so provides functionality for writing
unit tests that use the check framework.
</para>
&GstCheck;
&GstCheckBufferStraw;
</chapter>