docs/gst/Makefile.am

   1 ## Process this file with automake to produce Makefile.in
   2
   3 # The name of the module, e.g. 'glib'.
   4 # DOC_MODULE=gstreamer-@GST_MAJORMINOR@
   5 DOC_MODULE=gstreamer
   6
   7 # for upload.mak
   8 DOC=gstreamer
   9 FORMATS=html
  10 html: html-build.stamp
  11 include $(srcdir)/../upload.mak
  12
  13 # generated basefiles
  14 #basefiles = \
  15 #               gstreamer-@GST_MAJORMINOR@.types \
  16 #               gstreamer-@GST_MAJORMINOR@-sections.txt \
  17 #               gstreamer-@GST_MAJORMINOR@-docs.sgml
  18
  19 # ugly hack to make -unused.sgml work
  20 #unused-build.stamp:
  21 #       BUILDDIR=`pwd` && \
  22 #       cd $(srcdir)/tmpl && \
  23 #       ln -sf gstreamer-unused.sgml \
  24 #               $$BUILDDIR/tmpl/gstreamer-@GST_MAJORMINOR@-unused.sgml
  25 #       touch unused-build.stamp
  26
  27 # these rules are added to create parallel docs using GST_MAJORMINOR
  28 #$(basefiles): gstreamer-@GST_MAJORMINOR@%: gstreamer%
  29 #       cp $< $@
  30
  31 #CLEANFILES = $(basefiles)
  32
  33 # The top-level SGML file. Change it if you want.
  34 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  35
  36 # The directory containing the source code. Relative to $(top_srcdir).
  37 # gtk-doc will search all .c & .h files beneath here for inline comments
  38 # documenting functions and macros.
  39 DOC_SOURCE_DIR=$(top_srcdir)/gst
  40
  41 # Extra options to supply to gtkdoc-scan.
  42 SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
  43
  44 # Extra options to supply to gtkdoc-mkdb.
  45 MKDB_OPTIONS=--sgml-mode --ignore-files=parse
  46
  47 # Extra options to supply to gtkdoc-fixref.
  48 FIXXREF_OPTIONS=
  49
  50 # Used for dependencies.
  51 HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
  52 CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
  53
  54 # Dependencies for the intermediate scanobj tool
  55 #SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
  56 #       $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
  57 SCANOBJ_DEPS = \
  58         $(top_builddir)/gst/elements/libgstelements.la \
  59         $(top_builddir)/gst/base/libgstbase-@GST_MAJORMINOR@.la
  60
  61 # Header files to ignore when scanning. Use base file name, no paths
  62 IGNORE_HFILES= \
  63         gettext.h \
  64         gst-i18n-lib.h \
  65         gst-i18n-app.h \
  66         gst_private.h \
  67         gstdata_private.h \
  68         gstarch.h \
  69         cothreads.h \
  70         cothreads_compat.h \
  71         gthread-cothreads.h \
  72         faircothreads.h \
  73         types.h \
  74         glib-compat.h \
  75         grammar.tab.h \
  76         gstmarshal.h \
  77         gstaggregator.h \
  78         gstbufferstore.h \
  79         gstfdsink.h \
  80         gstfdsrc.h \
  81         gstidentity.h \
  82         gstmacros.h \
  83         gstmd5sink.h \
  84         gstmultifilesrc.h \
  85         gstmultifdsink.h \
  86         gstpipefilter.h \
  87         gstshaper.h \
  88         gststatistics.h \
  89         gsttee.h \
  90         gsttrashstack.h \
  91         gsttypefindelement.h \
  92         gstspider.h \
  93         gstspideridentity.h \
  94         gstsearchfuncs.h \
  95         gsttrashstack.h \
  96         gstxmlregistry.h
  97
  98 # Images to copy into HTML directory.
  99 HTML_IMAGES =
 100
 101 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 102 content_files = running.xml
 103
 104 # Other files to distribute.
 105 extra_files =
 106
 107 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
 108 # contains GtkObjects/GObjects and you want to document signals and properties.
 109 GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS)
 110 GTKDOC_LIBS = $(GST_OBJ_LIBS) $(SCANOBJ_DEPS)
 111
 112 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
 113 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
 114
 115 # If you need to override some of the declarations, place them in this file
 116 # and uncomment this line.
 117 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
 118
 119 include $(top_srcdir)/common/gtk-doc.mak