mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-19 06:46:38 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs/plugins/: first stab at documenting ffmpeg elements. Needs work.

Browse source 
Original commit message from CVS:
2006-01-31  Thomas Vander Stichele  <thomas at apestaart dot org>

* docs/plugins/Makefile.am:
* docs/plugins/gst-ffmpeg-plugins-docs.sgml:
first stab at documenting ffmpeg elements.  Needs work.
This commit is contained in:
Thomas Vander Stichele 2006-01-31 09:25:09 +00:00
parent fe142a2894
commit 7ce7e929d1
3 changed files with 19 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
2006-01-31 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/plugins/Makefile.am:
* docs/plugins/gst-ffmpeg-plugins-docs.sgml:
first stab at documenting ffmpeg elements. Needs work.
2006-01-31 Thomas Vander Stichele <thomas at apestaart dot org> 2006-01-31 Thomas Vander Stichele <thomas at apestaart dot org>
* configure.ac: * configure.ac:

12
docs/plugins/Makefile.am
View file

@ -39,7 +39,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code. Relative to $(top_srcdir). # The directory containing the source code. Relative to $(top_srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments # gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros. # documenting functions and macros.
DOC_SOURCE_DIR = $(top_srcdir) DOC_SOURCE_DIR = $(top_srcdir)/ext/ffmpeg
# Extra options to supply to gtkdoc-scan. # Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS= SCAN_OPTIONS=
@ -52,8 +52,8 @@ MKDB_OPTIONS=--sgml-mode
#FIXXREF_OPTIONS=--extra-dir=../gst/html #FIXXREF_OPTIONS=--extra-dir=../gst/html
# Used for dependencies. # Used for dependencies.
HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
# this is a wingo addition # this is a wingo addition
# thomasvs: another nice wingo addition would be an explanation on why # thomasvs: another nice wingo addition would be an explanation on why
@ -62,8 +62,8 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
SCANOBJ_DEPS = SCANOBJ_DEPS =
# Header files to ignore when scanning. # Header files to ignore when scanning.
IGNORE_HFILES = avcodec.h gstffmpegcodecmap.h dsputil.h IGNORE_HFILES =
IGNORE_CFILES = utils.c mem.c imgconvert.c IGNORE_CFILES =
# we add all .h files of elements that have signals/args we want # we add all .h files of elements that have signals/args we want
# sadly this also pulls in the private methods - maybe we should # sadly this also pulls in the private methods - maybe we should
@ -73,7 +73,7 @@ IGNORE_CFILES = utils.c mem.c imgconvert.c
# but I'm not sure about that - it might be this Just Works given that # but I'm not sure about that - it might be this Just Works given that
# the registry won't have the element # the registry won't have the element
EXTRA_HFILES = EXTRA_HFILES = $(DOC_SOURCE_DIR)/gstffmpegenc.c
# Images to copy into HTML directory. # Images to copy into HTML directory.
HTML_IMAGES = HTML_IMAGES =

7
docs/plugins/gst-ffmpeg-plugins-docs.sgml
View file

@ -10,8 +10,15 @@
<title>GStreamer FFMPeg &GST_MAJORMINOR; Plugins Reference Manual</title> <title>GStreamer FFMPeg &GST_MAJORMINOR; Plugins Reference Manual</title>
</bookinfo> </bookinfo>
<chapter>
<title>gst-ffmpeg Element Types</title>
<xi:include href="xml/type-ffenc.xml" />
</chapter>
<chapter> <chapter>
<title>gst-ffmpeg Elements</title> <title>gst-ffmpeg Elements</title>
<xi:include href="xml/element-ffenc_h263p.xml" />
<xi:include href="xml/element-ffenc_mpeg4.xml" />
</chapter> </chapter>
<chapter> <chapter>