docs/reference/Makefile.am
author ali <ali@juiblex.co.uk>
Wed Oct 10 22:58:21 2012 +0100 (2012-10-10)
changeset 0 bc8c9a11cbfc
permissions -rw-r--r--
Initial version
     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=libxexpr
    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 # The directory containing the source code. Relative to $(srcdir).
    22 # gtk-doc will search all .c & .h files beneath here for inline comments
    23 # documenting the functions and macros.
    24 # e.g. DOC_SOURCE_DIR=../../../gtk
    25 DOC_SOURCE_DIR=../../libxexpr
    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=--rebuild-types --rebuild-sections
    33 
    34 # Extra options to supply to gtkdoc-mkdb.
    35 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
    36 MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=xexpr
    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)/libxexpr/*.h
    53 CFILE_GLOB=$(top_srcdir)/libxexpr/*.c
    54 
    55 # Header files to ignore when scanning.
    56 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
    57 IGNORE_HFILES=xexpr.h xexprprivate.h
    58 
    59 # Images to copy into HTML directory.
    60 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
    61 HTML_IMAGES=
    62 
    63 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
    64 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
    65 content_files=version.xml implementation_defined_behaviour.xml \
    66     language_extensions.xml xexpr.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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
    77 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
    78 GTKDOC_CFLAGS=
    79 GTKDOC_LIBS=
    80 
    81 # This includes the standard gtk-doc make rules, copied by gtkdocize.
    82 include $(top_srcdir)/gtk-doc.make
    83 
    84 # Other files to distribute
    85 # e.g. EXTRA_DIST += version.xml.in
    86 EXTRA_DIST+=version.xml.in
    87 
    88 # Files not to distribute
    89 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
    90 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
    91 DISTCLEANFILES=$(DOC_MODULE).types $(DOC_MODULE)-sections.txt
    92 
    93 # Comment this out if you want your docs-status tested during 'make check'
    94 TESTS_ENVIRONMENT=cd $(srcdir) &&
    95 TESTS=$(GTKDOC_CHECK)