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 # 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=../../lib
  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=--xml-mode --output-format=xml
  37 MKDB_OPTIONS=--xml-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 \
  54         $(top_builddir)/lib/includes/gnutls/*.h
  55 CFILE_GLOB=$(top_srcdir)/lib/*.c \
  56         $(top_srcdir)/lib/x509/*.c \
  57         $(top_srcdir)/lib/openpgp/*.c \
  58         $(top_srcdir)/lib/minitasn1/*.c
  59
  60 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  61 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  62 EXTRA_HFILES=
  63
  64 # Header files or dirs to ignore when scanning. Use base file/dir names
  65 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  66 IGNORE_HFILES=
  67
  68 # find lib -name \*.h -exec basename {} \; | grep -v -e ^abstract.h$ -e ^crypto.h$ -e ^dtls.h$ -e ^gnutls.h$ -e ^openpgp.h$ -e ^pkcs11.h$ -e ^pkcs12.h$ -e ^x509.h$ -e ^ocsp.h$  -e ^tpm.h$ | sort | uniq | sed -e 's/^/\t/' -e 's/$/ \\/'
  69 IGNORE_HFILES += \
  70         abstract_int.h \
  71         accelerated.h \
  72         aes-padlock.h \
  73         aes-x86.h \
  74         algorithms.h \
  75         anon.h \
  76         cert.h \
  77         cert_type.h \
  78         common.h \
  79         compat.h \
  80         context.h \
  81         crypto-backend.h \
  82         cryptodev.h \
  83         debug.h \
  84         dh_common.h \
  85         ecc.h \
  86         ecdh_common.h \
  87         egd.h \
  88         element.h \
  89         filters.h \
  90         gnettle.h \
  91         gnutls_auth.h \
  92         gnutls_buffers.h \
  93         gnutls_cipher.h \
  94         gnutls_cipher_int.h \
  95         gnutls_compress.h \
  96         gnutls_constate.h \
  97         gnutls_datum.h \
  98         gnutls_db.h \
  99         gnutls_dh.h \
 100         gnutls_dtls.h \
 101         gnutls_ecc.h \
 102         gnutls_errors.h \
 103         gnutls_extensions.h \
 104         gnutls_global.h \
 105         gnutls_handshake.h \
 106         gnutls_hash_int.h \
 107         gnutls_helper.h \
 108         gnutls_int.h \
 109         gnutls_kx.h \
 110         gnutls_mbuffers.h \
 111         gnutls_mem.h \
 112         gnutls_mpi.h \
 113         gnutls_num.h \
 114         gnutls_openpgp.h \
 115         gnutls_pk.h \
 116         gnutls_record.h \
 117         gnutls_rsa_export.h \
 118         gnutls_session_pack.h \
 119         gnutls_sig.h \
 120         gnutls_srp.h \
 121         gnutls_state.h \
 122         gnutls_str_array.h \
 123         gnutls_str.h \
 124         gnutls_supplemental.h \
 125         gnutls_v2_compat.h \
 126         gnutls_x509.h \
 127         gnutlsxx.h \
 128         gstr.h \
 129         hash.h \
 130         heartbeat.h \
 131         int.h \
 132         keydb.h \
 133         libtasn1.h \
 134         locks.h \
 135         main.h \
 136         max_record.h \
 137         opencdk.h \
 138         openpgp_int.h \
 139         packet.h \
 140         parser_aux.h \
 141         pbkdf2-sha1.h \
 142         pin.h \
 143         pkcs11_int.h \
 144         psk.h \
 145         psk_passwd.h \
 146         randomart.h \
 147         random.h \
 148         safe_renegotiation.h \
 149         server_name.h \
 150         session_ticket.h \
 151         sha-padlock.h \
 152         signature.h \
 153         srp.h \
 154         srp_passwd.h \
 155         stream.h \
 156         structure.h \
 157         system.h \
 158         types.h \
 159         verify-high.h \
 160         x509_b64.h \
 161         x509_int.h \
 162         x86.h
 163
 164 # Images to copy into HTML directory.
 165 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
 166 HTML_IMAGES=
 167
 168 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 169 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
 170 content_files=
 171
 172 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
 173 # These files must be listed here *and* in content_files
 174 # e.g. expand_content_files=running.sgml
 175 expand_content_files=
 176
 177 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
 178 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
 179 # signals and properties.
 180 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 181 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
 182 GTKDOC_CFLAGS=
 183 GTKDOC_LIBS=
 184
 185 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 186 include $(top_srcdir)/gtk-doc.make
 187
 188 # Other files to distribute
 189 # e.g. EXTRA_DIST += version.xml.in
 190 EXTRA_DIST +=
 191
 192 # Files not to distribute
 193 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 194 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
 195 #DISTCLEANFILES +=
 196
 197 # Comment this out if you want 'make check' to test you doc status
 198 # and run some sanity checks
 199 if ENABLE_GTK_DOC
 200 TESTS_ENVIRONMENT = cd $(srcdir) && \
 201   DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
 202   SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
 203 #TESTS = $(GTKDOC_CHECK)
 204 endif
 205
 206 -include $(top_srcdir)/git.mk