docs: update
[platform/upstream/gstreamer.git] / docs / plugins / Makefile.am
index 7130627..6cc27da 100644 (file)
@@ -3,7 +3,7 @@ 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@
+#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
 MODULE=gst-plugins-good
 DOC_MODULE=$(MODULE)-plugins
 
@@ -13,33 +13,13 @@ FORMATS=html
 html: html-build.stamp
 include $(top_srcdir)/common/upload-doc.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).
+# The directory containing the source code.
 # 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)/gst $(top_srcdir)/ext $(top_srcdir)/sys
 
 # Extra options to supply to gtkdoc-scan.
 SCAN_OPTIONS=
@@ -53,14 +33,11 @@ FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
        --extra-dir=$(GSTPB_PREFIX)/share/gtk-doc/html
 
 # Used for dependencies.
-HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
-CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c $(DOC_SOURCE_DIR)/*/*/*.cc $(DOC_SOURCE_DIR)/*/*/*.m
-
-# this is a wingo addition
-# thomasvs: another nice wingo addition would be an explanation on why
-# this is useful ;)
-
-SCANOBJ_DEPS =
+HFILE_GLOB= \
+  $(top_srcdir)/gst/*/*.h $(top_srcdir)/ext/*/*.h $(top_srcdir)/sys/*/*.h
+CFILE_GLOB= \
+  $(top_srcdir)/gst/*/*.c $(top_srcdir)/ext/*/*.c $(top_srcdir)/sys/*/*.c \
+  $(top_srcdir)/ext/*/*.cc $(top_srcdir)/sys/*/*.m
 
 # Header files to ignore when scanning.
 IGNORE_HFILES = 
@@ -76,8 +53,6 @@ IGNORE_CFILES =
 
 EXTRA_HFILES = \
        $(top_srcdir)/ext/aalib/gstaasink.h \
-       $(top_srcdir)/ext/annodex/gstcmmldec.h \
-       $(top_srcdir)/ext/annodex/gstcmmlenc.h \
        $(top_srcdir)/ext/cairo/gsttextoverlay.h \
        $(top_srcdir)/ext/cairo/gsttimeoverlay.h \
        $(top_srcdir)/ext/cairo/gstcairorender.h \
@@ -88,14 +63,10 @@ EXTRA_HFILES = \
        $(top_srcdir)/ext/flac/gstflacenc.h \
        $(top_srcdir)/ext/flac/gstflactag.h \
        $(top_srcdir)/ext/gdk_pixbuf/gstgdkpixbufsink.h \
-       $(top_srcdir)/ext/hal/gsthalaudiosink.h \
-       $(top_srcdir)/ext/hal/gsthalaudiosrc.h \
        $(top_srcdir)/ext/jack/gstjackaudiosrc.h \
        $(top_srcdir)/ext/jack/gstjackaudiosink.h \
        $(top_srcdir)/ext/jpeg/gstjpegdec.h \
        $(top_srcdir)/ext/jpeg/gstjpegenc.h \
-       $(top_srcdir)/ext/jpeg/gstsmokedec.h \
-       $(top_srcdir)/ext/jpeg/gstsmokeenc.h \
        $(top_srcdir)/ext/libcaca/gstcacasink.h \
        $(top_srcdir)/ext/libpng/gstpngdec.h \
        $(top_srcdir)/ext/libpng/gstpngenc.h \
@@ -106,12 +77,12 @@ EXTRA_HFILES = \
        $(top_srcdir)/ext/taglib/gstid3v2mux.h \
        $(top_srcdir)/ext/pulse/pulsesink.h \
        $(top_srcdir)/ext/pulse/pulsesrc.h \
-       $(top_srcdir)/ext/pulse/pulsemixer.h \
        $(top_srcdir)/ext/speex/gstspeexenc.h \
        $(top_srcdir)/ext/speex/gstspeexdec.h \
+       $(top_srcdir)/ext/vpx/gstvp8dec.h \
+       $(top_srcdir)/ext/vpx/gstvp8enc.h \
        $(top_srcdir)/ext/wavpack/gstwavpackdec.h \
        $(top_srcdir)/ext/wavpack/gstwavpackenc.h \
-       $(top_srcdir)/ext/wavpack/gstwavpackparse.h \
        $(top_srcdir)/gst/alpha/gstalpha.h \
        $(top_srcdir)/gst/alpha/gstalphacolor.h \
        $(top_srcdir)/gst/apetag/gstapedemux.h \
@@ -183,6 +154,7 @@ EXTRA_HFILES = \
        $(top_srcdir)/gst/monoscope/gstmonoscope.h \
        $(top_srcdir)/gst/multifile/gstmultifilesink.h \
        $(top_srcdir)/gst/multifile/gstmultifilesrc.h \
+       $(top_srcdir)/gst/multifile/gstsplitfilesrc.h \
        $(top_srcdir)/gst/multipart/multipartdemux.h \
        $(top_srcdir)/gst/multipart/multipartmux.h \
        $(top_srcdir)/gst/isomp4/qtdemux.h \
@@ -213,18 +185,14 @@ EXTRA_HFILES = \
        $(top_srcdir)/gst/videofilter/gstgamma.h \
        $(top_srcdir)/gst/videofilter/gstvideobalance.h \
        $(top_srcdir)/gst/videofilter/gstvideoflip.h \
-       $(top_srcdir)/gst/videomixer/videomixer.h \
-       $(top_srcdir)/gst/videomixer/videomixerpad.h \
        $(top_srcdir)/gst/videomixer/videomixer2.h \
        $(top_srcdir)/gst/videomixer/videomixer2pad.h \
        $(top_srcdir)/gst/wavenc/gstwavenc.h \
        $(top_srcdir)/gst/wavparse/gstwavparse.h \
        $(top_srcdir)/gst/y4m/gsty4mencode.h \
        $(top_srcdir)/sys/directsound/gstdirectsoundsink.h \
-       $(top_srcdir)/sys/oss4/oss4-mixer.h \
        $(top_srcdir)/sys/oss4/oss4-sink.h \
        $(top_srcdir)/sys/oss4/oss4-source.h \
-       $(top_srcdir)/sys/oss/gstossmixerelement.h \
        $(top_srcdir)/sys/oss/gstosssink.h \
        $(top_srcdir)/sys/oss/gstosssrc.h \
        $(top_srcdir)/sys/osxaudio/gstosxaudiosrc.h \
@@ -255,7 +223,7 @@ 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_LIBS = $(GST_BASE_LIBS)
 
 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)