vcs.maemo.org Git - clutter-gtk/blob - doc/reference/Makefile.am

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