docs/plugins/Makefile.am

   1 GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
   2
   3 ## Process this file with automake to produce Makefile.in
   4
   5 # The name of the module, e.g. 'glib'.
   6 #DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
   7 MODULE=gst-plugins-ugly
   8 DOC_MODULE=$(MODULE)-plugins
   9
  10 # for upload-doc.mak
  11 DOC=$(MODULE)-plugins
  12 FORMATS=html
  13 html: html-build.stamp
  14 include $(top_srcdir)/common/upload-doc.mak
  15
  16 # The top-level SGML file. Change it if you want.
  17 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  18
  19 # The directory containing the source code. Relative to $(top_srcdir).
  20 # gtk-doc will search all .c & .h files beneath here for inline comments
  21 # documenting functions and macros.
  22 DOC_SOURCE_DIR = $(top_srcdir)/gst $(top_srcdir)/ext
  23
  24 # Extra options to supply to gtkdoc-scan.
  25 SCAN_OPTIONS=
  26
  27 # Extra options to supply to gtkdoc-mkdb.
  28 MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc,m
  29
  30 # Extra options to supply to gtkdoc-fixref.
  31 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  32         --extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
  33         --extra-dir=$(GSTPB_PREFIX)/share/gtk-doc/html
  34
  35 # Used for dependencies.
  36 HFILE_GLOB= \
  37   $(top_srcdir)/gst/*/*.h $(top_srcdir)/ext/*/*.h
  38 CFILE_GLOB= \
  39   $(top_srcdir)/gst/*/*.c $(top_srcdir)/ext/*/*.c $ $(top_srcdir)/ext/*/*.cc
  40
  41 # Header files to ignore when scanning.
  42 IGNORE_HFILES =
  43 IGNORE_CFILES =
  44
  45 # we add all .h files of elements that have signals/args we want
  46 # sadly this also pulls in the private methods - maybe we should
  47 # move those around in the source ?
  48 # also, we should add some stuff here conditionally based on whether
  49 # or not the plugin will actually build
  50 # but I'm not sure about that - it might be this Just Works given that
  51 # the registry won't have the element
  52
  53 # FIXME: not ported yet
  54 #       $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c
  55
  56 EXTRA_HFILES = \
  57         $(top_srcdir)/ext/a52dec/gsta52dec.h \
  58         $(top_srcdir)/ext/amrnb/amrnbdec.h \
  59         $(top_srcdir)/ext/amrnb/amrnbenc.h \
  60         $(top_srcdir)/ext/amrwbdec/amrwbdec.h \
  61         $(top_srcdir)/ext/cdio/gstcdiocddasrc.h \
  62         $(top_srcdir)/ext/sidplay/gstsiddec.h \
  63         $(top_srcdir)/ext/x264/gstx264enc.h \
  64         $(top_srcdir)/gst/asfdemux/gstrtspwms.h \
  65         $(top_srcdir)/gst/xingmux/gstxingmux.h \
  66         $(top_srcdir)/gst/realmedia/rademux.h \
  67         $(top_srcdir)/gst/realmedia/rdtmanager.h \
  68         $(top_srcdir)/gst/realmedia/rmdemux.h \
  69         $(top_srcdir)/gst/realmedia/rtspreal.h
  70
  71 # Images to copy into HTML directory.
  72 HTML_IMAGES =
  73
  74 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  75 content_files =
  76
  77 # Other files to distribute.
  78 extra_files =
  79
  80 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  81 # contains GtkObjects/GObjects and you want to document signals and properties.
  82 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir)
  83 GTKDOC_LIBS = $(GST_BASE_LIBS)
  84
  85 # If you need to override some of the declarations, place them in this file
  86 # and uncomment this line.
  87 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
  88 DOC_OVERRIDES =
  89
  90 include $(top_srcdir)/common/gtk-doc-plugins.mak