diff options
-rw-r--r-- | doc/doxygen/.gitignore | 2 | ||||
-rw-r--r-- | doc/doxygen/Makefile.am | 18 | ||||
-rw-r--r-- | doc/doxygen/logo.svg | 87 | ||||
-rw-r--r-- | doc/doxygen/taler.doxy | 301 |
4 files changed, 408 insertions, 0 deletions
diff --git a/doc/doxygen/.gitignore b/doc/doxygen/.gitignore new file mode 100644 index 000000000..145a3fd76 --- /dev/null +++ b/doc/doxygen/.gitignore @@ -0,0 +1,2 @@ +html/ +taler-exchange.tag diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am new file mode 100644 index 000000000..cde28de43 --- /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.doxy + doxygen $< + +fast: taler.doxy + sed 's/\(HAVE_DOT.*=\).*/\1 NO/' $< | doxygen - + +clean: + rm -rf html + +EXTRA_DIST = \ + taler.doxy diff --git a/doc/doxygen/logo.svg b/doc/doxygen/logo.svg new file mode 100644 index 000000000..ddb8425d9 --- /dev/null +++ b/doc/doxygen/logo.svg @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + viewBox="0 0 180 40" + version="1.1" + id="svg14" + sodipodi:docname="logo-2018-dold.svg" + inkscape:version="0.92.2 2405546, 2018-03-11"> + <metadata + id="metadata20"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title></dc:title> + </cc:Work> + </rdf:RDF> + </metadata> + <defs + id="defs18" /> + <sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1916" + inkscape:window-height="1041" + id="namedview16" + showgrid="false" + inkscape:zoom="1.8833333" + inkscape:cx="91.061947" + inkscape:cy="20" + inkscape:window-x="0" + inkscape:window-y="18" + inkscape:window-maximized="0" + inkscape:current-layer="text12" /> + <style + id="style2"> + .ts1 { fill: #aa3939; letter-spacing:0; } + .ts2 { letter-spacing:0; } + </style> + <g + aria-label="❬Taler❭" + style="color:#ff0000;font-weight:bold;font-size:36px;font-family:'Lucida Console', Monaco, monospace;letter-spacing:0.2em" + id="text12"> + <path + d="M 15.978516,31.285156 H 12.234375 L 5.6953125,18.154297 12.234375,5.0058594 h 3.744141 L 9.4042969,18.154297 Z" + style="letter-spacing:0;fill:#aa3939" + id="path3725" /> + <path + d="M 35.085937,29 H 29.900391 V 7.2910156 h -6.66211 V 2.7558594 h 18.509766 v 4.5351562 h -6.66211 z" + style="" + id="path3727" /> + <path + d="m 62.817188,19.753906 q -2.882812,0 -4.02539,0.738281 -1.142578,0.738282 -1.142578,2.53125 0,1.335938 0.791015,2.126954 0.791016,0.791015 2.144531,0.791015 2.039063,0 3.164063,-1.529297 1.125,-1.546875 1.125,-4.30664 v -0.351563 z m 7.171875,-1.986328 V 29 h -5.115234 v -2.197266 q -0.931641,1.300782 -2.390625,2.003907 -1.458984,0.703125 -3.216797,0.703125 -3.357422,0 -5.238281,-1.775391 -1.863281,-1.775391 -1.863281,-4.957031 0,-3.445313 2.232421,-5.080078 2.232422,-1.652344 6.908204,-1.652344 h 3.568359 v -0.861328 q 0,-1.248047 -0.914063,-1.88086 -0.896484,-0.65039 -2.654296,-0.65039 -1.845704,0 -3.585938,0.474609 -1.722656,0.457031 -3.603516,1.476563 v -4.394532 q 1.705079,-0.7031246 3.462891,-1.037109 1.757813,-0.3339844 3.726563,-0.3339844 4.798828,0 6.732421,1.9511724 1.951172,1.951171 1.951172,6.978515 z" + style="" + id="path3729" /> + <path + d="M 86.171486,20.791016 V 5.6035156 H 80.950783 V 1.6484375 H 91.321877 V 20.791016 q 0,2.320312 0.720703,3.287109 0.720703,0.966797 2.443359,0.966797 H 98.59922 V 29 h -5.554687 q -3.673828,0 -5.273438,-1.898438 -1.599609,-1.898437 -1.599609,-6.310546 z" + style="" + id="path3731" /> + <path + d="m 127.59609,28.033203 q -1.79297,0.738281 -3.65625,1.107422 -1.86328,0.369141 -3.9375,0.369141 -4.93945,0 -7.55859,-2.636719 -2.60156,-2.654297 -2.60156,-7.628906 0,-4.816407 2.51367,-7.611328 2.51367,-2.7949224 6.85547,-2.7949224 4.37695,0 6.78515,2.6015624 2.42578,2.583985 2.42578,7.294922 v 2.091797 h -13.34179 q 0.0176,2.320312 1.37109,3.46289 1.35352,1.142579 4.04297,1.142579 1.77539,0 3.49805,-0.509766 1.72265,-0.509766 3.60351,-1.617188 z m -4.35937,-11.074219 q -0.0352,-2.039062 -1.05469,-3.076171 -1.00195,-1.054688 -2.9707,-1.054688 -1.77539,0 -2.83008,1.089844 -1.05469,1.072265 -1.24805,3.058593 z" + style="" + id="path3733" /> + <path + d="m 157.31367,14.744141 q -0.84375,-0.773438 -1.98632,-1.160157 -1.125,-0.386718 -2.47852,-0.386718 -1.63476,0 -2.86523,0.580078 -1.21289,0.5625 -1.88086,1.652344 -0.42188,0.667968 -0.59766,1.617187 -0.1582,0.949219 -0.1582,2.882812 V 29 h -5.15039 V 9.3125 h 5.15039 v 3.058594 q 0.75586,-1.6875 2.32031,-2.6015627 1.56445,-0.9316407 3.65625,-0.9316407 1.05469,0 2.05664,0.2636719 1.01953,0.2460938 1.93359,0.7382813 z" + style="letter-spacing:0" + id="path3735" /> + <path + d="m 164.43282,31.285156 6.55664,-13.130859 -6.53907,-13.1484376 h 3.72657 l 6.53906,13.1484376 -6.53906,13.130859 z" + style="letter-spacing:0;fill:#aa3939" + id="path3737" /> + </g> +</svg> diff --git a/doc/doxygen/taler.doxy b/doc/doxygen/taler.doxy new file mode 100644 index 000000000..046e3b277 --- /dev/null +++ b/doc/doxygen/taler.doxy @@ -0,0 +1,301 @@ +# Doxyfile 1.5.6 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = GNU Taler +PROJECT_NUMBER = 0.6.0 +PROJECT_LOGO = logo.svg +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 \ + include +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = YES +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +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 +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +TYPEDEF_HIDES_STRUCT = NO +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = YES +EXTRACT_ANON_NSPACES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = YES +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = NO +SORT_BRIEF_DOCS = NO +SORT_GROUP_NAMES = YES +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../../src ../../contrib ../../doc +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.vhd \ + *.vhdl \ + *.C \ + *.CC \ + *.C++ \ + *.II \ + *.I++ \ + *.H \ + *.HH \ + *.H++ \ + *.CS \ + *.PHP \ + *.PHP3 \ + *.M \ + *.MM \ + *.PY \ + *.F90 \ + *.F \ + *.VHD \ + *.VHDL +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = */test_* */.svn/* */.git/* */perf_* .* +EXCLUDE_SYMBOLS = +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 = YES +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 3 +IGNORE_PREFIX = TALER_ +#--------------------------------------------------------------------------- +# 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 = "GNU Taler Source Documentation" +DOCSET_BUNDLE_ID = net.taler +HTML_DYNAMIC_SECTIONS = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NONE +TREEVIEW_WIDTH = 250 +FORMULA_FONTSIZE = 10 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = YES +PAPER_TYPE = a4 +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 = YES +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = GNUNET_UNUSED="" GNUNET_PACKED="" +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = ../../contrib/gnunet.tag ../../contrib/microhttpd.tag +GENERATE_TAGFILE = taler-exchange.tag +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 = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = YES +CALLER_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = svg +INTERACTIVE_SVG = NO +DOT_PATH = +DOTFILE_DIRS = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 10 +DOT_TRANSPARENT = YES +DOT_MULTI_TARGETS = YES +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = YES |