docs/libs/Makefile.am

   1 ## Process this file with automake to produce Makefile.in
   2
   3 # FIXME: fix the docs then remove this variable
   4 DOCS_ARE_INCOMPLETE_PLEASE_FIXME=yespleasedo
   5
   6 # The name of the module, e.g. 'glib'.
   7 #DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
   8 DOC_MODULE=gst-plugins-base-libs
   9
  10 # for upload-doc.mak
  11 DOC=gst-plugins-base-libs
  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.
  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-libs/gst
  23
  24 # Extra options to supply to gtkdoc-scan.
  25 SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
  26
  27 # Extra options to supply to gtkdoc-mkdb.
  28 MKDB_OPTIONS=--sgml-mode  --output-format=xml
  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
  34 # Used for dependencies.
  35 HFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.h
  36 CFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.c
  37
  38 # Header files to ignore when scanning.
  39 IGNORE_HFILES = pbutils-private.h gsttageditingprivate.h id3v2.h \
  40         kiss_fft_f32.h kiss_fft_f64.h kiss_fftr_f32.h kiss_fftr_f64.h \
  41         kiss_fftr_s16.h kiss_fftr_s32.h kiss_fft_s16.h kiss_fft_s32.h \
  42         _kiss_fft_guts_f32.h _kiss_fft_guts_f64.h _kiss_fft_guts_s16.h \
  43         _kiss_fft_guts_s16.h _kiss_fft_guts_s32.h _kiss_fft_guts_s32.h \
  44         interfaces-marshal.h pbutils-marshal.h
  45
  46
  47 # Images to copy into HTML directory.
  48 HTML_IMAGES =
  49
  50 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  51 content_files = compiling.sgml
  52
  53 # Other files to distribute.
  54 extra_files =
  55
  56 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  57 # contains GtkObjects/GObjects and you want to document signals and properties.
  58 GTKDOC_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS) -DGST_USE_UNSTABLE_API
  59 GTKDOC_LIBS = \
  60         $(top_builddir)/gst-libs/gst/interfaces/libgstinterfaces-@GST_API_VERSION@.la \
  61         $(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_API_VERSION@.la \
  62         $(top_builddir)/gst-libs/gst/fft/libgstfft-@GST_API_VERSION@.la \
  63         $(top_builddir)/gst-libs/gst/rtp/libgstrtp-@GST_API_VERSION@.la \
  64         $(top_builddir)/gst-libs/gst/rtsp/libgstrtsp-@GST_API_VERSION@.la \
  65         $(top_builddir)/gst-libs/gst/sdp/libgstsdp-@GST_API_VERSION@.la \
  66         $(top_builddir)/gst-libs/gst/tag/libgsttag-@GST_API_VERSION@.la \
  67         $(top_builddir)/gst-libs/gst/video/libgstvideo-@GST_API_VERSION@.la \
  68         $(top_builddir)/gst-libs/gst/app/libgstapp-@GST_API_VERSION@.la \
  69         $(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_API_VERSION@.la \
  70   $(GST_BASE_LIBS)
  71
  72 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
  73 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
  74
  75 # If you need to override some of the declarations, place them in this file
  76 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
  77
  78 include $(top_srcdir)/common/gtk-doc.mak