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_MAJORMINOR@
   7 DOC_MODULE=gst-plugins-base-plugins
   8
   9 # for upload.mak
  10 DOC=gst-plugins-base-plugins
  11 FORMATS=html
  12 html: html-build.stamp
  13 include $(srcdir)/../upload.mak
  14
  15 # generated basefiles
  16 #basefiles = \
  17 ##              $(DOC_MODULE).types \
  18 #               $(DOC_MODULE)-sections.txt \
  19 #               $(DOC_MODULE)-docs.sgml
  20
  21 # ugly hack to make -unused.sgml work
  22 #unused-build.stamp:
  23 #       BUILDDIR=`pwd` && \
  24 #       cd $(srcdir)/tmpl && \
  25 #       ln -sf gstreamer-libs-unused.sgml \
  26 #               $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
  27 #       touch unused-build.stamp
  28
  29 # these rules are added to create parallel docs using GST_MAJORMINOR
  30 #$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
  31 #       cp $< $@
  32
  33 #CLEANFILES = $(basefiles)
  34
  35 # The top-level SGML file. Change it if you want.
  36 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  37
  38 # The directory containing the source code. Relative to $(top_srcdir).
  39 # gtk-doc will search all .c & .h files beneath here for inline comments
  40 # documenting functions and macros.
  41 DOC_SOURCE_DIR = $(top_srcdir)
  42
  43 # Extra options to supply to gtkdoc-scan.
  44 SCAN_OPTIONS=
  45
  46 # FIXME :
  47 # there's something wrong with gstreamer-sections.txt not being in the dist
  48 # maybe it doesn't resolve; we're adding it below for now
  49 #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
  50
  51 # Extra options to supply to gtkdoc-mkdb.
  52 MKDB_OPTIONS=--sgml-mode --ignore-files=trio
  53
  54 # Extra options to supply to gtkdoc-fixref.
  55 # FIXME get the location of the installed gstreamer docs
  56 #FIXXREF_OPTIONS=--extra-dir=../gst/html
  57
  58 # Used for dependencies.
  59 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
  60 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
  61
  62 # this is a wingo addition
  63 # thomasvs: another nice wingo addition would be an explanation on why
  64 # this is useful ;)
  65
  66 SCANOBJ_DEPS =
  67
  68 # Header files to ignore when scanning.
  69 IGNORE_HFILES = avcodec.h gstffmpegcodecmap.h
  70
  71 EXTRA_HFILES = $(top_srcdir)/gst/tcp/gstmultifdsink.h
  72
  73 # Images to copy into HTML directory.
  74 HTML_IMAGES =
  75
  76 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  77 content_files =
  78
  79 # Other files to distribute.
  80 extra_files =
  81
  82 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  83 # contains GtkObjects/GObjects and you want to document signals and properties.
  84 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
  85 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
  86
  87 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
  88 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
  89
  90 # If you need to override some of the declarations, place them in this file
  91 # and uncomment this line.
  92 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
  93 DOC_OVERRIDES =
  94
  95 include $(top_srcdir)/common/gtk-doc-plugins.mak