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_MAJORMINOR@
   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 # generated basefiles
  17 #basefiles = \
  18 ##              $(DOC_MODULE).types \
  19 #               $(DOC_MODULE)-sections.txt \
  20 #               $(DOC_MODULE)-docs.sgml
  21
  22 # ugly hack to make -unused.sgml work
  23 #unused-build.stamp:
  24 #       BUILDDIR=`pwd` && \
  25 #       cd $(srcdir)/tmpl && \
  26 #       ln -sf gstreamer-libs-unused.sgml \
  27 #               $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
  28 #       touch unused-build.stamp
  29
  30 # these rules are added to create parallel docs using GST_MAJORMINOR
  31 #$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
  32 #       cp $< $@
  33
  34 #CLEANFILES = $(basefiles)
  35
  36 # The top-level SGML file. Change it if you want.
  37 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  38
  39 # The directory containing the source code. Relative to $(top_srcdir).
  40 # gtk-doc will search all .c & .h files beneath here for inline comments
  41 # documenting functions and macros.
  42 DOC_SOURCE_DIR=$(top_srcdir)/gst-libs/gst
  43 DOC_BUILD_DIR=$(top_builddir)/gst-libs/gst
  44
  45 # Extra options to supply to gtkdoc-scan.
  46 SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
  47
  48 # FIXME :
  49 # there's something wrong with gstreamer-sections.txt not being in the dist
  50 # maybe it doesn't resolve; we're adding it below for now
  51 #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
  52
  53 # Extra options to supply to gtkdoc-mkdb.
  54 MKDB_OPTIONS=--sgml-mode  --output-format=xml
  55
  56 # Extra options to supply to gtkdoc-fixref.
  57 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  58         --extra-dir=$(GST_PREFIX)/share/gtk-doc/html
  59
  60 # Used for dependencies.
  61 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.h
  62 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
  63
  64 # this is a wingo addition
  65 # thomasvs: another nice wingo addition would be an explanation on why
  66 # this is useful ;)
  67
  68 SCANOBJ_DEPS = \
  69         $(top_builddir)/gst-libs/gst/interfaces/libgstinterfaces-@GST_MAJORMINOR@.la \
  70         $(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_MAJORMINOR@.la \
  71         $(top_builddir)/gst-libs/gst/cdda/libgstcdda-@GST_MAJORMINOR@.la \
  72         $(top_builddir)/gst-libs/gst/fft/libgstfft-@GST_MAJORMINOR@.la \
  73         $(top_builddir)/gst-libs/gst/rtp/libgstrtp-@GST_MAJORMINOR@.la \
  74         $(top_builddir)/gst-libs/gst/rtsp/libgstrtsp-@GST_MAJORMINOR@.la \
  75         $(top_builddir)/gst-libs/gst/sdp/libgstsdp-@GST_MAJORMINOR@.la \
  76         $(top_builddir)/gst-libs/gst/tag/libgsttag-@GST_MAJORMINOR@.la \
  77         $(top_builddir)/gst-libs/gst/video/libgstvideo-@GST_MAJORMINOR@.la \
  78         $(top_builddir)/gst-libs/gst/app/libgstapp-@GST_MAJORMINOR@.la \
  79         $(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_MAJORMINOR@.la
  80
  81 # Header files to ignore when scanning.
  82 IGNORE_HFILES = pbutils-private.h gsttageditingprivate.h id3v2.h \
  83         kiss_fft_f32.h kiss_fft_f64.h kiss_fftr_f32.h kiss_fftr_f64.h \
  84         kiss_fftr_s16.h kiss_fftr_s32.h kiss_fft_s16.h kiss_fft_s32.h \
  85         _kiss_fft_guts_f32.h _kiss_fft_guts_f64.h _kiss_fft_guts_s16.h \
  86         _kiss_fft_guts_s16.h _kiss_fft_guts_s32.h _kiss_fft_guts_s32.h \
  87         interfaces-marshal.h pbutils-marshal.h
  88
  89
  90 # Images to copy into HTML directory.
  91 HTML_IMAGES =
  92
  93 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  94 content_files = compiling.sgml
  95
  96 # Other files to distribute.
  97 extra_files =
  98
  99 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
 100 # contains GtkObjects/GObjects and you want to document signals and properties.
 101 GTKDOC_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS) -DGST_USE_UNSTABLE_API
 102 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
 103
 104 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
 105 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
 106
 107 # If you need to override some of the declarations, place them in this file
 108 # and uncomment this line.
 109 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
 110 DOC_OVERRIDES =
 111
 112 include $(top_srcdir)/common/gtk-doc.mak