diff --git a/ChangeLog b/ChangeLog index 76152bb..da6a76a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ += Version 0.3 = + + - Added support for SNMP tables (this significantly changed the API). + - Removed boost dependencies. + - Improved the build system. + - Added a logo, update doxygen documentation design. + - Added a release process (consisting of a script and according + documentation). + = Version 0.2 = - Implemented GetNext handling. diff --git a/LICENSE b/LICENSE index d8a8a60..6f46ff4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ AgentXcpp library LICENSE Version 1, 17 February 2011 - Copyright 2011-2012 Tanjeff-Nicolai Moos + Copyright 2011-2016 Tanjeff-Nicolai Moos AgentXcpp is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software diff --git a/README b/README deleted file mode 100644 index 047503a..0000000 --- a/README +++ /dev/null @@ -1,180 +0,0 @@ -About this README ------------------ - -This README gives a short overview of the agentXcpp project, introduces the -repository's directory structure and describes how to build the documentation. -Further information can then be found in the documentation. - - -About agentXcpp ---------------- - -AgentXcpp is a C++ implementation of the AgentX protocol (RFC 2741). - -You may visit the project's website: - - www.agentxcpp.org - -The AgentX protocol is used to implement SNMP MIBs as subagents, which are -separate processes connecting to a master agent, which in turn provides a SNMP -interface to the outside world. - - -Status of the project ---------------------- - -This version is PARTLY USABLE. - -This version supports writing subagents. Support for SNMP GET and SET requests -is available, and notifications are supported, too. However, conceptual tables -are impossible to implement. - -Read the ChangeLog file to learn more. - - -Roadmap -------- - -This is the roadmap for the next versions: - - Version 0.3 - Tables are working. This will be the first version which can be used in - real projects. - - Version 0.3.x - I plan to provide multiple 0.3.x versions which don't add new features - regarding the AgentX protocol. These updates are mainly intended to improve - the API, based on the experiences in real projects, and to clean up and - possibly redesign the internal structure of agentXcpp. I plan to release - small changes quickly in this phase. - - Version 0.4 - Unit tests will be available for most classes contained in agentXcpp. This - means that the quality will improve. API changes and additional features - might also get implemented. - -License -------- - -Copyright 2011-2012 Tanjeff-Nicolai Moos - -This file is part of the agentXcpp library. - -AgentXcpp is free software: you can redistribute it and/or modify -it under the terms of the AgentXcpp library license, version 1, which -consists of the GNU General Public License and some additional -permissions. - -AgentXcpp is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -See the AgentXcpp library license in the LICENSE file of this package -for more details. - -IMPORTANT: The software contained in the site_scons directory is distributed -under its own licence. See the files there for details. - - -Directory Structure -------------------- - -The top level directory contains the following elements: - -AUTHORS - Contains the author(s) of the agentXcpp library. - -LICENSE - Contains the AgentXcpp library LICENSE, which basically consists of the - GPL and an additional linking exception. - -GPLv3 - Contains the GNU GENERAL PUBLIC LICENSE, Version 3. - -README - This file. - -SConstruct - AgentXcpp is built using SCons. This file provides the possibility to - build the library and the documentation. - -site_scons/ - This directory contains SCons supplements. At the moment, the only - supplement is the QT4 builder. The software contained in this directory - is published under another license than agentXcpp, as it is not part of - the agentXcpp software. Distribution is done for convenience. - -doc/ - This directory contains the documentation. The documentation is created - using Doxygen and most of the content is contained in the source code. - The doc/ directory contains the doxygen configs, some additional - documentation files (*.dox) and the RFC 2741. - -src/ - This directory contains the source code of the library. - - -unit_tests/ - This directory contains the unit tests for the agentXcpp components. - Note that this is currently rather a skeleton, and no tests are - available yet. - - -Prerequisites -------------- - -To build agentXcpp, the following is needed: - -- Standard build environment (compiler, linker, etc.) -- Doxygen, to build the documentation -- The 'dot' tool from the graphviz package, which is used by doxygen to - generate diagrams -- SCons, to control the build process -- The QT4 library -- The following boost libraries: - - Bind - - Smart Ptr - - Test - - Integer - - -Documentation -------------- - -There are two types of HTML documentation, the API documentation and the -'internals' documentation. The API documentation describes the AgentXcpp API -and is intended for the user of the library. The internals documentation is the -complete reference of the library, describing all internals, including things -such as the build system. - -You can build the documentation using SCons or without SCons. - -1a) With SCons: - cd to the top level directory (the one containing this README) and type - - scons - - This builds the library as well as both documentations. - -1b) Without SCons: - cd into the doc/ directory and type - - doxygen api.doxyfile - - respectively - - doxygen internals.doxyfile - -2) After building, the documentation can be displayed by pointing a web - browser to - - doc/api/html/index.html - - respectively - - doc/internals/html/index.html. - - - -Happy hacking :-) diff --git a/README.md b/README.md new file mode 100644 index 0000000..2bc6bc0 --- /dev/null +++ b/README.md @@ -0,0 +1,178 @@ +![agentXcpp Logo](artwork/github_logo.png) + + +About agentXcpp +=============== + +What is agentXcpp ? +------------------- + +AgentXcpp is a C++ implementation of the AgentX protocol (RFC 2741). The AgentX +protocol is used to implement SNMP MIBs as subagents, which are separate +processes connecting to a master agent. The master agent in turn provides an +SNMP interface to the outside world. + +You may visit the project's website: [agentxcpp.org](http://agentxcpp.org) + + +Status of the project +--------------------- + +All basic functions are implemented. + +Somewhat advanced features, e.g. GetBulk requests, contexts (used by SNMPv3) +and agent capabilities, are not implemented. Also, TCP is not supported for +agentX connections (only unix domain sockets are), so the library will not work +on windows. Further, index allocating (needed to combine variables from +multiple subagents into a single table) is not available. Currently, the +library is also missing logging capabilities. + + +License +------- + +Copyright 2011-2016 Tanjeff-Nicolai Moos + +This file is part of the agentXcpp library. + +AgentXcpp is free software: you can redistribute it and/or modify +it under the terms of the AgentXcpp library license, version 1, which +consists of the GNU General Public License and some additional +permissions. + +AgentXcpp is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +See the AgentXcpp library license in the LICENSE file of this package +for more details. + +**IMPORTANT:** The software contained in the `site_scons` directory is +distributed under its own license. See the files there for details. + + +The Documentation +================= + + +There are two types of documentation: The +"[API documentation](http://tanjeff.github.io/agentXcpp/docs/0.3/api/html/index.html)" +and the +"[internals documentation](http://tanjeff.github.io/agentXcpp/docs/0.3/internals/html/index.html)". + +The API documentation describes the AgentXcpp API and is intended for the user +of the library. It contains not only the complete API reference, but also a +tutorial to get started. + +The internals documentation explains all internals of the library, including +descriptions of the used concepts, how the build system is configured and how +releases should be created. Of course, it contains also the reference of the +whole code. + +This section describes how to build the documentation from the source. + + +Building the Documentation +-------------------------- + +### Prerequisites + +To build agentXcpp, the following is needed: + +- Standard build environment (compiler, linker, etc.) +- The QT4 library (devel package, e.g. libqt4-dev on linux systems) +- Doxygen, to build the documentation +- The `dot` tool from the graphviz package, which is used by doxygen to + generate diagrams +- SCons, to control the build process +You can build the documentation using SCons or without SCons. + +### Build Commands + + 1. With SCons: + cd into the `doc/` directory and type + + scons + + This builds both documentations (API and internal). + + 1. Without SCons: + cd into the `doc/` directory and type + + doxygen api.doxyfile + + respectively + + doxygen internals.doxyfile + +After building, the documentation can be displayed by pointing a web browser to +`doc/api/html/index.html` respectively `doc/internals/html/index.html`. + + + +Directory Structure of this Repository +====================================== + + +This top level directory contains the following elements: + + * __artwork/__ + + Here is the agentXcpp logo, and possibly other artwork. + + * __AUTHORS__ + + Contains the author(s) of the agentXcpp library. + + * __ChangeLog__ + + The Changelog. + + * __create-release.py__ + + A script to create an agentXcpp release. + + * __doc/__ + + This directory contains the documentation. The documentation is created + using Doxygen and most of the content is contained in the source code. The + doc/ directory contains the doxygen configs, some additional documentation + files (*.dox) and the RFC 2741. + + * __getversion.py__ + + A script to reliably obtain the version of this agentXcpp copy. + + * __LICENSE__ + + Contains the AgentXcpp library LICENSE, which consists of the GPL and an + additional linking exception. + + * __GPLv3__ + + The GNU GENERAL PUBLIC LICENSE, Version 3. + + * __README__ + + This file. + + * __SConstruct__ + + AgentXcpp is built using SCons. This file defines how to build the library + and the documentation. + + * __site\_scons/__ + + This directory contains SCons supplements. The software contained in this + directory is published under another license than agentXcpp, as it is not + part of the agentXcpp software. Distribution is done for convenience. + + + * __src/__ + + This directory contains the source code of the library. + + + + diff --git a/SConstruct b/SConstruct index 0bf02d4..048e512 100644 --- a/SConstruct +++ b/SConstruct @@ -1,5 +1,5 @@ # -# Copyright 2011-2012 Tanjeff-Nicolai Moos +# Copyright 2011-2016 Tanjeff-Nicolai Moos # # This file is part of the agentXcpp library. # @@ -20,6 +20,7 @@ import subprocess import sys import os +import getversion ################################################# @@ -59,6 +60,7 @@ env.Tool('qt4') env.EnableQt4Modules(['QtCore', 'QtNetwork']) +env.Tool('doxygen') @@ -110,19 +112,22 @@ env['includedir'] = GetOption('includedir') if env['includedir'][0] != '/' and env['includedir'][0] != '#': env['includedir'] = GetLaunchDir() + "/" + env['includedir'] -# --with_libs magic -AddOption('--with_libs', nargs=1, action='store', dest='with_libs', +# --with-packages magic +# Note: the commandline parameter is --with-packages (with a dash), but the +# local variable is with_packages (with underscore) due to python naming +# requirements. +AddOption('--with-packages', nargs=1, action='store', dest='with-packages', type='string', help='Colon-separated list of directories. For each ' + 'directory $DIR the $DIR/include is added to the ' + 'compilers header search path and $DIR/lib is added ' + 'to the library search path.', default=None) -with_libs = GetOption('with_libs') -if with_libs != None: - # only if --with-libs was provided: - with_libs = with_libs.split(':') - for dir in with_libs: +with_packages = GetOption('with-packages') +if with_packages != None: + # only if --with-packages was provided: + with_packages = with_packages.split(':') + for dir in with_packages: # For each DIR: # - Make relative path absolute # - Fail if DIR/include or DIR/lib is not a directory @@ -146,77 +151,40 @@ if with_libs != None: ################################################# ## Obtain description of current version -# Get current revision -# We ask git for a description of the current revision and add it to the -# environment. If an error occurs (e.g. git is not installed ot we are outside -# of a git repo) no revision can be determined. -# -# Note: subprocess.check_output() would be more appropriate, but doesn't -# exist in Python 2.4 :-( -try: - proc = subprocess.Popen(["git", "describe", "--always", "--dirty"], - stdout=subprocess.PIPE) - (out,err) = proc.communicate() - if proc.returncode == 0: - # only if call succeeded: - env['revision'] = out.strip() -except: - # git describe failed - probably git is not installed. - pass +# Add current revision to the environment +env['revision'] = getversion.getVersion() ################################################# -## Check dependencies - -conf = Configure(env, custom_tests={'CheckExe' : CheckExe}) - -# Check for C++ compiler -if env['CXX'] == None: - print """ -Scons didn't find a usable C++ compiler. -Note: For Linux, install a package named 'build-essential' or 'g++'.""" - Exit(1) - -# Check for boost::bind (header-only lib) -if not conf.CheckHeader('boost/bind.hpp', '<>', 'C++'): - print """ -The boost::bind library is required to build agentXcpp. -Note: For Linux, install a package named 'libboost-dev' or 'boost'.""" - Exit(1) - -# Check for boost::smart_ptr (header-only lib) -if not conf.CheckHeader('boost/shared_ptr.hpp', '<>', 'C++'): - print """ -The boost::smart_ptr library is required to build agentXcpp. -Note: For Linux, install a package named 'libboost-dev' or 'boost'.""" - Exit(1) - -# Check for boost::test -if not conf.CheckLibWithHeader('boost_unit_test_framework', - 'boost/test/unit_test.hpp', 'C++', autoadd=0): - print """ -The boost::test library is required to build agentXcpp. -Note: For Linux, install packages named 'libboost-dev' and 'libboost-test-dev' - or a package named 'boost'.""" - Exit(1) - -# Check for doxygen executable -# Note: we call 'doxygen --version' so no input file is required -if not conf.CheckExe(['doxygen', '--version']): - print """ -The doxygen program is required to build agentXcpp's documentation. -Note: For Linux, install a package named 'doxygen'.""" - Exit(1) - -# Check for dot executable -# Note: we call 'dot -V' so no input file is required -if not conf.CheckExe(['dot', '-V']): - print """ -The dot program is required to build agentXcpp's documentation. -Note: For Linux, install a package named 'graphviz'.""" - Exit(1) - -env = conf.Finish() +## Check dependencies (except when the user wants help) + +if not GetOption('help'): + conf = Configure(env, custom_tests={'CheckExe' : CheckExe}) + + # Check for C++ compiler + if env['CXX'] == None: + print """ + Scons didn't find a usable C++ compiler. + Note: For Linux, install a package named 'build-essential' or 'g++'.""" + Exit(1) + + # Check for doxygen executable + # Note: we call 'doxygen --version' so no input file is required + if not conf.CheckExe(['doxygen', '--version']): + print """ + The doxygen program is required to build agentXcpp's documentation. + Note: For Linux, install a package named 'doxygen'.""" + Exit(1) + + # Check for dot executable + # Note: we call 'dot -V' so no input file is required + if not conf.CheckExe(['dot', '-V']): + print """ + The dot program is required to build agentXcpp's documentation. + Note: For Linux, install a package named 'graphviz'.""" + Exit(1) + + env = conf.Finish() ################################################# @@ -224,6 +192,5 @@ env = conf.Finish() # (export env to them): env.SConscript(['src/SConscript', - 'doc/SConscript', - 'unit_tests/SConscript'], 'env') + 'doc/SConscript'], 'env') diff --git a/artwork/blog_logo.png b/artwork/blog_logo.png new file mode 100644 index 0000000..2e04490 Binary files /dev/null and b/artwork/blog_logo.png differ diff --git a/artwork/doc_logo.png b/artwork/doc_logo.png new file mode 100644 index 0000000..d1cec1e Binary files /dev/null and b/artwork/doc_logo.png differ diff --git a/artwork/github_logo.png b/artwork/github_logo.png new file mode 100644 index 0000000..ca880c2 Binary files /dev/null and b/artwork/github_logo.png differ diff --git a/artwork/logo.svg b/artwork/logo.svg new file mode 100644 index 0000000..80e6e62 --- /dev/null +++ b/artwork/logo.svg @@ -0,0 +1,347 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + AgentXcpp + + diff --git a/artwork/twitter_logo.png b/artwork/twitter_logo.png new file mode 100644 index 0000000..a5e4e0f Binary files /dev/null and b/artwork/twitter_logo.png differ diff --git a/create-release.py b/create-release.py new file mode 100755 index 0000000..58d854a --- /dev/null +++ b/create-release.py @@ -0,0 +1,131 @@ +#!/usr/bin/env python + +# +# Copyright 2011-2016 Tanjeff-Nicolai Moos +# +# This file is part of the agentXcpp library. +# +# AgentXcpp is free software: you can redistribute it and/or modify +# it under the terms of the AgentXcpp library license, version 1, which +# consists of the GNU General Public License and some additional +# permissions. +# +# AgentXcpp is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# See the AgentXcpp library license in the LICENSE file of this package +# for more details. +# + +import subprocess +import gzip +import sys +import shutil +import tarfile +import zipfile +import os +import getversion + +# Note: This script uses subprocess.Popen() in favor of subprocess.check_output(), +# because the latter is not available in Python 2.4. + + +################### +# Some information +version = getversion.getVersion() +scriptDir = os.path.dirname(os.path.realpath(__file__)) +delivDir = os.path.join(scriptDir, "deliv") +versionFileName = os.path.join(scriptDir, 'version') +prefix = 'agentxcpp-' + version + '/' + + +################### +# Check if the repo is clean. +# We consider the repo clean if no tracked files were changed +# and no files are in the git staging area. Ignored and untracked +# files are allowed. +clean = True +try: + proc = subprocess.Popen(["git", "status", "--porcelain"], + stdout=subprocess.PIPE, stderr=subprocess.STDOUT) + (out,err) = proc.communicate() + for line in out.split('\n'): + if line.startswith('??') or line == "": + continue # ignore untracked files + clean = False + if clean == False: + print("Your repository is dirty. Use 'git status'.") +except: + print("Can't determine repository state. Are you in a git repo?") + clean = False +if clean == False: + # No delivery if repo is dirty + sys.exit(-1) + + +################### +# Remove and re-create delivery directory +if os.path.exists(delivDir): + print("Deleting " + os.path.relpath(delivDir) + "/") + shutil.rmtree(delivDir) +os.mkdir(delivDir) + + +################### +# Create version file +with open(versionFileName, 'w') as versionFile: + versionFile.write(version) + versionFile.write('\n') + +################### +# Create tar file +print("Creating tar file...") +tarName = os.path.join(delivDir, 'agentxcpp-' + version + '.tar') +tgzName = os.path.join(delivDir, 'agentxcpp-' + version + '.tgz') +proc = subprocess.Popen(["git", "archive", + "--format=tar", + '--prefix=' + prefix, + version, + '-o', tarName], + stdout=subprocess.PIPE) +(out,err) = proc.communicate() + +# Add version file to tarfile +with tarfile.open(tarName, "a") as tar: + tar.add(versionFileName, prefix + os.path.basename(versionFileName)) + +# Compress tar file, removing the uncompressed file +with open(tarName, 'rb') as f_in, gzip.open(tgzName, 'wb') as f_out: + shutil.copyfileobj(f_in, f_out) +os.remove(tarName) + + +################### +# Create ZIP file +print("Creating zip file...") +zipName = os.path.join(delivDir,'agentxcpp-' + version + '.zip') +proc = subprocess.Popen(["git", "archive", + "--format=zip", + '--prefix=' + prefix, + version, + '-o', zipName], + stdout=subprocess.PIPE) +(out,err) = proc.communicate() + +# Add version file to zipfile +with zipfile.ZipFile(zipName, "a") as f: + f.write(versionFileName, prefix + os.path.basename(versionFileName)) + + +################### +# Coda + +# Remove version file +os.remove(versionFileName) + +print("") +print("Created delivery for version " + version) +print("The files to deliver are now located in " + os.path.relpath(delivDir) + '/\n') + diff --git a/doc/CHAP-MIB.txt b/doc/CHAP-MIB.txt new file mode 100644 index 0000000..0a58714 --- /dev/null +++ b/doc/CHAP-MIB.txt @@ -0,0 +1,791 @@ +CHAP-MIB DEFINITIONS ::= BEGIN + +--####################################################################### +--# CHAP-MIB for Center # +--####################################################################### +--History +-- 2010/01/30 Version 1.0 (CC/AT) +-- 2010/02/17 Version 1.1 (Aufteilung in Plattform- und DC-FEP) +-- 2010/12 Version 1.1.1 (Weitere Objekte hinzugefügt) +-- 2011/05/26 Version 1.2 (Comments improved) +--####################################################################### + +IMPORTS + enterprises FROM RFC1155-SMI + TimeTicks, Counter, Gauge FROM RFC1155-SMI + DisplayString FROM RFC1213-MIB + TRAP-TYPE FROM RFC-1215 + OBJECT-TYPE FROM RFC-1212; + + +--####################################################################### +--# CHAP-MIB basic tree # +--####################################################################### + +dfs OBJECT IDENTIFIER ::= {enterprises 16455} +systemhaus OBJECT IDENTIFIER ::= {dfs 3} +chap OBJECT IDENTIFIER ::= {systemhaus 3} +chapMIB OBJECT IDENTIFIER ::= {chap 1} +chapTrap OBJECT IDENTIFIER ::= {chap 2} + +subsystems OBJECT IDENTIFIER ::= {chapMIB 9} +subsystemProcesses OBJECT IDENTIFIER ::= {chapMIB 10} +externalSystems OBJECT IDENTIFIER ::= {chapMIB 11} +satellites OBJECT IDENTIFIER ::= {chapMIB 12} +versionsAndAdaptations OBJECT IDENTIFIER ::= {chapMIB 13} + +--####################################################################### +--# CHAP-MIB type definitions for CMMC # +--####################################################################### + +CmmcServerStateType ::= + INTEGER { + operational (1), + alert (2), + unknown (3), + standby (4) + } + +CmmcSatelliteStateType ::= + INTEGER { + connected (1), + disconnected (2) + } + + +CmmcLinkStateType ::= + INTEGER { + operational(1), + alert (2), + unknown (3), + standby (4) + } + +CmmcInterfaceStateType ::= + INTEGER { + operational (1), + alert (2), + unknown (3), + other (4) + } + +CmmcControlType ::= + INTEGER { + enabled (1), + disabled (2) + } + +CmmcResultType ::= + INTEGER { + noaction (1), + inprocess (2), + accepted (3), + rejected (4) + } + +CmmcServerCommandType ::= + INTEGER { + start (1), + stop (2), + restart (3), + reboot (4), + switchover (5) + } + +CmmcSatelliteCommandType ::= + INTEGER { + start (1), + stop (2), + restart (3), + reboot (4) + } + +CmmcSystemCommandType ::= + INTEGER { + start (1), + stop (2), + restart (3) + } + + +--####################################################################### +--# Common information of the CHAP-MIB # +--####################################################################### + +-- MIB Active Object +chapMIBActive OBJECT-TYPE + SYNTAX INTEGER { + active (1), + standby (2) + } + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Indicates whether this box will respond to chapMIB SNMP accesses. The + value active(1) is returned if the Chap server running the SNMP agent is + active, otherwise standby(2) is returned. The value standby(2) does not + necessarily mean that the server is STANDBY, it may also be OFFLINE or + FAILED, for example. Further, the SNMP agent will respond always to all + SNMP requests, even when the server is standby(2)." + ::= { chapMIB 1 } + +-- Location Object +chapLocation OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..15)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Location where CHAP is running, e.g. Duesseldorf, Bremen, Munich" + ::= { chapMIB 2 } + +-- MIB Version Object +chapMIBVersion OBJECT-TYPE + SYNTAX DisplayString + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The version of the actual MIB, e.g. + Name: CHAP-MIB + Version: 1.1 + Date: Feb.17, 2010 + Author: CC/AT + Copyright: 2010" + ::= { chapMIB 3 } + +-- +--####################################################################### +--# Control-Command Objects of the CHAP system # +--####################################################################### +-- +--The term "system" means all DC-FEP servers (both DC-FEP servers). This +--part specifies the control commands for the system (in opposite to the +--subsystem server part of this MIB) +-- + +chapSystemCommand OBJECT-TYPE + SYNTAX CmmcSystemCommandType + ACCESS read-write + STATUS mandatory + DESCRIPTION + "The valid commands are + start (1), + stop (2), + restart (3) + Writing to this variable performs the requested command, as specified above. + When read, this variable return the last written value. + If the variable was never written before, the value start(1) is returned." + ::= { chapMIB 4 } + +chapSystemCommandAuthorization OBJECT-TYPE + SYNTAX INTEGER + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Used for bit by bit coding (allow/deny) of possible commands. + The value for allow = 1, the value for deny = 0. + Bit 0: start (1), + Bit 1: stop (2), + Bit 2: restart (3)" + ::= { chapMIB 5 } + +chapSystemCommandResult OBJECT-TYPE + SYNTAX CmmcResultType + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Result of the system switch command + noaction (1), + inprocess (2), + accepted (3), + rejected (4)" + ::= { chapMIB 6 } + +chapSystemCommandRejectReason OBJECT-TYPE + SYNTAX DisplayString (SIZE (0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The reason for rejection" + ::= { chapMIB 7 } + +-- Trap control of the startup command +startupTrapControlStatus OBJECT-TYPE + SYNTAX CmmcControlType + ACCESS read-write + STATUS mandatory + DESCRIPTION + "Startup trap reporting enabled/disabled" + ::= { chapMIB 8 } + +-- +-- >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> +--####################################################################### +--# MIB information of the CHAP server # +--# (subsystem server group) # +--####################################################################### + +-- Subsystem Server State Change Object +subsystemServerStateChangeCounter OBJECT-TYPE + SYNTAX Counter + ACCESS read-only + STATUS mandatory + DESCRIPTION + "This counter is incremented whenever a state change at one of the + subsystems CHAP server happens except when traps are deactivated for the + corresponding type. (This counter counts the actually sent traps)" + ::= { subsystems 1 } + +-- Subsystem Server List Table +subsystemServerList OBJECT-TYPE + SYNTAX SEQUENCE OF SubsystemServerEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "Table of the subsystems CHAP server" + ::= { subsystems 2 } + +subsystemServerEntry OBJECT-TYPE + SYNTAX SubsystemServerEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "A list of the subsystems CHAP server" + INDEX { subsystemServerHostname } + ::= { subsystemServerList 1 } + SubsystemServerEntry ::= SEQUENCE { + subsystemServerHostname DisplayString (SIZE(0..8)), + subsystemServerStatus CmmcServerStateType, + subsystemServerCommandAuthorization Integer, + subsystemServerCommand CmmcServerCommandType, + subsystemServerCommandResult CmmcResultType, + subsystemServerCommandRejectReason DisplayString (SIZE(0..25)), + subsystemServerVersion DisplayString (SIZE(0..25)), + subsystemServerAdaptation DisplayString (SIZE(0..25)) + } + +subsystemServerHostname OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..8)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "When read, this variable returns the hostname of a server in the + subsystemServerList. The hostname is truncated to 8 characters (the actual + hostname may be longer). If both servers have the same truncated name + (e.g. 'chapserver1' and 'chapserver2' would both become 'chapserv'), + one of the names is modified to provide different names. + This modification is performed because the truncated hostnames serve as + index of the subsystemServerList and must be unique." + ::= { subsystemServerEntry 1 } + +subsystemServerStatus OBJECT-TYPE + SYNTAX CmmcServerStateType + ACCESS read-only + STATUS mandatory + DESCRIPTION "valid state for servers" + ::= { subsystemServerEntry 2 } + +subsystemServerCommandAuthorization OBJECT-TYPE + SYNTAX INTEGER + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Descibes which commands are currently possible. + A bit by bit coding is used as follows: + Bit 0: start (1), + Bit 1: stop (2), + Bit 2: restart (3), + Bit 3: reboot (4), + Bit 4: switchover (5) + where the value for 'possible' is 1 and + the value for 'not possible' is 0." + ::= { subsystemServerEntry 3 } + +subsystemServerCommand OBJECT-TYPE + SYNTAX CmmcServerCommandType + ACCESS read-write + STATUS mandatory + DESCRIPTION + "Writing to this variable performs the requested command. When read, + this variable return the last written value. If the variable was never + written before, the value start(1) is returned." + ::= { subsystemServerEntry 4 } + +subsystemServerCommandResult OBJECT-TYPE + SYNTAX CmmcResultType + ACCESS read-only + STATUS mandatory + DESCRIPTION + "When read, this variable return the result of the last command issued: + noaction(1) is returned if no command was issued yet + inprocess(2) is never returned, as the subagent cannot determine when a + command actually finished + accepted(3) is returned if the last issued command was accepted + (which does not mean that the command was successful) + rejected(4) is returned if the last command was rejected + (e.g. insufficient authorization)" + ::= { subsystemServerEntry 5 } + +subsystemServerCommandRejectReason OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The reason for rejection" + ::= { subsystemServerEntry 6 } + +subsystemServerVersion OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The currently running version" + ::= { subsystemServerEntry 7 } + +subsystemServerAdaptation OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The adaption currently in use" + ::= { subsystemServerEntry 8 } + +-- Trap control of the subsystems +subsystemServerTrapControlStatus OBJECT-TYPE + SYNTAX CmmcControlType + ACCESS read-write + STATUS mandatory + DESCRIPTION + "Trap reporting enabled/disabled for all subsystems" + ::= { subsystems 3 } + + + +--####################################################################### +--# MIB information of the CHAP Satellites # +--####################################################################### + +satelliteList OBJECT-TYPE + SYNTAX SEQUENCE OF SatelliteEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "Table of the CHAP sattelites" + ::= { satellites 1 } + +satelliteEntry OBJECT-TYPE + SYNTAX SatelliteEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "An entry in the list of the CHAP satellites" + INDEX { satelliteHostname } + ::= { satelliteList 1 } + SatelliteEntry ::= SEQUENCE { + satelliteHostname DisplayString (SIZE(0..8)), + satelliteRole DisplayString (SIZE(0..25)), + satelliteStatus CmmcSatelliteStateType, + satelliteCommandAuthorization INTEGER, + satelliteCommand CmmcSatelliteCommandType, + satelliteCommandResult CmmcResultType, + satelliteCommandRejectReason DisplayString (SIZE(0..25)), + satelliteVersion DisplayString (SIZE(0..25)), + satelliteAdaptation DisplayString (SIZE(0..25)) + } + +satelliteHostname OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..8)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Hostname that identifies the satellite" + ::= { satelliteEntry 1 } + +satelliteRole OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The role of the satellite, e.g. 'Firewall' or 'controller + working position'" + ::= { satelliteEntry 2 } + +satelliteStatus OBJECT-TYPE + SYNTAX CmmcSatelliteStateType + ACCESS read-only + STATUS mandatory + DESCRIPTION "Current status of the satellite (connected/disconnected)" + ::= { satelliteEntry 3 } + +satelliteCommandAuthorization OBJECT-TYPE + SYNTAX INTEGER + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Which commands are currently available. Encoding is as + follows (1 = allow / 0 = deny): + Bit 0: start (1), + Bit 1: stop (2), + Bit 2: restart (3), + Bit 3: reboot (4)" + ::= { satelliteEntry 4 } + +satelliteCommand OBJECT-TYPE + SYNTAX CmmcSatelliteCommandType + ACCESS read-write + STATUS mandatory + DESCRIPTION + "Issue a command to the satellite. When read, the last issued command is + reported. If no command was issued yet, start(1) is reported." + ::= { satelliteEntry 5 } + +satelliteCommandResult OBJECT-TYPE + SYNTAX CmmcResultType + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Result of the last issued command to this satellite" + ::= { satelliteEntry 6 } + +satelliteCommandRejectReason OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The reason for rejection of the last issued command" + ::= { satelliteEntry 7 } + +satelliteVersion OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The currently running version" + ::= { satelliteEntry 8 } + +satelliteAdaptation OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The adaption currently in use" + ::= { satelliteEntry 9 } + +-- +-- >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> +--####################################################################### +--# MIB information of the CHAP server processes # +--# (subsystem processes group) # +--####################################################################### + +-- maximum number of subsystem processes Object +maxSubsystemProcesses OBJECT-TYPE + SYNTAX INTEGER + ACCESS read-only + STATUS mandatory + DESCRIPTION + "This number represents the maximum number of CHAP subsystem processes + including the time synchronization process" + ::= { subsystemProcesses 1 } + +-- State Change Object of the processes +subsystemProcessesStateChangeCounter OBJECT-TYPE + SYNTAX Counter + ACCESS read-only + STATUS mandatory + DESCRIPTION + "This counter is incremented whenever a state change of one of the processes + happens except when traps are deactivated for the corresponding type. + (This counter counts the actually sent traps)" + ::= { subsystemProcesses 2 } + +-- Table of the subsystem processes +subsystemProcessesList OBJECT-TYPE + SYNTAX SEQUENCE OF SubsystemProcessesEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "Table of the CHAP processes running on the subsystems." + ::= { subsystemProcesses 3 } + +subsystemProcessesEntry OBJECT-TYPE + SYNTAX SubsystemProcessesEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "A list of processes running at the CHAP subsystems" + INDEX { subsystemName, subsystemProcessIndex } + ::= { subsystemProcessesList 1 } + SubsystemProcessesEntry ::= SEQUENCE { + subsystemName DisplayString (SIZE(0..8)), + subsystemProcessIndex INTEGER (1..50), + subsystemProcessIdent DisplayString (SIZE(0..25)), + subsystemProcessStatus CmmcServerStateType + } + +subsystemName OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..8)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Hostname that identifies the subsystem ()" + ::= { subsystemProcessesEntry 1 } + +subsystemProcessIndex OBJECT-TYPE + SYNTAX INTEGER (1..50) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "An index that identifies an entry of the processes List table uniquely." + ::= { subsystemProcessesEntry 2 } + +subsystemProcessIdent OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The identification (name) of the respective process" + ::= { subsystemProcessesEntry 3 } + +subsystemProcessStatus OBJECT-TYPE + SYNTAX CmmcServerStateType + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The valid status of the processes is operational, standby, alert and + unknown" + ::= { subsystemProcessesEntry 4 } + +-- Trap control of the subsystem processes +subsystemProcessesTrapControlStatus OBJECT-TYPE + SYNTAX CmmcControlType + ACCESS read-write + STATUS mandatory + DESCRIPTION + "Trap reporting enabled/disabled for all server processes" + ::= { subsystemProcesses 4 } + + +--####################################################################### +--# External Systems # +--####################################################################### + +-- maximum number of external systems Objects +maxExternalSystems OBJECT-TYPE + SYNTAX INTEGER + + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The maximum number of entries in externalSystemsList. Surplus entries + are silently discarded." + ::= { externalSystems 1 } + +-- State Change Object of the external systems +externalSystemsStateChangeCounter OBJECT-TYPE + SYNTAX Counter + ACCESS read-only + STATUS mandatory + DESCRIPTION + "This counter is incremented whenever a state change happens on one of the + interfaces to the external systems" + ::= { externalSystems 2 } + + +-- Table of the external system interfaces +externalSystemsList OBJECT-TYPE + SYNTAX SEQUENCE OF ExternalSystemsEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "Table of the CHAP processes interfacing to external systems e.g. NTP." + ::= { externalSystems 3 } + + +externalSystemsEntry OBJECT-TYPE + SYNTAX ExternalSystemsEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "An entry of the externalSystemsList." + INDEX { externalSystemLinkSink, externalSystemLinkIdent } + ::= { externalSystemsList 1 } + ExternalSystemsEntry ::= SEQUENCE { + externalSystemLinkSink DisplayString (SIZE(0..8)), + externalSystemLinkIdent DisplayString (SIZE(0..25)), + externalSystemLinkStatus CmmcLinkStateType, + externalSystemLinkInfo DisplayString (SIZE(0..8)) + } + +externalSystemLinkSink OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..8)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Hostname that identifies the CHAP server running the process interfacing + the external system." + ::= { externalSystemsEntry 1 } + +externalSystemLinkIdent OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The identifaction (name) of the process interfacing the external system, + e.g. NTP." + ::= { externalSystemsEntry 2 } + +externalSystemLinkStatus OBJECT-TYPE + SYNTAX CmmcLinkStateType + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The status of the process interfacing the external system." + ::= { externalSystemsEntry 3 } + +externalSystemLinkInfo OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Additional information, e.g. the hostname of the interfaced system" + ::= { externalSystemsEntry 4 } + +-- Trap Control of the interfaces +externalSystemsTrapControlStatus OBJECT-TYPE + SYNTAX CmmcControlType + ACCESS read-write + STATUS mandatory + DESCRIPTION + "Trap reporting enabled/disabled for all AMAN interfaces to external + systems." + ::= { externalSystems 4 } + + +--####################################################################### +--# Versions and Adaptations # +--####################################################################### + + +versionsAndAdaptationsList OBJECT-TYPE + SYNTAX SEQUENCE OF VersionsAndAdaptationsEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "Table of available version-adaptation combinations." + ::= { versionsAndAdaptations 1 } + + +versionsAndAdaptationsEntry OBJECT-TYPE + SYNTAX VersionsAndAdaptationsEntry + ACCESS not-accessible + STATUS mandatory + DESCRIPTION + "An entry of the VersionsAndAdaptationsList." + INDEX { version, adaptation } + ::= { versionsAndAdaptationsList 1 } + VersionsAndAdaptationsEntry ::= SEQUENCE { + version DisplayString (SIZE(0..25)), + adaptation DisplayString (SIZE(0..25)), + activate INTEGER (0..1) + } + +version OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The software version." + ::= { versionsAndAdaptationsEntry 1 } + +adaptation OBJECT-TYPE + SYNTAX DisplayString (SIZE(0..25)) + ACCESS read-only + STATUS mandatory + DESCRIPTION + "The software adaptation." + ::= { versionsAndAdaptationsEntry 2 } + +activate OBJECT-TYPE + SYNTAX INTEGER + ACCESS write-only + STATUS mandatory + DESCRIPTION + "Writing this variable activates this version-adaptation combination on + all CHAP servers and sattelites. All servers sattelites are instantly + restarted." + ::= { versionsAndAdaptationsEntry 3 } + +activationResult OBJECT-TYPE + SYNTAX CmmcResultType + ACCESS read-only + STATUS mandatory + DESCRIPTION + "Result of Activation command: + Accepted = sucess + Rejected = fail + No activation performed yet = noaction" + ::= { versionsAndAdaptations 2 } + + + +--####################################################################### +--# CHAP Traps # +--####################################################################### + +subsystemServerTrap TRAP-TYPE + ENTERPRISE chapTrap + VARIABLES { + subsystemServerStateChangeCounter, + subsystemServerHostname, + subsystemServerStatus + } + DESCRIPTION + "A status change of one of the servers has occurred + (subsystemServerStateChangeCounter, subsystemServerHostname, + subsystemServerStatus)" + ::= 1 + +subsystemProcessesTrap TRAP-TYPE + ENTERPRISE chapTrap + VARIABLES { + subsystemProcessesStateChangeCounter, + subsystemName, + subsystemProcessIndex, + subsystemProcessIdent, + subsystemProcessStatus + } + DESCRIPTION + "A status change of one of the servers processes has occurred + (subsystemProcessesStateChangeCounter, subsystemName, subsystemProcessIndex, + subsystemProcessIdent, subsystemProcessStatus)" + ::= 2 + +startupTrap TRAP-TYPE + ENTERPRISE chapTrap + VARIABLES { chapSystemCommand } + DESCRIPTION + "A start, restart or switchover of the CHAP system has occurred. The CHAP + system will set all state change counters to 0. The trap indicates the + reason for the startup command. The startupTrap is sent at subagent startup + and when the subagent switches to the ACTIVE state. Note that setting + startupTrapControlStatus has no effect on startup, because the Trap was + already sent when the setting is made." + ::= 3 + + +externalSystemsTrap TRAP-TYPE + ENTERPRISE chapTrap + VARIABLES { + externalSystemsStateChangeCounter, + externalSystemLinkSink, + externalSystemLinkIdent, + externalSystemLinkStatus, + externalSystemLinkInfo + } + DESCRIPTION + "A status change of one of the external systems has occurred. Includes the + value of externalSystemsStateChangeCounter after inkrementing it." + ::= 4 + +-- End of CHAP MIB definitions +END diff --git a/doc/SConscript b/doc/SConscript index d70f0af..f75bff1 100644 --- a/doc/SConscript +++ b/doc/SConscript @@ -1,5 +1,5 @@ # -# Copyright 2011-2012 Tanjeff-Nicolai Moos +# Copyright 2011-2016 Tanjeff-Nicolai Moos # # This file is part of the agentXcpp library. # @@ -17,98 +17,29 @@ # for more details. # - - -# This is a damn hack to get scons working with doxygen: We use the Command -# Builder to define how to invoke doxygen. Now, if scons is invoked from the -# parent directory, it will invoke doxygen in that directory, giving it e.g. -# doc/api.doxyfile as parameter. Doxygen finds its config, but does not find -# the sources (it searches the sources in ../src/, but they are actually in -# src/). -# -# So we hack the command accordingly, adding a "cd doc" to it and introducing a -# lot of dependencies. If the direcory structure of the agentxcpp project is -# ever changed, this scons script will likely break, and it will be a mess to -# get it working again... I will care about this later. After all it works. - - # Get the environment from the SConscript above Import('env') - ################################################# ## API documentation -# build up the command string. -# Note: We feed the revision into the PROJECT_NUMBER variable to let it appear -# in the generated documentation. -cmd = "cd doc/ && " -if 'revision' in env: - # Insert revision - cmd += "(cat api.doxyfile ; echo \"PROJECT_NUMBER=Revision: " - cmd += env['revision'] - cmd += "\" ) " -else: - # We don't have a revision identifier available - cmd += "cat api.doxyfile " -cmd += "| doxygen - > /dev/null" - -# Build it -# Note: To find out whether a rebuild is neccessary, -# Scons looks at the "target". If the target is -# a directory, things don't work, thus we use -# a HTML file as target -api = Command('api/html/index.html', - 'api.doxyfile', - cmd) - -# API doc depends on src/ directory -# Note: although not all files in there are actually -# dependencies, we pretend it was so, to avoid forgotten -# deps -Depends(api, Glob('../src/*.cpp') + Glob('../src/*.hpp')) - -# API doc also depends on other files -Depends(api, Glob('*.dox') + Glob('api.mainpage')) - -# Scons does not remove directories when invoked with -c, -# so we explicit request deletion of the api/ directory -# in those cases: -Clean(api, "api") - -# Provide an install target -Install(env['docdir'], "api") - +api = env.Doxygen('api.doxyfile', + DOXYPROJECTNUMBER="Version: " + env['revision']) +env.Clean(api, "api") +api_install = env.Install(env['docdir'], "api") +env.Clean(api_install, env['docdir']) ################################################# -## The same for the internal documentation: - -cmd = "cd doc/ && " -if 'revision' in env: - # Insert revision - cmd += "(cat internals.doxyfile ; echo \"PROJECT_NUMBER=Revision: " - cmd += env['revision'] - cmd += "\" ) " -else: - # We don't have a revision identifier available - cmd += "cat internals.doxyfile " -cmd += "| doxygen - > /dev/null" - -internals = Command('internals/html/index.html', - 'internals.doxyfile', - cmd) -Depends(internals, Glob('../src/*.cpp') + Glob('../src/*.hpp')) -Depends(internals, Glob('*.dox') + Glob('internals.mainpage')) -Clean(internals, "internals") +## Internals documentation (without installation target): - -# provide an alias for installing -Alias("install", env['docdir']) +internals = env.Doxygen('internals.doxyfile', + DOXYPROJECTNUMBER="Version: " + env['revision']) +env.Clean(internals, "internals") ################################################# ## The default targets for this directory -Default(api, internals) - +Alias("install", env['docdir']) +env.Default(api, internals) diff --git a/doc/api.doxyfile b/doc/api.doxyfile index 39743e7..3d779b6 100644 --- a/doc/api.doxyfile +++ b/doc/api.doxyfile @@ -1,124 +1,122 @@ -# -# Copyright 2011-2012 Tanjeff-Nicolai Moos -# -# This file is part of the agentXcpp library. -# -# AgentXcpp is free software: you can redistribute it and/or modify -# it under the terms of the AgentXcpp library license, version 1, which -# consists of the GNU General Public License and some additional -# permissions. -# -# AgentXcpp is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# See the AgentXcpp library license in the LICENSE file of this package -# for more details. -# - - -# Doxyfile 1.8.1.2 +# Doxyfile 1.8.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored. +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. # The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" "). +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = AgentXcpp -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "API Documentation" -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = ../artwork/doc_logo.png -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. OUTPUT_DIRECTORY = api -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. CREATE_SUBDIRS = NO +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. +# The default value is: YES. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ @@ -133,8 +131,9 @@ ABBREVIATE_BRIEF = "The $name class" \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = YES @@ -142,169 +141,207 @@ ALWAYS_DETAILED_SEC = YES # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. +# The default value is: NO. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. JAVADOC_AUTOBRIEF = NO -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. INHERIT_DOCS = NO -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 8 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# 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. +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which 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 = +ALIASES = "agentxcpp{1}=\ref agentxcpp::\1 \"\1\"" # 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 -# "class=itcl::class" will allow you to use the command class in the -# itcl::class meaning. +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. TCL_SUBST = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. EXTENSION_MAPPING = -# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all -# comments according to the Markdown format, which allows for more readable +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you -# can mix doxygen, HTML, and XML commands with Markdown formatting. -# Disable only in case of backward compatibilities issues. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. MARKDOWN_SUPPORT = YES +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. IDL_PROPERTY_SUPPORT = YES @@ -312,67 +349,61 @@ IDL_PROPERTY_SUPPORT = YES # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. +# The default value is: NO. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = YES -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. INLINE_GROUPED_CLASSES = NO -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and -# unions with only public data fields will be shown inline in the documentation -# of the scope in which they are defined (i.e. file, namespace, or group -# documentation), provided this scope is documented. If set to NO (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. INLINE_SIMPLE_STRUCTS = NO -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. 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 -# their name and scope. Since this can be an expensive process and often the -# same symbol appear multiple times in the code, doxygen keeps a cache of -# pre-resolved symbols. If the cache is too small doxygen will become slower. -# If the cache is too large, memory is wasted. The cache size is given by this -# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 @@ -381,329 +412,378 @@ LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. EXTRACT_PRIVATE = NO -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. EXTRACT_PACKAGE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. EXTRACT_STATIC = NO -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_MEMBERS = YES -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_CLASSES = YES -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. +# The default value is: system dependent. CASE_SENSE_NAMES = NO -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = YES -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. FORCE_LOCAL_INCLUDES = NO -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. GENERATE_TODOLIST = NO -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. SHOW_USED_FILES = NO -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. SHOW_NAMESPACES = NO # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. LAYOUT_FILE = -# The CITE_BIB_FILES tag can be used to specify one or more bib files -# containing the references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# requires the bibtex tool to be installed. See also -# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style -# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this -# feature you need bibtex and perl available in the search path. +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. WARN_IF_DOC_ERROR = YES -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. INPUT = ../src \ ./ \ api.mainpage # 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 -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.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 *.for *.vhd *.vhdl +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. FILE_PATTERNS = *.c \ *.cc \ @@ -737,15 +817,16 @@ FILE_PATTERNS = *.c \ *.vhd \ *.vhdl -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: 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 # subdirectory from a directory tree whose root is specified with the INPUT tag. +# # Note that relative paths are relative to the directory from which doxygen is # run. @@ -754,14 +835,16 @@ EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = */moc_*.cc @@ -770,755 +853,1108 @@ EXCLUDE_PATTERNS = */moc_*.cc # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). EXAMPLE_PATH = ../ # If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). IMAGE_PATH = . # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be -# ignored. +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C, C++ and Fortran comments will always remain visible. +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. STRIP_CODE_COMMENTS = NO -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. REFERENCES_LINK_SOURCE = NO -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = NO +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. -ALPHABETICAL_INDEX = NO +ALPHABETICAL_INDEX = YES -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 2 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# style sheet in the HTML output directory as well, or it will be erased! +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra stylesheet files is of importance (e.g. the last +# stylesheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that -# the files will be copied as-is; there are no commands or markers available. +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the style sheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 17 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 60 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of -# entries shown in the various tree structured indices initially; the user -# can expand and collapse entries dynamically later on. Doxygen will expand -# the tree to such a level that at most the specified number of entries are -# visible (unless a fully collapsed tree already exceeds this amount). -# So setting the number of entries 1 will produce a full collapsed tree by -# default. 0 is a special value representing an infinite number of entries -# and will result in a full expanded tree by default. +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be # written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) -# at top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. Since the tabs have the same information as the -# navigation tree you can set this option to NO if you already set -# GENERATE_TREEVIEW to YES. +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = YES # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. -# Since the tree basically has the same information as the tab index you -# could consider to set DISABLE_INDEX to NO when enabling this option. +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) that doxygen will group on one line in the generated HTML -# documentation. Note that a value of 0 will completely suppress the enum -# values from appearing in the overview section. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you may also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to -# the MathJax Content Delivery Network so you can quickly see the result without -# installing MathJax. -# However, it is strongly recommended to install a local -# copy of MathJax from http://www.mathjax.org before deployment. +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://www.mathjax.org/mathjax -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension -# names that should be enabled during MathJax rendering. +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /