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.mak
  11 DOC=gst-plugins-base-libs
  12 FORMATS=html
  13 html: html-build.stamp
  14 include $(top_srcdir)/common/upload.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=
  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 --ignore-files=trio
  55
  56 # Extra options to supply to gtkdoc-fixref.
  57 # FIXME get the location of the installed gstreamer docs
  58 #FIXXREF_OPTIONS=--extra-dir=../gst/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/tag/libgsttag-@GST_MAJORMINOR@.la
  73
  74 # Header files to ignore when scanning.
  75 IGNORE_HFILES =
  76
  77 # Images to copy into HTML directory.
  78 HTML_IMAGES =
  79
  80 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  81 content_files = compiling.sgml
  82
  83 # Other files to distribute.
  84 extra_files =
  85
  86 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  87 # contains GtkObjects/GObjects and you want to document signals and properties.
  88 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_srcdir)/gst-libs -I$(top_builddir)/gst-libs
  89 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
  90
  91 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
  92 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
  93
  94 # If you need to override some of the declarations, place them in this file
  95 # and uncomment this line.
  96 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
  97 DOC_OVERRIDES =
  98
  99 include $(top_srcdir)/common/gtk-doc.mak