doc/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=gupnp
  13
  14 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
  15 #DOC_MODULE_VERSION=2
  16
  17
  18 # The top-level SGML file. You can change this if you want to.
  19 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
  20
  21 # Directories containing the source code.
  22 # gtk-doc will search all .c and .h files beneath these paths
  23 # for inline comments documenting functions and macros.
  24 # e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
  25 DOC_SOURCE_DIR=../libgupnp
  26
  27 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  28 SCANGOBJ_OPTIONS=
  29
  30 # Extra options to supply to gtkdoc-scan.
  31 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  32 SCAN_OPTIONS=--deprecated-guards="GUPNP_DISABLE_DEPRECATED"
  33
  34 # Extra options to supply to gtkdoc-mkdb.
  35 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  36 MKDB_OPTIONS=--xml-mode --output-format=xml
  37
  38 # Extra options to supply to gtkdoc-mktmpl
  39 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  40 MKTMPL_OPTIONS=
  41
  42 # Extra options to supply to gtkdoc-mkhtml
  43 MKHTML_OPTIONS=
  44
  45 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  46 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  47 FIXXREF_OPTIONS=
  48
  49 # Used for dependencies. The docs will be rebuilt if any of these change.
  50 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  51 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  52 HFILE_GLOB=$(top_srcdir)/libgupnp/*.h
  53 CFILE_GLOB=$(top_srcdir)/libgupnp/*.c
  54
  55 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  56 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  57 EXTRA_HFILES=
  58
  59 # Header files or dirs to ignore when scanning. Use base file/dir names
  60 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  61 IGNORE_HFILES=gena-protocol.h                           \
  62               xml-util.h                                \
  63               gvalue-util.h                             \
  64               http-headers.h                            \
  65               gupnp-marshal.h                           \
  66               gupnp-context-private.h                   \
  67               gupnp-linux-context-manager.h             \
  68               gupnp-network-manager.h                   \
  69               gupnp-unix-context-manager.h              \
  70               gupnp-device-info-private.h               \
  71               gupnp-error-private.h                     \
  72               gupnp-resource-factory-private.h          \
  73               gupnp-service-introspection-private.h     \
  74               gupnp-types-private.h
  75
  76 # Images to copy into HTML directory.
  77 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  78 HTML_IMAGES=
  79
  80 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  81 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  82 content_files=overview.xml client-tutorial.xml server-tutorial.xml gupnp-binding-tool.xml device-description.rnc service-description.rnc glossary.xml
  83
  84 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
  85 # These files must be listed here *and* in content_files
  86 # e.g. expand_content_files=running.sgml
  87 expand_content_files=client-tutorial.xml server-tutorial.xml
  88
  89 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  90 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  91 # signals and properties.
  92 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  93 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  94 GTKDOC_CFLAGS=-I$(top_srcdir) $(LIBGUPNP_CFLAGS)
  95 GTKDOC_LIBS=$(top_builddir)/libgupnp/libgupnp-1.0.la $(LIBGUPNP_LIBS)
  96
  97 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  98 include $(top_srcdir)/gtk-doc.make
  99
 100 # Other files to distribute
 101 # e.g. EXTRA_DIST += version.xml.in
 102 EXTRA_DIST += version.xml.in
 103
 104 # Files not to distribute
 105 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 106 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
 107 #DISTCLEANFILES +=
 108
 109 # Comment this out if you want 'make check' to test you doc status
 110 # and run some sanity checks
 111 if ENABLE_GTK_DOC
 112 TESTS_ENVIRONMENT = cd $(srcdir) && \
 113   DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
 114   SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
 115 #  TESTS = $(GTKDOC_CHECK)
 116 endif
 117
 118 -include $(top_srcdir)/git.mk