docs/libs/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-libs-@GST_MAJORMINOR@
   5 DOC_MODULE=gstreamer-libs
   6
   7 # for upload.mak
   8 DOC=gstreamer-libs
   9 FORMATS=html
  10 html: html-build.stamp
  11 include $(top_srcdir)/common/upload.mak
  12
  13 # generated basefiles
  14 #basefiles = \
  15 #               $(DOC_MODULE).types \
  16 #               $(DOC_MODULE)-sections.txt \
  17 #               $(DOC_MODULE)-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-libs-unused.sgml \
  24 #               $$BUILDDIR/tmpl/gstreamer-libs-@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-libs-@GST_MAJORMINOR@%: gstreamer-libs%
  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)/libs/gst
  40 DOC_BUILD_DIR=$(top_builddir)/libs/gst
  41
  42 # Extra options to supply to gtkdoc-scan.
  43 SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
  44
  45 # FIXME :
  46 # there's something wrong with gstreamer-sections.txt not being in the dist
  47 # maybe it doesn't resolve; we're adding it below for now
  48 #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
  49
  50 # Extra options to supply to gtkdoc-mkdb.
  51 MKDB_OPTIONS= --output-format=xml --sgml-mode --ignore-files=trio
  52
  53 # Extra options to supply to gtkdoc-fixref.
  54 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  55         --extra-dir=$(datadir)/gtk-doc/html
  56
  57 # Used for dependencies.
  58 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.h
  59 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
  60
  61 # Dependencies for the intermediate scanobj tool
  62 SCANOBJ_DEPS = $(top_builddir)/libs/gst/controller/libgstcontroller-@GST_MAJORMINOR@.la \
  63         $(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la
  64
  65 # Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
  66 SCANOBJ_OPTIONS=--type-init-func="g_type_init();gst_init(&argc,&argv)"
  67
  68 # Header files to ignore when scanning.
  69 IGNORE_HFILES = \
  70         gstgetbits_inl.h \
  71         dp-private.h
  72
  73 # Images to copy into HTML directory.
  74 HTML_IMAGES = gdp-header.png
  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_OBJ_CFLAGS) -I$(top_builddir) -I$(top_builddir)/libs
  85 GTKDOC_LIBS = $(GST_OBJ_LIBS) $(SCANOBJ_DEPS)
  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
  94 include $(top_srcdir)/common/gtk-doc.mak