diff options
| author | Christian Grothoff <christian@grothoff.org> | 2015-03-28 15:42:07 +0100 | 
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2015-03-28 15:42:07 +0100 | 
| commit | eca4f1a8fe52d463b6b87d19c245e7aa02197476 (patch) | |
| tree | 2340cf88788df283b8b4b9be99984939d9943805 /doc | |
| parent | c2fd4896a69a2404fc8b468da2cb6161db97bb3d (diff) | |
-doxygen fixes
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/doxygen/Makefile.am | 18 | ||||
| -rw-r--r-- | doc/doxygen/taler-mint.doxy | 246 | 
3 files changed, 266 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 19df3674..c93c251d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,6 @@  # This Makefile.am is in the public domain +SUBDIRS = . doxygen +  EXTRA_DIST = \    coding-style.txt diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am new file mode 100644 index 00000000..6b6f1ed7 --- /dev/null +++ b/doc/doxygen/Makefile.am @@ -0,0 +1,18 @@ +# 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-mint.doxy +	doxygen $< + +fast: taler-mint.doxy +	sed 's/\(HAVE_DOT.*=\).*/\1 NO/' $< | doxygen - + +clean: +	rm -rf html + + +EXTRA_DIST = taler-mint.doxy diff --git a/doc/doxygen/taler-mint.doxy b/doc/doxygen/taler-mint.doxy new file mode 100644 index 00000000..d4bd0ef9 --- /dev/null +++ b/doc/doxygen/taler-mint.doxy @@ -0,0 +1,246 @@ +# Doxyfile 1.5.5 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING      = UTF-8 +PROJECT_NAME           = "GNU Taler: Mint" +PROJECT_NUMBER         = 0.0 +OUTPUT_DIRECTORY       = . +CREATE_SUBDIRS         = YES +OUTPUT_LANGUAGE        = English +BRIEF_MEMBER_DESC      = YES +REPEAT_BRIEF           = YES +ABBREVIATE_BRIEF       = "The $name class" \ +                         "The $name widget" \ +                         "The $name file" \ +                         is \ +                         provides \ +                         specifies \ +                         contains \ +                         represents \ +                         a \ +                         an \ +                         the +ALWAYS_DETAILED_SEC    = NO +INLINE_INHERITED_MEMB  = NO +FULL_PATH_NAMES        = YES +STRIP_FROM_PATH        = ../.. +STRIP_FROM_INC_PATH    = ../../src/include \ +		         src/include +SHORT_NAMES            = NO +JAVADOC_AUTOBRIEF      = NO +QT_AUTOBRIEF           = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS           = NO +SEPARATE_MEMBER_PAGES  = NO +TAB_SIZE               = 8 +ALIASES                = +OPTIMIZE_OUTPUT_FOR_C  = YES +OPTIMIZE_OUTPUT_JAVA   = NO +OPTIMIZE_FOR_FORTRAN   = NO +OPTIMIZE_OUTPUT_VHDL   = NO +BUILTIN_STL_SUPPORT    = NO +CPP_CLI_SUPPORT        = NO +SIP_SUPPORT            = NO +DISTRIBUTE_GROUP_DOC   = NO +SUBGROUPING            = YES +TYPEDEF_HIDES_STRUCT   = NO +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL            = YES +EXTRACT_PRIVATE        = NO +EXTRACT_STATIC         = YES +EXTRACT_LOCAL_CLASSES  = NO +EXTRACT_LOCAL_METHODS  = YES +EXTRACT_ANON_NSPACES   = NO +HIDE_UNDOC_MEMBERS     = NO +HIDE_UNDOC_CLASSES     = NO +HIDE_FRIEND_COMPOUNDS  = NO +HIDE_IN_BODY_DOCS      = NO +INTERNAL_DOCS          = NO +CASE_SENSE_NAMES       = YES +HIDE_SCOPE_NAMES       = NO +SHOW_INCLUDE_FILES     = YES +INLINE_INFO            = YES +SORT_MEMBER_DOCS       = YES +SORT_BRIEF_DOCS        = NO +SORT_GROUP_NAMES       = NO +SORT_BY_SCOPE_NAME     = NO +GENERATE_TODOLIST      = NO +GENERATE_TESTLIST      = NO +GENERATE_BUGLIST       = NO +GENERATE_DEPRECATEDLIST= NO +ENABLED_SECTIONS       = +MAX_INITIALIZER_LINES  = 30 +SHOW_USED_FILES        = YES +FILE_VERSION_FILTER    = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET                  = NO +WARNINGS               = YES +WARN_IF_UNDOCUMENTED   = YES +WARN_IF_DOC_ERROR      = YES +WARN_NO_PARAMDOC       = NO +WARN_FORMAT            = "$file:$line: $text" +WARN_LOGFILE           = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT                  = ../.. +INPUT_ENCODING         = UTF-8 +FILE_PATTERNS          = *.c \ +                         *.h +RECURSIVE              = YES +EXCLUDE                = +EXCLUDE_SYMLINKS       = NO +EXCLUDE_PATTERNS       = */test_* */.svn/* */perf_* */tls_test_*  */examples/* TALER_config.h +EXCLUDE_SYMBOLS        = GNUNET_* JSON_* +EXAMPLE_PATH           = +EXAMPLE_PATTERNS       = * +EXAMPLE_RECURSIVE      = NO +IMAGE_PATH             = +INPUT_FILTER           = +FILTER_PATTERNS        = +FILTER_SOURCE_FILES    = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER         = YES +INLINE_SOURCES         = NO +STRIP_CODE_COMMENTS    = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION    = YES +REFERENCES_LINK_SOURCE = YES +USE_HTAGS              = NO +VERBATIM_HEADERS       = NO +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX     = YES +COLS_IN_ALPHA_INDEX    = 5 +IGNORE_PREFIX          = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML          = YES +HTML_OUTPUT            = html +HTML_FILE_EXTENSION    = .html +HTML_HEADER            = +HTML_FOOTER            = +HTML_STYLESHEET        = +GENERATE_HTMLHELP      = NO +GENERATE_DOCSET        = NO +DOCSET_FEEDNAME        = "Doxygen generated docs" +DOCSET_BUNDLE_ID       = org.doxygen.Project +HTML_DYNAMIC_SECTIONS  = NO +CHM_FILE               = +HHC_LOCATION           = +GENERATE_CHI           = NO +BINARY_TOC             = NO +TOC_EXPAND             = NO +DISABLE_INDEX          = NO +ENUM_VALUES_PER_LINE   = 4 +GENERATE_TREEVIEW      = YES +TREEVIEW_WIDTH         = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX         = NO +LATEX_OUTPUT           = latex +LATEX_CMD_NAME         = latex +MAKEINDEX_CMD_NAME     = makeindex +COMPACT_LATEX          = NO +PAPER_TYPE             = a4wide +EXTRA_PACKAGES         = +LATEX_HEADER           = +PDF_HYPERLINKS         = YES +USE_PDFLATEX           = YES +LATEX_BATCHMODE        = NO +LATEX_HIDE_INDICES     = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF           = NO +RTF_OUTPUT             = rtf +COMPACT_RTF            = NO +RTF_HYPERLINKS         = NO +RTF_STYLESHEET_FILE    = +RTF_EXTENSIONS_FILE    = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN           = NO +MAN_OUTPUT             = man +MAN_EXTENSION          = .3 +MAN_LINKS              = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML           = NO +XML_OUTPUT             = xml +XML_PROGRAMLISTING     = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF   = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD       = NO +PERLMOD_LATEX          = NO +PERLMOD_PRETTY         = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING   = YES +MACRO_EXPANSION        = NO +EXPAND_ONLY_PREDEF     = NO +SEARCH_INCLUDES        = YES +INCLUDE_PATH           = +INCLUDE_FILE_PATTERNS  = +PREDEFINED             = +EXPAND_AS_DEFINED      = +SKIP_FUNCTION_MACROS   = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES               = +GENERATE_TAGFILE       = +ALLEXTERNALS           = NO +EXTERNAL_GROUPS        = YES +PERL_PATH              = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS         = YES +MSCGEN_PATH            = +HIDE_UNDOC_RELATIONS   = YES +HAVE_DOT               = YES +CLASS_GRAPH            = NO +COLLABORATION_GRAPH    = NO +GROUP_GRAPHS           = NO +UML_LOOK               = NO +TEMPLATE_RELATIONS     = NO +INCLUDE_GRAPH          = YES +INCLUDED_BY_GRAPH      = YES +CALL_GRAPH             = YES +CALLER_GRAPH           = YES +GRAPHICAL_HIERARCHY    = NO +DIRECTORY_GRAPH        = YES +DOT_IMAGE_FORMAT       = png +DOT_PATH               = +DOTFILE_DIRS           = +DOT_GRAPH_MAX_NODES    = 25 +MAX_DOT_GRAPH_DEPTH    = 2 +DOT_TRANSPARENT        = YES +DOT_MULTI_TARGETS      = NO +GENERATE_LEGEND        = YES +DOT_CLEANUP            = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE           = YES  | 
