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.

diff --git a/ChangeLog b/ChangeLog
index 9bfef737944808b51b73c8cde8add7e459852f51..51cfbb2465740c98bb3f6fa8920c398e068b2be0 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -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>
 
        * configure.ac:

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index b928a088a836d4830bff89488f0fda8dab365ec2..d478c6310ea3271815f13fcf10a3ee2f9e15ab7a 100644 (file)
--- 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 05b59124b6983ec462a8915b0c3c5c50340d1b50..8003276812d7390c29c28c7a123263a97b66126d 100644 (file)
--- a/docs/plugins/gst-ffmpeg-plugins-docs.sgml
+++ b/docs/plugins/gst-ffmpeg-plugins-docs.sgml
@@ -10,8 +10,15 @@
     <title>GStreamer FFMPeg &GST_MAJORMINOR; Plugins Reference Manual</title>
   </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>