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 # 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.sgml
  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=../../lib --source-dir=../../libextra
  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=--ignore-decorators=ASN1_API \
  33         --deprecated-guards=ASN1_DISABLE_DEPRECATED
  34
  35 # Extra options to supply to gtkdoc-mkdb.
  36 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
  37 MKDB_OPTIONS=--sgml-mode --output-format=xml
  38
  39 # Extra options to supply to gtkdoc-mktmpl
  40 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  41 MKTMPL_OPTIONS=
  42
  43 # Extra options to supply to gtkdoc-mkhtml
  44 MKHTML_OPTIONS=
  45
  46 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  47 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  48 FIXXREF_OPTIONS=
  49
  50 # Used for dependencies. The docs will be rebuilt if any of these change.
  51 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  52 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  53 HFILE_GLOB=$(top_srcdir)/lib/includes/gnutls/*.h $(top_builddir)/lib/includes/gnutls/*.h $(top_srcdir)/libextra/includes/gnutls/*.h
  54 CFILE_GLOB=$(top_srcdir)/lib/*.c \
  55         $(top_srcdir)/lib/x509/*.c \
  56         $(top_srcdir)/lib/openpgp/*.c \
  57         $(top_srcdir)/libextra/*.c \
  58         $(top_srcdir)/lib/minitasn1/*.c \
  59         $(top_srcdir)/libextra/*.c
  60
  61 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  62 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  63 EXTRA_HFILES=
  64
  65 # Header files to ignore when scanning. Use base file name, no paths
  66 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
  67 IGNORE_HFILES=compat.h
  68
  69 # cd lib/ && echo *.h | sed 's/crypto.h//'
  70 IGNORE_HFILES += auth_anon.h auth_cert.h auth_dh_common.h auth_psk.h    \
  71         auth_psk_passwd.h auth_srp.h auth_srp_passwd.h config.h         \
  72         debug.h ext_cert_type.h ext_max_record.h ext_oprfi.h    \
  73         ext_safe_renegotiation.h ext_server_name.h                      \
  74         ext_session_ticket.h ext_signature.h ext_srp.h                  \
  75         gnutls_algorithms.h gnutls_auth.h gnutls_buffers.h              \
  76         gnutls_cert.h gnutls_cipher.h gnutls_cipher_int.h               \
  77         gnutls_compress.h gnutls_constate.h gnutls_cryptodev.h          \
  78         gnutls_datum.h gnutls_db.h gnutls_dh.h gnutls_errors.h          \
  79         gnutls_extensions.h gnutls_global.h gnutls_handshake.h          \
  80         gnutls_hash_int.h gnutls_helper.h gnutls_int.h gnutls_kx.h      \
  81         gnutls_mem.h gnutls_mpi.h gnutls_num.h gnutls_pk.h              \
  82         gnutls_record.h gnutls_rsa_export.h gnutls_session_pack.h       \
  83         gnutls_sig.h gnutls_srp.h gnutls_state.h gnutls_str.h           \
  84         gnutls_supplemental.h gnutls_v2_compat.h gnutls_x509.h          \
  85         random.h x509_b64.h
  86
  87 # cd lib/gl/ && echo *.h
  88 IGNORE_HFILES += alignof.h alloca.h alloca.in.h arg-nonnull.h           \
  89         byteswap.in.h c-ctype.h close-hook.h errno.in.h float+.h        \
  90         float.in.h gettext.h minmax.h netdb.in.h printf-args.h          \
  91         printf-parse.h read-file.h size_max.h sockets.h stdbool.in.h    \
  92         stddef.in.h stdint.in.h stdio.h stdio-impl.h stdio.in.h         \
  93         stdlib.h stdlib.in.h string.h string.in.h strings.h             \
  94         strings.in.h str-two-way.h sys_socket.in.h sys_stat.in.h        \
  95         time.h time.in.h unistd.h unistd.in.h w32sock.h warn-on-use.h   \
  96         vasnprintf.h wchar.h wchar.in.h xsize.h
  97
  98 # cd lib/minitasn1/ && echo *.h
  99 IGNORE_HFILES += element.h gstr.h int.h parser_aux.h structure.h
 100
 101 # cd lib/opencdk/ && echo *.h
 102 IGNORE_HFILES += context.h filters.h keydb.h main.h opencdk.h packet.h  \
 103         stream.h types.h
 104
 105 # cd lib/openpgp/ && echo *.h
 106 IGNORE_HFILES += gnutls_openpgp.h openpgp_int.h
 107
 108 # cd lib/x509/ && echo *.h
 109 IGNORE_HFILES += common.h pbkdf2-sha1.h x509_int.h
 110
 111 # cd lib/gl/tests/ && echo *.h
 112 IGNORE_HFILES += arg-nonnull.h intprops.h macros.h signature.h  \
 113         warn-on-use.h verify.h zerosize-ptr.h
 114
 115 # cd libextra/ && echo *.h
 116 IGNORE_HFILES += config.h ext_inner_application.h openssl_compat.h
 117
 118 # cd libextra/gl/ && echo *.h
 119 IGNORE_HFILES += hmac.h md5.h memxor.h
 120
 121 # Images to copy into HTML directory.
 122 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
 123 HTML_IMAGES=
 124
 125 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 126 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
 127 content_files=
 128
 129 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
 130 # These files must be listed here *and* in content_files
 131 # e.g. expand_content_files=running.sgml
 132 expand_content_files=
 133
 134 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
 135 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
 136 # signals and properties.
 137 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 138 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
 139 GTKDOC_CFLAGS=
 140 GTKDOC_LIBS=
 141
 142 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 143 include $(top_srcdir)/gtk-doc.make
 144
 145 # Other files to distribute
 146 # e.g. EXTRA_DIST += version.xml.in
 147 EXTRA_DIST +=
 148
 149 # Files not to distribute
 150 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 151 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
 152 #DISTCLEANFILES +=
 153
 154 # Comment this out if you want your docs-status tested during 'make check'
 155 if ENABLE_GTK_DOC
 156 #TESTS_ENVIRONMENT = cd $(srcsrc)
 157 #TESTS = $(GTKDOC_CHECK)
 158 endif