cleaning up use of doxygen, fixing #5057

This commit is contained in:
Christian Grothoff 2017-06-04 10:22:11 +02:00
parent 9f7e3bb2bd
commit c7c7ac60cf
No known key found for this signature in database
GPG Key ID: 939E6BE1E29FC3CC
5 changed files with 68 additions and 43 deletions

View File

@ -5,8 +5,8 @@
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8 DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "GNU Taler: Exchange" PROJECT_NAME = "GNU Taler: Exchange"
PROJECT_NUMBER = 0.0 PROJECT_NUMBER = 0.3
OUTPUT_DIRECTORY = . OUTPUT_DIRECTORY = doxygen-doc/
CREATE_SUBDIRS = YES CREATE_SUBDIRS = YES
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES BRIEF_MEMBER_DESC = YES
@ -25,9 +25,8 @@ ABBREVIATE_BRIEF = "The $name class" \
ALWAYS_DETAILED_SEC = NO ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES FULL_PATH_NAMES = YES
STRIP_FROM_PATH = ../.. STRIP_FROM_PATH = .
STRIP_FROM_INC_PATH = ../../src/include \ STRIP_FROM_INC_PATH = src/include
src/include
SHORT_NAMES = NO SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO QT_AUTOBRIEF = NO
@ -79,24 +78,24 @@ FILE_VERSION_FILTER =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to warning and progress messages # configuration options related to warning and progress messages
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
QUIET = NO QUIET = YES
WARNINGS = YES WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text" WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = WARN_LOGFILE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the input files # configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = ../.. INPUT = src/
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \ FILE_PATTERNS = *.c \
*.h *.h
RECURSIVE = YES RECURSIVE = YES
EXCLUDE = EXCLUDE =
EXCLUDE_SYMLINKS = NO EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = */test_* */.svn/* */perf_* */tls_test_* */examples/* taler_config.h EXCLUDE_PATTERNS = */test_* */.git/* */perf_* */tls_test_* taler_config.h
EXCLUDE_SYMBOLS = GNUNET_* JSON_* EXCLUDE_SYMBOLS = GNUNET_* JSON_*
EXAMPLE_PATH = EXAMPLE_PATH =
EXAMPLE_PATTERNS = * EXAMPLE_PATTERNS = *
@ -121,11 +120,11 @@ VERBATIM_HEADERS = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5 COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX = IGNORE_PREFIX = TALER_
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the HTML output # configuration options related to the HTML output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
GENERATE_HTML = YES #GENERATE_HTML = YES
HTML_OUTPUT = html HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html HTML_FILE_EXTENSION = .html
HTML_HEADER = HTML_HEADER =
@ -148,11 +147,11 @@ TREEVIEW_WIDTH = 250
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the LaTeX output # configuration options related to the LaTeX output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
GENERATE_LATEX = NO #GENERATE_LATEX = YES
LATEX_OUTPUT = latex LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO COMPACT_LATEX = YES
PAPER_TYPE = a4wide PAPER_TYPE = a4wide
EXTRA_PACKAGES = EXTRA_PACKAGES =
LATEX_HEADER = LATEX_HEADER =
@ -163,9 +162,9 @@ LATEX_HIDE_INDICES = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the RTF output # configuration options related to the RTF output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
GENERATE_RTF = NO #GENERATE_RTF = NO
RTF_OUTPUT = rtf RTF_OUTPUT = rtf
COMPACT_RTF = NO COMPACT_RTF = YES
RTF_HYPERLINKS = NO RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE = RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE = RTF_EXTENSIONS_FILE =
@ -179,7 +178,7 @@ MAN_LINKS = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the XML output # configuration options related to the XML output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
GENERATE_XML = NO #GENERATE_XML = NO
XML_OUTPUT = xml XML_OUTPUT = xml
XML_PROGRAMLISTING = YES XML_PROGRAMLISTING = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
@ -209,14 +208,14 @@ SKIP_FUNCTION_MACROS = YES
# Configuration::additions related to external references # Configuration::additions related to external references
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
TAGFILES = TAGFILES =
GENERATE_TAGFILE = GENERATE_TAGFILE = contrib/taler-exchange.tag
ALLEXTERNALS = NO ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl PERL_PATH = /usr/bin/perl
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the dot tool # Configuration options related to the dot tool
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES CLASS_DIAGRAMS = NO
MSCGEN_PATH = MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES HAVE_DOT = YES

View File

@ -1,10 +1,19 @@
# This Makefile.am is in the public domain # This Makefile.am is in the public domain
AM_CPPFLAGS = -I$(top_srcdir)/src/include AM_CPPFLAGS = -I$(top_srcdir)/src/include
SUBDIRS = src doc
if DOC_ONLY
SUBDIRS = . doc
else
SUBDIRS = . src doc
endif
@DX_RULES@
ACLOCAL_AMFLAGS = -I m4 ACLOCAL_AMFLAGS = -I m4
EXTRA_DIST = \ EXTRA_DIST = \
AUTHORS \ AUTHORS \
contrib/coverage.sh contrib/coverage.sh \
Doxyfile
app: app:
mkdir -p $(PACKAGE)-$(VERSION)-app mkdir -p $(PACKAGE)-$(VERSION)-app

