Mercurial > trustbridge
changeset 1254:6d840341bc25
(issue113) Add mainpage and improve doxyfile
author | Andre Heinecke <andre.heinecke@intevation.de> |
---|---|
date | Thu, 25 Sep 2014 17:37:03 +0200 |
parents | eb4d7337edd7 |
children | 2a1aa9df8f11 |
files | doc/apidoc/Doxyfile.in doc/apidoc/mainpage.dox |
diffstat | 2 files changed, 53 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/apidoc/Doxyfile.in Thu Sep 25 17:36:33 2014 +0200 +++ b/doc/apidoc/Doxyfile.in Thu Sep 25 17:37:03 2014 +0200 @@ -193,7 +193,7 @@ # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = TODO=\todo" +ALIASES = "TODO=\todo" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding @@ -319,21 +319,6 @@ TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. - -SYMBOL_CACHE_SIZE = 0 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given @@ -655,7 +640,7 @@ # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @CMAKE_SOURCE_DIR@/ui @CMAKE_SOURCE_DIR@/common @CMAKE_SOURCE_DIR@/cinst +INPUT = @CMAKE_SOURCE_DIR@/ui @CMAKE_SOURCE_DIR@/common @CMAKE_SOURCE_DIR@/cinst @CMAKE_SOURCE_DIR@/doc/apidoc/mainpage.dox @CMAKE_SOURCE_DIR@/INSTALL # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -679,7 +664,7 @@ # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. -RECURSIVE = NO +RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/apidoc/mainpage.dox Thu Sep 25 17:37:03 2014 +0200 @@ -0,0 +1,50 @@ +/** +\mainpage TrustBridge + +\section Copyright + +Copyright (C) 2014 by Bundesamt für Sicherheit in der Informationstechnik +Software engineering by Intevation GmbH + +This file is Free Software under the GNU GPL (v>=2) +and comes with ABSOLUTELY NO WARRANTY! +See licenses/README.txt for more information. + +\section Introduction + +TrustBridge is a is a root certificate installer for Windows and Linux, +contracted by the German Federal Office for Information Security (BSI). +It should be able to be installed with or without root access rights. + +The orignal target platforms are Windows NT > 6.0 (Vista and later) and +Ubuntu GNU/Linux 14.4 both 32 and 64 bit. + +Certificates are installed under Windows in the Windows System store and +using the Mozilla NSS library into the certificate databases used by +firefox and thunderbird. + +Under GNU/Linux the NSS-Shared DB, used for example by Chrome(ium) is +accessed additionally to the Thunderbird and Firefox stores. + +\section Installation + +See the file \ref INSTALL for build instructions for Linux and Windows. + +\section Documentation +For API (what you are reading now) documentation build the target "doc" +(requires doxygen). + +The (German) user help documentation is available in the TrustBridge +client/admin application. The source files are placed in "doc/help". + +\section Contact +For additional information or custom modifications please contact: + + Intevation GmbH <intevation@intevation.de> + Neuer Graben 17 + 49074 Osnabrück, Germany + +The public development platform can be found at: +https://wald.intevation.org/projects/trustbridge/ + +*/