doc/reference/Makefile.am

   1 # This is a blank Makefile.am for using gtk-doc.
   2 # Copy this to your project's API docs directory and modify the variables to
   3 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
   4 # of using the various options.
   5
   6 # The name of the module, e.g. 'glib'.
   7 DOC_MODULE = json-glib
   8
   9 # The top-level XML file. You can change this if you want to.
  10 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
  11
  12 # The directory containing the source code. Relative to $(srcdir).
  13 # gtk-doc will search all .c & .h files beneath here for inline comments
  14 # documenting the functions and macros.
  15 # e.g. DOC_SOURCE_DIR=../../../gtk
  16 DOC_SOURCE_DIR = ../../json-glib
  17
  18 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  19 SCANGOBJ_OPTIONS = --type-init-func="g_type_init()"
  20
  21 # Extra options to supply to gtkdoc-scan.
  22 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  23 SCAN_OPTIONS = --deprecated-guards="JSON_DISABLE_DEPRECATED"
  24
  25 # Extra options to supply to gtkdoc-mkdb.
  26 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
  27 MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=json
  28
  29 # Extra options to supply to gtkdoc-mktmpl
  30 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  31 MKTMPL_OPTIONS =
  32
  33 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  34 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  35 FIXXREF_OPTIONS = \
  36         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
  37         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
  38         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio
  39
  40 # Used for dependencies. The docs will be rebuilt if any of these change.
  41 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  42 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  43 HFILE_GLOB = $(top_srcdir)/json-glib/*.h $(top_builddir)/json-glib/*.h
  44 CFILE_GLOB = $(top_srcdir)/json-glib/*.c
  45
  46 # Header files to ignore when scanning.
  47 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
  48 IGNORE_HFILES = \
  49         json-scanner.h          \
  50         json-types-private.h    \
  51         json-gobject-private.h  \
  52         json-private.h          \
  53         json-marshal.h          \
  54         json-glib.h             \
  55         json-enum-types.h       \
  56         json-debug.h
  57
  58 EXTRA_HFILES =
  59
  60 # Images to copy into HTML directory.
  61 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  62 HTML_IMAGES =
  63
  64 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  65 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  66 content_files = version.xml
  67
  68 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
  69 # These files must be listed here *and* in content_files
  70 # e.g. expand_content_files=running.sgml
  71 expand_content_files =
  72
  73 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  74 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  75 # signals and properties.
  76 # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  77 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  78
  79 INCLUDES = -I$(top_srcdir) -I$(top_builddir) $(JSON_CFLAGS)
  80 GTKDOC_LIBS = $(top_builddir)/json-glib/libjson-glib-1.0.la $(JSON_LIBS)
  81
  82 # needed to avoid including Makefile.am.gtest which redeclares
  83 # EXTRA_DIST and generates a warning when the gtk-doc.make include
  84 # below
  85 test-report:
  86         @true
  87
  88 test:
  89         @true
  90
  91 check-local: test
  92
  93 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  94 include $(top_srcdir)/gtk-doc.make
  95
  96 # Other files to distribute
  97 # e.g. EXTRA_DIST += version.xml.in
  98 EXTRA_DIST += version.xml.in