diff options
| author | Thomas Vander Stichele <thomas@apestaart.org> | 2006-01-31 09:25:09 +0000 |
|---|---|---|
| committer | Thomas Vander Stichele <thomas@apestaart.org> | 2006-01-31 09:25:09 +0000 |
| commit | 7ce7e929d14fde0c00f8faea28a17beacfba2519 (patch) | |
| tree | 0ede0a7334abc597bdde75eac235458e66770f42 /docs/plugins | |
| parent | fe142a2894fad175d6767f5e26a0ec0bd2f9672d (diff) | |
| download | gst-libav-7ce7e929d14fde0c00f8faea28a17beacfba2519.tar.gz | |
docs/plugins/: first stab at documenting ffmpeg elements. Needs work.
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.
Diffstat (limited to 'docs/plugins')
| -rw-r--r-- | docs/plugins/Makefile.am | 12 | ||||
| -rw-r--r-- | docs/plugins/gst-ffmpeg-plugins-docs.sgml | 7 |
2 files changed, 13 insertions, 6 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index b928a08..d478c63 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -39,7 +39,7 @@ 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) +DOC_SOURCE_DIR = $(top_srcdir)/ext/ffmpeg # Extra options to supply to gtkdoc-scan. SCAN_OPTIONS= @@ -52,8 +52,8 @@ MKDB_OPTIONS=--sgml-mode #FIXXREF_OPTIONS=--extra-dir=../gst/html # Used for dependencies. -HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h -CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c +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 @@ -62,8 +62,8 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c SCANOBJ_DEPS = # Header files to ignore when scanning. -IGNORE_HFILES = avcodec.h gstffmpegcodecmap.h dsputil.h -IGNORE_CFILES = utils.c mem.c imgconvert.c +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 @@ -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 # the registry won't have the element -EXTRA_HFILES = +EXTRA_HFILES = $(DOC_SOURCE_DIR)/gstffmpegenc.c # Images to copy into HTML directory. HTML_IMAGES = diff --git a/docs/plugins/gst-ffmpeg-plugins-docs.sgml b/docs/plugins/gst-ffmpeg-plugins-docs.sgml index 05b5912..8003276 100644 --- a/docs/plugins/gst-ffmpeg-plugins-docs.sgml +++ b/docs/plugins/gst-ffmpeg-plugins-docs.sgml @@ -11,7 +11,14 @@ </bookinfo> <chapter> + <title>gst-ffmpeg Element Types</title> + <xi:include href="xml/type-ffenc.xml" /> + </chapter> + + <chapter> <title>gst-ffmpeg Elements</title> + <xi:include href="xml/element-ffenc_h263p.xml" /> + <xi:include href="xml/element-ffenc_mpeg4.xml" /> </chapter> <chapter> |