mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-10-03 01:02:19 +00:00
document elements and plugins. Shazam !
Original commit message from CVS: document elements and plugins. Shazam !
This commit is contained in:
Thomas Vander Stichele
parent
051c62638b
commit
bab306f55d
7 changed files with 189 additions and 1 deletions
|
|
@ -1,3 +1,12 @@
|
|||
2005-08-30 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||
|
||||
* configure.ac:
|
||||
* docs/plugins/Makefile.am:
|
||||
* docs/plugins/gst-plugins-good-plugins-docs.sgml:
|
||||
* docs/plugins/gst-plugins-good-plugins-sections.txt:
|
||||
* docs/plugins/gst-plugins-good-plugins.types:
|
||||
document elements and plugins. Shazam !
|
||||
|
||||
2005-08-30 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||
|
||||
* split off gst-plugins-good from gst-plugins. Old ChangeLog can
|
||||
|
|
|
|||
2
common
2
common
|
|
@ -1 +1 @@
|
|||
Subproject commit 89d82b662da00096b70e70a7a102b294acaae6dd
|
||||
Subproject commit 3fb3bedc9180bab9dc8c2dc784c9327bd1cc8109
|
||||
|
|
@ -502,6 +502,12 @@ GST_CFLAGS="-I\$(top_srcdir)/gst-libs -I\$(top_builddir)/gst-libs $GST_CFLAGS $G
|
|||
AC_SUBST(GST_LIBS)
|
||||
AC_SUBST(GST_CFLAGS)
|
||||
|
||||
dnl ######################
|
||||
dnl # Checks for gtk-doc #
|
||||
dnl ######################
|
||||
|
||||
GTK_DOC_CHECK([1.3])
|
||||
|
||||
dnl ############################
|
||||
dnl # Set up some more defines #
|
||||
dnl ############################
|
||||
|
|
@ -587,6 +593,9 @@ common/Makefile
|
|||
common/m4/Makefile
|
||||
gconf/Makefile
|
||||
gconf/gstreamer.schemas
|
||||
docs/Makefile
|
||||
docs/plugins/Makefile
|
||||
docs/version.entities
|
||||
m4/Makefile
|
||||
gst-plugins-good.spec
|
||||
)
|
||||
|
|
|
|||
109
docs/plugins/Makefile.am
Normal file
109
docs/plugins/Makefile.am
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
|
||||
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
# The name of the module, e.g. 'glib'.
|
||||
#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
|
||||
MODULE=gst-plugins-good
|
||||
DOC_MODULE=$(MODULE)-plugins
|
||||
|
||||
# for upload.mak
|
||||
DOC=$(MODULE)-plugins
|
||||
FORMATS=html
|
||||
html: html-build.stamp
|
||||
include $(srcdir)/../upload.mak
|
||||
|
||||
# generated basefiles
|
||||
#basefiles = \
|
||||
## $(DOC_MODULE).types \
|
||||
# $(DOC_MODULE)-sections.txt \
|
||||
# $(DOC_MODULE)-docs.sgml
|
||||
|
||||
# ugly hack to make -unused.sgml work
|
||||
#unused-build.stamp:
|
||||
# BUILDDIR=`pwd` && \
|
||||
# cd $(srcdir)/tmpl && \
|
||||
# ln -sf gstreamer-libs-unused.sgml \
|
||||
# $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
|
||||
# touch unused-build.stamp
|
||||
|
||||
# these rules are added to create parallel docs using GST_MAJORMINOR
|
||||
#$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
|
||||
# cp $< $@
|
||||
|
||||
#CLEANFILES = $(basefiles)
|
||||
|
||||
# The top-level SGML file. Change it if you want.
|
||||
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
||||
|
||||
# The directory 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)
|
||||
|
||||
# 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
|
||||
|
||||
# Extra options to supply to gtkdoc-fixref.
|
||||
# FIXME get the location of the installed gstreamer docs
|
||||
#FIXXREF_OPTIONS=--extra-dir=../gst/html
|
||||
|
||||
# Used for dependencies.
|
||||
HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
|
||||
CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
|
||||
|
||||
# this is a wingo addition
|
||||
# thomasvs: another nice wingo addition would be an explanation on why
|
||||
# this is useful ;)
|
||||
|
||||
SCANOBJ_DEPS =
|
||||
|
||||
# Header files to ignore when scanning.
|
||||
IGNORE_HFILES =
|
||||
IGNORE_CFILES =
|
||||
|
||||
# we add all .h files of elements that have signals/args we want
|
||||
# sadly this also pulls in the private methods - maybe we should
|
||||
# move those around in the source ?
|
||||
# also, we should add some stuff here conditionally based on whether
|
||||
# or not the plugin will actually build
|
||||
# but I'm not sure about that - it might be this Just Works given that
|
||||
# the registry won't have the element
|
||||
|
||||
# FIXME: not ported yet
|
||||
# $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c
|
||||
|
||||
EXTRA_HFILES = \
|
||||
$(top_srcdir)/gst/level/gstlevel.h
|
||||
|
||||
# Images to copy into HTML directory.
|
||||
HTML_IMAGES =
|
||||
|
||||
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
||||
content_files =
|
||||
|
||||
# Other files to distribute.
|
||||
extra_files =
|
||||
|
||||
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
|
||||
# contains GtkObjects/GObjects and you want to document signals and properties.
|
||||
GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir)
|
||||
GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
|
||||
|
||||
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
|
||||
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
|
||||
|
||||
# If you need to override some of the declarations, place them in this file
|
||||
# and uncomment this line.
|
||||
#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
|
||||
DOC_OVERRIDES =
|
||||
|
||||
include $(top_srcdir)/common/gtk-doc-plugins.mak
|
||||
51
docs/plugins/gst-plugins-good-plugins-docs.sgml
Normal file
51
docs/plugins/gst-plugins-good-plugins-docs.sgml
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
<?xml version="1.0"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % version-entities SYSTEM "version.entities">
|
||||
%version-entities;
|
||||
]>
|
||||
|
||||
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
||||
<bookinfo>
|
||||
<title>GStreamer Good Plugins &GST_MAJORMINOR; Plugins Reference Manual</title>
|
||||
</bookinfo>
|
||||
|
||||
<chapter>
|
||||
<title>gst-plugins-good Elements</title>
|
||||
<xi:include href="xml/element-level.xml" />
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
<title>gst-plugins-good Plugins</title>
|
||||
|
||||
<xi:include href="xml/plugin-1394.xml" />
|
||||
<xi:include href="xml/plugin-aasink.xml" />
|
||||
<xi:include href="xml/plugin-alaw.xml" />
|
||||
<xi:include href="xml/plugin-alpha.xml" />
|
||||
<xi:include href="xml/plugin-autodetect.xml" />
|
||||
<xi:include href="xml/plugin-avi.xml" />
|
||||
<xi:include href="xml/plugin-cacasink.xml" />
|
||||
<xi:include href="xml/plugin-dv.xml" />
|
||||
<xi:include href="xml/plugin-effectv.xml" />
|
||||
<xi:include href="xml/plugin-esdsink.xml" />
|
||||
<xi:include href="xml/plugin-fdsrc.xml" />
|
||||
<xi:include href="xml/plugin-flac.xml" />
|
||||
<xi:include href="xml/plugin-gconfelements.xml" />
|
||||
<xi:include href="xml/plugin-goom.xml" />
|
||||
<xi:include href="xml/plugin-gstcoreelements.xml" />
|
||||
<xi:include href="xml/plugin-jpeg.xml" />
|
||||
<xi:include href="xml/plugin-level.xml" />
|
||||
<xi:include href="xml/plugin-mulaw.xml" />
|
||||
<xi:include href="xml/plugin-ossaudio.xml" />
|
||||
<xi:include href="xml/plugin-png.xml" />
|
||||
<xi:include href="xml/plugin-rtp.xml" />
|
||||
<xi:include href="xml/plugin-rtsp.xml" />
|
||||
<xi:include href="xml/plugin-shout2send.xml" />
|
||||
<xi:include href="xml/plugin-smpte.xml" />
|
||||
<xi:include href="xml/plugin-speex.xml" />
|
||||
<xi:include href="xml/plugin-udp.xml" />
|
||||
<xi:include href="xml/plugin-videobox.xml" />
|
||||
<xi:include href="xml/plugin-videoflip.xml" />
|
||||
<xi:include href="xml/plugin-wavparse.xml" />
|
||||
</chapter>
|
||||
</book>
|
||||
9
docs/plugins/gst-plugins-good-plugins-sections.txt
Normal file
9
docs/plugins/gst-plugins-good-plugins-sections.txt
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<SECTION>
|
||||
<FILE>element-level</FILE>
|
||||
GstLevel
|
||||
<TITLE>level</TITLE>
|
||||
<SUBSECTION Standard>
|
||||
GstLevelClass
|
||||
</SECTION>
|
||||
|
||||
|
||||
1
docs/plugins/gst-plugins-good-plugins.types
Normal file
1
docs/plugins/gst-plugins-good-plugins.types
Normal file
|
|
@ -0,0 +1 @@
|
|||
#include <gst/gst.h>
|
||||
Loading…
Reference in a new issue