diff options
| author | Simon Josefsson <simon@josefsson.org> | 2011-11-20 21:40:48 +0100 |
|---|---|---|
| committer | Simon Josefsson <simon@josefsson.org> | 2011-11-20 22:01:36 +0100 |
| commit | 83db2be6d126aafcd3641cec42cbfb3c76ff76e6 (patch) | |
| tree | b383069e49bab15bfca9e7851c6b3fb0b7f469f9 /doc/reference/Makefile.am | |
| parent | f1744a0b833fa8f4792c01a11d82b6525b237d3c (diff) | |
| download | libtasn1-83db2be6d126aafcd3641cec42cbfb3c76ff76e6.tar.gz libtasn1-83db2be6d126aafcd3641cec42cbfb3c76ff76e6.tar.bz2 libtasn1-83db2be6d126aafcd3641cec42cbfb3c76ff76e6.zip | |
Update GTK-DOC infrastructure.
Diffstat (limited to 'doc/reference/Makefile.am')
| -rw-r--r-- | doc/reference/Makefile.am | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 2c382f6..c6e3aed 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -18,10 +18,10 @@ DOC_MODULE=$(PACKAGE) # The top-level SGML file. You can change this if you want to. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml -# Directories containing the source code, relative to $(srcdir). +# Directories containing the source code. # gtk-doc will search all .c and .h files beneath these paths # for inline comments documenting functions and macros. -# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk +# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk DOC_SOURCE_DIR=../../lib # Extra options to pass to gtkdoc-scangobj. Not normally needed. @@ -33,8 +33,8 @@ SCAN_OPTIONS=--ignore-decorators=ASN1_API \ --deprecated-guards=ASN1_DISABLE_DEPRECATED # Extra options to supply to gtkdoc-mkdb. -# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml -MKDB_OPTIONS=--sgml-mode --output-format=xml +# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml +MKDB_OPTIONS=--xml-mode --output-format=xml # Extra options to supply to gtkdoc-mktmpl # e.g. MKTMPL_OPTIONS=--only-section-tmpl @@ -57,9 +57,9 @@ CFILE_GLOB=$(top_srcdir)/lib/*.c # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h EXTRA_HFILES= -# Header files to ignore when scanning. Use base file name, no paths -# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES=int.h parser_aux.h structure.h element.h gstr.h gllib +# Header files or dirs to ignore when scanning. Use base file/dir names +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code +IGNORE_HFILES=element.h gstr.h int.h parser_aux.h structure.h gllib # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png @@ -94,8 +94,13 @@ EXTRA_DIST += # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt #DISTCLEANFILES += -# Comment this out if you want your docs-status tested during 'make check' +# Comment this out if you want 'make check' to test you doc status +# and run some sanity checks if ENABLE_GTK_DOC -#TESTS_ENVIRONMENT = cd $(srcsrc) && +TESTS_ENVIRONMENT = cd $(srcdir) && \ + DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ + SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) #TESTS = $(GTKDOC_CHECK) endif + +-include $(top_srcdir)/git.mk |