doc/reference/Makefile.am

   1 ## Process this file with automake to produce Makefile.in
   2
   3 # We require automake 1.6 at least.
   4 AUTOMAKE_OPTIONS = 1.6
   5
   6 # This is a blank Makefile.am for using gtk-doc.
   7 # Copy this to your project's API docs directory and modify the variables to
   8 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
   9 # of using the various options.
  10
  11 # The name of the module, e.g. 'glib'.
  12 DOC_MODULE=$(PACKAGE)
  13
  14 # The top-level SGML file. You can change this if you want to.
  15 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  16
  17 # The directory containing the source code. Relative to $(srcdir).
  18 # gtk-doc will search all .c & .h files beneath here for inline comments
  19 # documenting the functions and macros.
  20 # e.g. DOC_SOURCE_DIR=../../../gtk
  21 DOC_SOURCE_DIR=../../lib
  22
  23 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  24 SCANGOBJ_OPTIONS=
  25
  26 # Extra options to supply to gtkdoc-scan.
  27 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  28 SCAN_OPTIONS=
  29
  30 # Extra options to supply to gtkdoc-mkdb.
  31 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
  32 MKDB_OPTIONS=--sgml-mode --output-format=xml
  33
  34 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  35 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  36 FIXXREF_OPTIONS=
  37
  38 # Used for dependencies. The docs will be rebuilt if any of these change.
  39 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  40 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  41 HFILE_GLOB=$(top_srcdir)/lib/*.h
  42 CFILE_GLOB=$(top_srcdir)/lib/*.c
  43
  44 # Header files to ignore when scanning.
  45 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
  46 IGNORE_HFILES=defines.h errors.h int.h parser_aux.h der.h errors_int.h  \
  47         structure.h element.h gstr.h mem.h
  48
  49 # Images to copy into HTML directory.
  50 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  51 HTML_IMAGES=
  52
  53 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  54 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  55 content_files=
  56
  57 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  58 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  59 # signals and properties.
  60 # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  61 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  62 INCLUDES=
  63 GTKDOC_LIBS=
  64
  65 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  66 include $(top_srcdir)/gtk-doc.make
  67
  68 # Other files to distribute
  69 # e.g. EXTRA_DIST += version.xml.in
  70 EXTRA_DIST +=
  71
  72 # Files to remove for "make distclean".
  73 # Only needed if you let the makefile create some files that are typically
  74 # stored in CVS, such as $(DOC_MODULES).types.
  75 # e.g. DISTCLEANFILES = libidn.types
  76 DISTCLEANFILES = libtasn1.types