View File

@ -30,10 +30,30 @@ AC_CONFIG_MACRO_DIR([m4])
LT_INIT LT_INIT
DX_INIT_DOXYGEN([taler-exchange],,,
DX_PS_FEATURE(OFF),
DX_PDF_FEATURE(OFF),
DX_RTF_FEATURE(OFF),
DX_CHI_FEATURE(OFF),
DX_XML_FEATURE(OFF))
AC_MSG_CHECKING([whether to compile documentation ONLY])
AC_ARG_ENABLE([only-doc],
[AS_HELP_STRING([--enable-only-doc], [only compile Taler documentation])],
[doc_only=${enableval}],
[doc_only=no])
AC_MSG_RESULT($doc_only)
AM_CONDITIONAL([DOC_ONLY], [test "$doc_only" = "yes"])
if test "$doc_only" != yes
then
# Checks for programs. # Checks for programs.
AC_PROG_CC AC_PROG_CC
AC_PROG_CC_C99 AC_PROG_CC_C99
CFLAGS="-Wall $CFLAGS" CFLAGS="-Wall $CFLAGS"
# Checks for header files. # Checks for header files.
@ -42,7 +62,7 @@ AC_CHECK_HEADERS([stdint.h stdlib.h string.h unistd.h])
# should the build process be restricted to the code required # should the build process be restricted to the code required
# for GNU Taler wallets? # for GNU Taler wallets?
AC_MSG_CHECKING(whether to compile GNU Taler Wallet library ONLY) AC_MSG_CHECKING([whether to compile GNU Taler Wallet library ONLY])
AC_ARG_ENABLE([wallet], AC_ARG_ENABLE([wallet],
[AS_HELP_STRING([--enable-wallet], [only compile for Taler wallet])], [AS_HELP_STRING([--enable-wallet], [only compile for Taler wallet])],
[wallet_only=${enableval}], [wallet_only=${enableval}],
@ -276,6 +296,7 @@ LDFLAGS=$LDFLAGS_SAVE
LIBS=$LIBS_SAVE LIBS=$LIBS_SAVE
# end of wallet/no-wallet specific logic
fi fi
TALER_LIB_LDFLAGS="-export-dynamic -no-undefined" TALER_LIB_LDFLAGS="-export-dynamic -no-undefined"
@ -296,10 +317,10 @@ AM_CONDITIONAL(HAVE_POSTGRESQL, test x$postgres = xtrue)
LIBGNURL_CHECK_CONFIG(,7.34.0,gnurl=1,gnurl=0) LIBGNURL_CHECK_CONFIG(,7.34.0,gnurl=1,gnurl=0)
if test "$gnurl" = 1 if test "$gnurl" = 1
then then
AM_CONDITIONAL(HAVE_LIBGNURL, true) AM_CONDITIONAL(HAVE_LIBGNURL, [true])
AC_DEFINE([HAVE_LIBGNURL],[1],[Have libgnurl]) AC_DEFINE([HAVE_LIBGNURL],[1],[Have libgnurl])
else else
AM_CONDITIONAL(HAVE_LIBGNURL, false) AM_CONDITIONAL(HAVE_LIBGNURL, [false])
fi fi
# libcurl-gnutls # libcurl-gnutls
@ -447,9 +468,23 @@ AC_TYPE_UINTMAX_T
# Checks for library functions. # Checks for library functions.
AC_CHECK_FUNCS([strdup]) AC_CHECK_FUNCS([strdup])
else
# logic if doc_only is set, make sure conditionals are still defined
AM_CONDITIONAL([HAVE_EXPENSIVE_TESTS], [false])
AM_CONDITIONAL([WALLET_ONLY], [false])
AM_CONDITIONAL([HAVE_POSTGRESQL], [false])
AM_CONDITIONAL([HAVE_LIBCURL], [false])
AM_CONDITIONAL([HAVE_LIBGNURL], [false])
AM_CONDITIONAL([HAVE_DEVELOPER], [false])
AM_CONDITIONAL([USE_COVERAGE], [false])
# end of 'doc_only'
fi
AC_CONFIG_FILES([Makefile AC_CONFIG_FILES([Makefile
doc/Makefile doc/Makefile
doc/doxygen/Makefile
src/Makefile src/Makefile
src/auditor/Makefile src/auditor/Makefile
src/auditordb/Makefile src/auditordb/Makefile

View File

@ -1,6 +1,6 @@
# This Makefile.am is in the public domain # This Makefile.am is in the public domain
SUBDIRS = . doxygen SUBDIRS = .
man_MANS = \ man_MANS = \
taler-auditor.1 \ taler-auditor.1 \

View File

@ -1,18 +0,0 @@
# This Makefile.am is in the public domain
all:
@echo -e \
"Generate documentation:\n" \
"\tmake full - full documentation with dependency graphs (slow)\n" \
"\tmake fast - fast mode without dependency graphs"
full: taler-exchange.doxy
doxygen $<
fast: taler-exchange.doxy
sed 's/\(HAVE_DOT.*=\).*/\1 NO/' $< | doxygen -
clean:
rm -rf html
EXTRA_DIST = taler-exchange.doxy