diff --git a/agl/CMakeLists.txt b/agl/CMakeLists.txt index 4d47440..a37341d 100644 --- a/agl/CMakeLists.txt +++ b/agl/CMakeLists.txt @@ -1,7 +1,8 @@ cmake_minimum_required (VERSION 2.8) -cmake_policy(SET CMP0011 NEW) cmake_policy(SET CMP0003 OLD) +cmake_policy(SET CMP0011 NEW) +cmake_policy(SET CMP0015 NEW) # set project name set (PROJECT agl) @@ -28,4 +29,4 @@ set (LIBRARIES) set (TARGETS "") set (HEADERS "") -add_subdirectory (src) \ No newline at end of file +add_subdirectory (${${PROJECT}_SOURCE_DIR}) \ No newline at end of file diff --git a/agl/README b/agl/README new file mode 100644 index 0000000..83df9b3 --- /dev/null +++ b/agl/README @@ -0,0 +1,15 @@ +agl - program that creates PDB file with chosen aglomerate +Version: 1.0.1 +License: GPL + +Usage: + agl -a FILENAME -i FILENAME -c X,Y,Z -o FILEMANE [ -l LOGFILE] [ -q ] [ -h ] + +Parametrs: + -a - input file with aglomerates (in format statgen) + -i - input file with coordinates + -c - cell size (float), A + -o - output file with coordinates + -l - log enable + -q - quiet enable + -h - show this help and exit diff --git a/agl/about.dox b/agl/about.dox new file mode 100644 index 0000000..c294ae9 --- /dev/null +++ b/agl/about.dox @@ -0,0 +1,63 @@ +/*! + * @mainpage agl + * @image latex ./logo.png + * + * @section intro_sec Introduction + * + * About this program: + * + * + * Developer: + * + * License: + * + * + * @section How-To-Use How to use + * Usage: + * 
+ * agl -a FILENAME -i FILENAME -c X,Y,Z -o FILEMANE [ -l LOGFILE] [ -q ] [ -h ]
+ *
+ * Parametrs:
+ *    -a          - input file with aglomerates (in format statgen)
+ *    -i          - input file with coordinates
+ *    -c          - cell size (float), A
+ *    -o          - output file with coordinates
+ *    -l          - log enable
+ *    -q          - quiet enable
+ *    -h          - show this help and exit
+ *
+ * + * @page Install + * + * @section Requirements Requirements + * The application statgen requires the following external stuff: + * - cmake >= 2.8 + * - gcc >= 4.8 + * + * @section How-To How to install + * + * @subsection Linux Linux + * @code + * mkdir build && cd build + * cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ + * make + * make install + * @endcode + * + * @subsection Windows Windows + * @code + * create project file using 'cmake' + * compile project + * @endcode + * You may also download compiled executable file for Win_x86. + * + * @page Changelog + * V.1.0.1 (2013-07-27) + * * initial release + */ diff --git a/agl/agl.cmake b/agl/agl.cmake index 427f0d4..2b4603e 100644 --- a/agl/agl.cmake +++ b/agl/agl.cmake @@ -1,22 +1,32 @@ # set directories set (${PROJECT}_BINARY_DIR bin) -set (${PROJECT}_SOURCE_DIR src:include) +set (${PROJECT}_SOURCE_DIR src) +set (${PROJECT}_INCLUDE_DIR include) set (${PROJECT}_LIB_DIR lib) -set (CMAKE_INCLUDE_PATH ${${PROJECT}_SOURCE_DIR}) -set (CMAKE_LIBRARY_PATH ${${PROJECT}_LIB_DIR}) +# include_path +include_directories (${${PROJECT}_INCLUDE_DIR}/${PROJECT} + ${${PROJECT}_SOURCE_DIR}) +# library path +link_directories (${${PROJECT}_LIB_DIR}) +# executable path set (EXECUTABLE_OUTPUT_PATH ${${PROJECT}_BINARY_DIR}) + +# verbose set (CMAKE_VERBOSE_MAKEFILE ON) +# flags if ( WITH_DEBUG_MODE ) - ADD_DEFINITIONS ( -DDEBUG_MODE=1 ) + add_definitions ( -DDEBUG_MODE=1 ) endif () - if ( CMAKE_COMPILER_IS_GNUCXX ) set (ADD_CXX_FLAGS "-Wall") set (CMAKE_CXX_FLAGS "-O0 ${ADD_CXX_FLAGS}") set (CMAKE_CXX_FLAGS_DEBUG "-g -O0") set (CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG") +elseif ( MSVC ) + set (ADD_CXX_FLAGS "/W4") + set (CMAKE_CXX_FLAGS "${ADD_CXX_FLAGS}") else () - message (STATUS "Flags not enabled") + message ("Unknown compiler") endif () \ No newline at end of file diff --git a/agl/agl.doxygen b/agl/agl.doxygen new file mode 100644 index 0000000..dcdaba2 --- /dev/null +++ b/agl/agl.doxygen @@ -0,0 +1,1889 @@ +# Doxyfile 1.8.4 + +# 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 +# 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 (" ") + +#--------------------------------------------------------------------------- +# 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. + +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. + +PROJECT_NAME = agl + +# 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 = V.1.0.1 + +# 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. + +PROJECT_BRIEF = "Program that creates PDB file with chosen aglomerate" + +# 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 = /home/arcanis/Documents/github/moldyn/agl/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. + +OUTPUT_DIRECTORY = ./docs + +# 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. + +CREATE_SUBDIRS = 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, Latvian, Lithuanian, Norwegian, Macedonian, +# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, +# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +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. + +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 +# brief descriptions will be completely suppressed. + +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" + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + 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 +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# 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. + +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. + +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. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +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. + +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. + +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.) + +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.) + +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. + +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. + +INHERIT_DOCS = YES + +# 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. + +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. + +TAB_SIZE = 4 + +# 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. + +ALIASES = + +# 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. + +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. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# 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. + +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. + +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. + +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. + +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 +# 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. + +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. + +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 +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +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. + +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. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# 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. + +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. + +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). + +INLINE_GROUPED_CLASSES = NO + +# 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 (the default), structs, classes, and unions are shown on a separate +# page (for HTML and Man pages) or section (for LaTeX and RTF). + +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 +# 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 +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# 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. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# 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 respectively EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +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. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +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. + +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. + +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. + +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. + +HIDE_UNDOC_MEMBERS = NO + +# 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. + +HIDE_UNDOC_CLASSES = NO + +# 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. + +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. + +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. + +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 +# 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. + +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. + +HIDE_SCOPE_NAMES = YES + +# 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. + +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. + +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. + +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. + +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. + +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. + +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. + +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. +# 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. + +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. + +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. + +GENERATE_TODOLIST = YES + +# 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. + +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. + +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. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if section-label ... \endif +# and \cond section-label ... \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. + +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. + +SHOW_USED_FILES = 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 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. + +SHOW_NAMESPACES = YES + +# 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. + +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. + +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. Do not use +# file names with spaces, bibtex cannot handle them. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# 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. + +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. + +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. + +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. + +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. + +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) + +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. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# 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. + +INPUT = . + +# 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. + +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 = *.c \ + *.dox + +# 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. + +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. + +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. + +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/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# 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 + +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). + +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 = * + +# 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. + +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). + +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. +# 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. + +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). + +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. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MD_FILE_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 reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# 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. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +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. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +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. + +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. + +REFERENCES_LINK_SOURCE = 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. + +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. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# 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. + +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]) + +COLS_IN_ALPHA_INDEX = 5 + +# 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. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +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. + +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. + +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! + +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. + +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 left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is 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 file to +# the output directory. + +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. + +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. + +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. + +HTML_TIMESTAMP = YES + +# 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. + +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. + +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 +# for more information. + +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. + +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. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_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. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +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. + +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 +# written to the html output directory. + +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. + +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). + +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. + +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. + +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. + +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. + +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. + +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 + +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 + +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 + +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. + +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. + +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. + +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. + +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. + +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. + +DISABLE_INDEX = NO + +# 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. + +GENERATE_TREEVIEW = NO + +# 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. + +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. + +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. + +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. + +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. + +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. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and +# SVG. The default value is HTML-CSS, which is slower, but has the best +# compatibility. + +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. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# 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. + +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. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. +# There are two flavours of web server based search depending on the +# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for +# searching and an index file used by the script. When EXTERNAL_SEARCH is +# enabled the indexing and searching needs to be provided by external tools. +# See the manual for details. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain +# the search results. Doxygen ships with an example indexer (doxyindexer) and +# search engine (doxysearch.cgi) which are based on the open source search +# engine library Xapian. See the manual for configuration details. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will returned the search results when EXTERNAL_SEARCH is enabled. +# Doxygen ships with an example search engine (doxysearch) which is based on +# the open source search engine library Xapian. See the manual for configuration +# details. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id +# of to a relative location where the documentation can be found. +# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX 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 `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4 will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images +# or other source files which should be copied to the LaTeX output directory. +# Note that the files will be copied as-is; there are no commands or markers +# available. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF 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 `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = YES + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .1 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files +# that can be used to generate PDF. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in +# front of it. If left blank docbook will be used as the default path. + +DOCBOOK_OUTPUT = docbook + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed +# in the related pages index. If set to NO, only the current project's +# pages will be listed. + +EXTERNAL_PAGES = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = NO + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# manageable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/agl/logo.png b/agl/logo.png new file mode 100755 index 0000000..41adc0c Binary files /dev/null and b/agl/logo.png differ diff --git a/agl/src/CMakeLists.txt b/agl/src/CMakeLists.txt index b996fce..e3486ad 100644 --- a/agl/src/CMakeLists.txt +++ b/agl/src/CMakeLists.txt @@ -3,59 +3,27 @@ set ("${PROJECT}_VERSION_MINOR" 0) set ("${PROJECT}_VERSION_PATCH" 1) set ("${PROJECT}_VERSION" ${${PROJECT}_VERSION_MAJOR}.${${PROJECT}_VERSION_MINOR}.${${PROJECT}_VERSION_PATCH}) -message (STATUS ${${PROJECT}_VERSION}) +message (STATUS "${PROJECT}: Version ${${PROJECT}_VERSION}") -## set files -# main files -set (MAIN_SOURCES main) -# not public srcs -set (PRIVATE_CLASSES) -# headers only files -SET (HEADERS_ONLY) -# public srcs -set (PUBLIC_CLASSES add_main - coords - envir_search - messages - print_struct - set_center) -# public headers -set (PUBLIC_HEADERS) -# shared libraries +# set files +aux_source_directory (. SOURCES) + +# set library if (CMAKE_COMPILER_IS_GNUCXX) set (ADDITIONAL_LIB m) else () set (ADDITIONAL_LIB) endif() -set (SOURCES) - -# append list -foreach (class ${PRIVATE_CLASSES}) - LIST (APPEND SOURCES ${class}.c) - LIST (APPEND HEADERS ${class}.h) -endforeach () - -foreach (class ${HEADERS_ONLY}) - LIST (APPEND HEADERS ${class}.h) -endforeach () - -foreach (class ${PUBLIC_CLASSES}) - LIST (APPEND SOURCES ${class}.c) - LIST (APPEND HEADERS ../include/${PROJECT}/${class}.h) - LIST (APPEND PUBLIC_HEADERS ../include/${PROJECT}/${class}.h) -endforeach () # message message (STATUS "SOURCES: ${SOURCES}") # link libraries and compile -add_executable (${PROJECT} ${MAIN_SOURCES} ${SOURCES}) +add_executable (${PROJECT} ${SOURCES}) target_link_libraries (${PROJECT} ${ADDITIONAL_LIB}) # install properties -INSTALL (TARGETS ${PROJECT} - DESTINATION bin) +INSTALL (TARGETS ${PROJECT} DESTINATION bin) if (ADD_INCLUDE) - INSTALL (FILES ${PUBLIC_HEADERS} - DESTINATION include/${PROJECT}) + INSTALL (FILES ${PUBLIC_HEADERS} DESTINATION include/${PROJECT}) endif () \ No newline at end of file diff --git a/agl/src/coords.c b/agl/src/coords.c index 636dbf2..e7438cb 100644 --- a/agl/src/coords.c +++ b/agl/src/coords.c @@ -1,52 +1,67 @@ -/* Library for reading coordinates from input file - * - * Usage: - * reading_coords (mode, filename, type_interaction, labels, - * cell, &number_of_molecules, &number_of_atoms, true_label_molecule, - * label_molecule, type_atoms, coords, char_type_atoms) +/** + * @file */ #include #include - +/** + * @fn reading_coords + */ int reading_coords (const int mode, const char *filename, const int type_inter, const int *label_atom, const float *cell, int *num_mol, int *num_atoms, int *true_label_mol, int *label_mol, int *type_atoms, float *coords, char *ch_type_atoms) -/* filename - name of file with coordinates - * type_inter - type interaction (number of molecules for interaction) - * (number of molecules in aglomerate for agl) - * label_atom - types of atom for interaction - * (molecules in aglomerate for agl) - * cell - cell dimension - * num_mol - number of molecules for writing coordinates - * num_atoms - number of atoms for writing coordinates - * true_label_mol - massive of true numbers of molecule for atoms - * label_mol - massive of numbers of molecule for atoms - * type_atoms - massive of atom types for atoms - * coords - massive of coordinates - * ch_type_atoms - massive of char types for atoms +/** + * @brief function that reads coordinates from special file format + * @code + * reading_coords (0, filename, type_inter, label_atom, cell, &num_mol, &num_atoms, + * true_label_mol, label_mol, type_atoms, coords, ch_type_atoms); + * @endcode + * + * @param mode mode of reading; '1' is statgen, '2' is envir or + * frad, '3' is agl + * @param filename input file name + * @param type_inter number of needed atoms + * (number of needed molecules) + * @param label_atom massive of needed atom types + * (massive of needed molecules) + * @param cell massive of cell size + * @param num_mol number of molecules + * @param num_atoms number of atoms + * @param true_label_mol massive of true numbers of molecule for atoms + * @param label_mol massive of numbers of molecule for atoms + * @param type_atoms massive of atom types + * @param coords massive of coordinates + * @param ch_type_atoms massive of char atom types + * + * @return 1 - file $filename does not exist + * @return 2 - unknown mode + * @return 0 - exit without errors */ { char at_symb[32], file_string[256]; int atoms, cur_at_num, cur_at_type, cur_mol, i, j, tr_num_atoms, ref_mol, x, y; float cur_coords[3], *not_tr_coords, ref[3]; FILE *inp; -/* cur_*, at_symb - temp variables - * file_string - temp string variable - * atoms - total number of atoms in system - * tr_num_atoms - number of translated atoms for writing coordinates (m.b. 8*num_atoms) - * ref_mol - number of molecule for reference - * not_tr_coords - not translated coordinates - * ref - coordinates of reference molecule - * inp - file with input data + +/* cur_* temp variables + * at_symb temp variable + * file_string temp string variable + * atoms total number of atoms in system + * tr_num_atoms number of translated atoms (must be 8*num_atoms) + * ref_mol number of molecule for reference in translation + * not_tr_coords massive of not translated coordinates + * ref massive of coordinates of reference molecule + * inp input file */ +/// Work blocks + *num_atoms = 0; *num_mol = 0; -// Reading file +/// 
   reading file
inp = fopen (filename, "r"); if (inp == NULL) return 1; @@ -61,10 +76,11 @@ int reading_coords (const int mode, const char *filename, const int type_inter, sscanf (file_string, "%i%s%f%f%f%i%i", &cur_at_num, at_symb, &cur_coords[0], &cur_coords[1], &cur_coords[2], &cur_at_type, &cur_mol); +// reading variables according to selected mode switch (mode) { case 0: -// for statgen +// mode == 0 (selected atoms) for (j=0; j translation tr_num_atoms = *num_atoms; for (i=0; i<*num_atoms; i++) for (j=0; j<3; j++) coords[3*i+j] = not_tr_coords[3*i+j]; -// Assign initial value to reference coordinates +// assign initial value to reference coordinates ref_mol = label_mol[0]; for (i=0; i<3; i++) ref[i] = coords[3*0+i]; @@ -154,7 +170,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, for (x=0; x<3; x++) { if (ref[x] >= 0.0) -// if xyz >= 0.0 A +// if xyz >= 0.0 A { for (j=0; j<3; j++) if (j == x) @@ -167,7 +183,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, tr_num_atoms++; } else -// if xyz < 0.0 A +// if xyz < 0.0 A { for (j=0; j<3; j++) if (j == x) @@ -186,7 +202,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, for (y=x+1; y<3; y++) { if ((ref[x] >= 0.0) && (ref[y] >= 0.0)) -// if xyz and xyz >= 0.0 A +// if xyz and xyz >= 0.0 A { for (j=0; j<3; j++) if ((j == x) || (j == y)) @@ -200,7 +216,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[x] < 0.0) && (ref[y] < 0.0)) -// if xyz and xyz < 0.0 A +// if xyz and xyz < 0.0 A { for (j=0; j<3; j++) if ((j == x) || (j == y)) @@ -216,7 +232,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, for (y=0; y<3; y++) if ((ref[x] < 0.0) && (ref[y] >= 0.0)) -// if xyz OR xyz >= 0.0 +// if xyz OR xyz >= 0.0 { for (j=0; j<3; j++) { @@ -235,7 +251,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] >= 0.0) && (ref[1] >= 0.0) && (ref[2] >= 0.0)) -// if x and y and z >= 0.0 A +// if x and y and z >= 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] - cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] - cell[1]; @@ -247,7 +263,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] >= 0.0) && (ref[1] >= 0.0) && (ref[2] < 0.0)) -// if x and y >= 0.0 A and z < 0.0 A +// if x and y >= 0.0 A and z < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] - cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] - cell[1]; @@ -259,7 +275,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] >= 0.0) && (ref[1] < 0.0) && (ref[2] >= 0.0)) -// if x and z >= 0.0 A and y < 0.0 A +// if x and z >= 0.0 A and y < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] - cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] + cell[1]; @@ -271,7 +287,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] < 0.0) && (ref[1] >= 0.0) && (ref[2] >= 0.0)) -// if y and z >= 0.0 A and x < 0.0 A +// if y and z >= 0.0 A and x < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] + cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] - cell[1]; @@ -283,7 +299,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] < 0.0) && (ref[1] < 0.0) && (ref[2] >= 0.0)) -// if x and y < 0.0 A and z >= 0.0 A +// if x and y < 0.0 A and z >= 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] + cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] + cell[1]; @@ -295,7 +311,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] < 0.0) && (ref[1] >= 0.0) && (ref[2] < 0.0)) -// if x and z < 0.0 A and y >= 0.0 A +// if x and z < 0.0 A and y >= 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] + cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] - cell[1]; @@ -307,7 +323,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] >= 0.0) && (ref[1] < 0.0) && (ref[2] < 0.0)) -// if x >= 0.0 A and y and z < 0.0 A +// if x >= 0.0 A and y and z < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] - cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] + cell[1]; @@ -319,7 +335,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] < 0.0) && (ref[1] < 0.0) && (ref[2] < 0.0)) -// if x and y and z < 0.0 A +// if x and y and z < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] + cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] + cell[1]; @@ -331,7 +347,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } } -// free memory +/// 
   free memory
free (not_tr_coords); return 0; diff --git a/agl/src/main.c b/agl/src/main.c index 1759408..795b9c0 100644 --- a/agl/src/main.c +++ b/agl/src/main.c @@ -46,7 +46,7 @@ int main(int argc, char *argv[]) if ((argv[i][0] == '-') && (argv[i][1] == 'h')) { sprintf (tmp_str, " agl\n"); - sprintf (tmp_str, "%sProgram for create PDB file with choosen aglomerate\n", tmp_str); + sprintf (tmp_str, "%sProgram for create PDB file with chosen aglomerate\n", tmp_str); sprintf (tmp_str, "%sVersion : 1.0.1 License : GPL\n", tmp_str); sprintf (tmp_str, "%s Evgeniy Alekseev aka arcanis\n", tmp_str); sprintf (tmp_str, "%s E-mail : esalexeev@gmail.com\n\n", tmp_str); diff --git a/agl/src/messages.c b/agl/src/messages.c index f4560f3..58c8795 100644 --- a/agl/src/messages.c +++ b/agl/src/messages.c @@ -1,16 +1,27 @@ -/* Library for printing messages at output - * - * Usage: - * message (log, mode, text, output) +/** + * @file */ #include #include +/** + * @fn message + */ int message (const int log, const int mode, const char *text, FILE *output) -/* mode - number of message - * text - additional text +/** + * @brief function that prints messages to output + * @code + * message (log, mode, text, output); + * @endcode + * + * @param log equal to 1 if print to logfile + * @param mode number of message + * @param text additional text + * @param output output file (may be stdout) + * + * @return 0 - exit without errors */ { char out[4096]; @@ -18,6 +29,7 @@ int message (const int log, const int mode, const char *text, FILE *output) if (log == 1) { char time_str[256]; + time_t t = time (NULL); struct tm* aTm = localtime (&t); sprintf (time_str, "[%04d-%02d-%02d %02d:%02d:%02d] [%2i]: ", aTm->tm_year+1900, diff --git a/agl/src/print_struct.c b/agl/src/print_struct.c index c1e6487..529698a 100644 --- a/agl/src/print_struct.c +++ b/agl/src/print_struct.c @@ -1,3 +1,7 @@ +/** + * @file + */ + /* Library for printing structure to pdb file * * Usage: @@ -8,23 +12,37 @@ #include +/** + * @fn print_structure + */ int print_structure (const char *output, const int num_needed_mol, const int *needed_mol, const int num_atoms, const int *label_mol, const char *ch_type_atoms, const float *coords) -/* output - output file name - * num_needed_mol - number of needed molecules - * needed_mol - massive of needed molecules - * num_atoms - number of atoms - * label_mol - massive of numbers of molecule for atoms - * ch_type_atoms - massive of char types for atoms - * coords - massive of coordinates +/** + * @brief function that prints structure to pdb file + * @code + * print_structure (output, num_needed_mol, needed_mol, num_atoms, label_mol, + * char_type_atoms, coords); + * @endcode + * + * @param output output file name + * @param num_needed_mol number of needed molecules + * @param needed_mol massive of number of needed molecules + * @param num_atoms number of atoms + * @param label_mol massive of numbers of molecule for atoms + * @param ch_type_atoms massive of char atom types + * @param coords massive of coordinates + * + * @return 0 - exit without errors */ { int cur_atom, cur_atom_num, cur_mol, i, j; FILE *f_out; -/* cur_atom - current atom - * cur_atom_num - true atom number - * cur_mol - current molecule + +/* cur_atom current atom + * cur_atom_num true atom number + * cur_mol current molecule + * f_out output file */ cur_atom = 1; diff --git a/en_disp/ca.txt b/en_disp/ca.txt new file mode 100644 index 0000000..13d4315 --- /dev/null +++ b/en_disp/ca.txt @@ -0,0 +1,300 @@ +0.495 10.418898 +1.495 9.950804 +2.495 9.82146 +3.495 9.850474 +4.495 9.696533 +5.495 9.753499 +6.495 9.762932 +7.495 9.723365 +8.495 10.014191 +9.495 10.090842 +10.495 9.997436 +11.495 10.016979 +12.495 10.031467 +13.495 9.924226 +14.495 9.890284 +15.495 9.77921 +16.495 9.702351 +17.495 9.716536 +18.495 9.71042 +19.495 9.384672 +20.495 9.517883 +21.495 9.664516 +22.495 9.632805 +23.495 9.735373 +24.495 9.765346 +25.495 9.645189 +26.495 9.641912 +27.495 10.163867 +28.495 10.181592 +29.495 9.926333 +30.495 10.033085 +31.495 10.127791 +32.495 10.311988 +33.495 9.808517 +34.495 10.272553 +35.495 10.329018 +36.495 10.309202 +37.495 10.098222 +38.495 10.159035 +39.495 9.957952 +40.495 9.998584 +41.495 10.069609 +42.495 9.89074 +43.495 9.84689 +44.495 9.708708 +45.495 9.649786 +46.495 9.325311 +47.495 9.555045 +48.495 9.554562 +49.495 9.524442 +50.495 9.699064 +51.495 9.362999 +52.495 9.786994 +53.495 9.765195 +54.495 9.670958 +55.495 9.35132 +56.495 9.761409 +57.495 9.392701 +58.495 9.356889 +59.495 9.408867 +60.495 9.417254 +61.495 9.628405 +62.495 9.901407 +63.495 9.670194 +64.495 9.662455 +65.495 9.639038 +66.495 9.812234 +67.495 9.671042 +68.495 9.75535 +69.495 9.745772 +70.495 9.912268 +71.495 9.785694 +72.495 9.817339 +73.495 10.029068 +74.495 9.936254 +75.495 9.606431 +76.495 9.515212 +77.495 9.756271 +78.495 9.687815 +79.495 9.531412 +80.495 10.024444 +81.495 9.846199 +82.495 9.600954 +83.495 9.470863 +84.495 9.530602 +85.495 9.471397 +86.495 9.569076 +87.495 9.97256 +88.495 9.945459 +89.495 9.539951 +90.495 9.730874 +91.495 9.708173 +92.495 9.728682 +93.495 9.636923 +94.495 9.51818 +95.495 9.694912 +96.495 10.127011 +97.495 10.343201 +98.495 10.326031 +99.495 10.14791 +100.495 10.362019 +101.495 10.27092 +102.495 10.137325 +103.495 9.942941 +104.495 10.193326 +105.495 10.257613 +106.495 9.895024 +107.495 9.655592 +108.495 9.483453 +109.495 9.684728 +110.495 9.885463 +111.495 10.026399 +112.495 10.047047 +113.495 10.1834 +114.495 10.090755 +115.495 9.975076 +116.495 10.050849 +117.495 9.994183 +118.495 9.807983 +119.495 9.722695 +120.495 9.801534 +121.495 9.907951 +122.495 9.860322 +123.495 9.869689 +124.495 9.895987 +125.495 9.841974 +126.495 9.951846 +127.495 9.832937 +128.495 9.885062 +129.495 9.813783 +130.495 9.684291 +131.495 9.885339 +132.495 9.708161 +133.495 9.754633 +134.495 9.792124 +135.495 9.808579 +136.495 9.811543 +137.495 9.782301 +138.495 9.56639 +139.495 9.841753 +140.495 9.914329 +141.495 9.977631 +142.495 9.749889 +143.495 9.76908 +144.495 9.882627 +145.495 9.841321 +146.495 9.832708 +147.495 10.450935 +148.495 10.140794 +149.495 9.723987 +150.495 9.397698 +151.495 9.557581 +152.495 9.281402 +153.495 9.572753 +154.495 10.605842 +155.495 9.995828 +156.495 10.119981 +157.495 10.080965 +158.495 10.009468 +159.495 10.040681 +160.495 10.135203 +161.495 10.351259 +162.495 10.101901 +163.495 9.943474 +164.495 9.987632 +165.495 9.823331 +166.495 10.067644 +167.495 9.987817 +168.495 10.070786 +169.495 9.883877 +170.495 9.94227 +171.495 10.033562 +172.495 9.982595 +173.495 10.068419 +174.495 10.139153 +175.495 9.979704 +176.495 9.699483 +177.495 10.011893 +178.495 9.928017 +179.495 10.124135 +180.495 10.066833 +181.495 10.069324 +182.495 10.351573 +183.495 10.644679 +184.495 11.008727 +185.495 10.476585 +186.495 10.563549 +187.495 10.955261 +188.495 10.288914 +189.495 10.181921 +190.495 10.173754 +191.495 10.202548 +192.495 9.969597 +193.495 10.012764 +194.495 10.104414 +195.495 10.037142 +196.495 10.074749 +197.495 10.001254 +198.495 10.077487 +199.495 10.052823 +200.495 9.915133 +201.495 9.842852 +202.495 9.667 +203.495 9.657872 +204.495 9.84561 +205.495 9.451061 +206.495 9.62459 +207.495 10.257664 +208.495 9.91896 +209.495 9.672087 +210.495 9.773147 +211.495 9.978817 +212.495 10.004964 +213.495 10.081589 +214.495 9.982108 +215.495 9.809712 +216.495 9.479629 +217.495 10.004244 +218.495 9.925939 +219.495 10.040169 +220.495 10.30559 +221.495 9.708866 +222.495 9.785239 +223.495 9.832165 +224.495 9.73784 +225.495 9.392737 +226.495 9.914623 +227.495 9.673237 +228.495 9.494724 +229.495 9.626924 +230.495 9.583567 +231.495 9.633996 +232.495 9.254592 +233.495 9.786718 +234.495 10.461098 +235.495 10.652362 +236.495 10.060664 +237.495 10.014629 +238.495 9.598738 +239.495 9.610362 +240.495 9.628961 +241.495 9.458214 +242.495 9.423989 +243.495 9.690958 +244.495 9.763616 +245.495 9.857896 +246.495 9.858091 +247.495 9.760202 +248.495 9.932053 +249.495 9.77053 +250.495 9.814235 +251.495 9.782696 +252.495 9.957203 +253.495 10.112691 +254.495 10.044214 +255.495 9.806607 +256.495 9.99203 +257.495 9.884048 +258.495 9.970362 +259.495 9.894917 +260.495 9.829692 +261.495 9.966207 +262.495 10.02361 +263.495 9.920719 +264.495 9.961572 +265.495 10.083698 +266.495 10.041025 +267.495 9.979657 +268.495 9.966049 +269.495 9.878101 +270.495 9.707976 +271.495 9.821568 +272.495 9.903031 +273.495 10.094413 +274.495 10.063516 +275.495 9.959853 +276.495 9.748308 +277.495 10.022636 +278.495 10.022269 +279.495 9.907438 +280.495 9.828258 +281.495 9.82824 +282.495 9.97273 +283.495 10.027607 +284.495 10.001367 +285.495 9.983068 +286.495 10.071244 +287.495 10.043729 +288.495 9.95981 +289.495 10.008244 +290.495 10.13468 +291.495 10.166469 +292.495 10.011308 +293.495 10.177845 +294.495 10.112561 +295.495 9.957638 +296.495 9.892344 +297.495 9.929006 +298.495 10.008845 +299.495 9.760489 diff --git a/en_disp/en_disp b/en_disp/en_disp new file mode 100755 index 0000000..9b7894e Binary files /dev/null and b/en_disp/en_disp differ diff --git a/en_disp/no.csv b/en_disp/no.csv new file mode 100644 index 0000000..67fa63a --- /dev/null +++ b/en_disp/no.csv @@ -0,0 +1,300 @@ +0.495 7.85555 +1.495 4.992043 +2.495 5.083519 +3.495 4.837184 +4.495 5.730787 +5.495 5.384058 +6.495 4.852617 +7.495 5.158381 +8.495 5.869892 +9.495 4.884564 +10.495 4.33198 +11.495 4.386514 +12.495 5.166891 +13.495 4.771049 +14.495 4.882547 +15.495 5.236072 +16.495 4.251842 +17.495 3.868952 +18.495 4.465192 +19.495 3.914108 +20.495 4.501608 +21.495 5.12093 +22.495 4.36732 +23.495 4.903208 +24.495 5.098126 +25.495 4.690235 +26.495 5.399739 +27.495 5.108307 +28.495 5.292021 +29.495 5.145338 +30.495 4.404358 +31.495 5.405853 +32.495 4.663691 +33.495 4.081963 +34.495 6.188183 +35.495 6.0188 +36.495 7.692908 +37.495 6.092902 +38.495 4.749257 +39.495 3.633642 +40.495 5.749056 +41.495 7.607848 +42.495 6.198161 +43.495 5.042036 +44.495 4.861593 +45.495 3.774541 +46.495 2.93576 +47.495 3.740174 +48.495 4.738251 +49.495 4.423623 +50.495 3.687216 +51.495 3.175314 +52.495 5.431673 +53.495 4.597431 +54.495 4.661989 +55.495 3.795582 +56.495 4.196253 +57.495 4.170956 +58.495 4.300163 +59.495 3.669111 +60.495 3.981718 +61.495 4.44312 +62.495 4.465314 +63.495 3.552949 +64.495 3.098147 +65.495 4.069936 +66.495 4.517417 +67.495 4.228989 +68.495 4.566031 +69.495 6.113259 +70.495 5.482125 +71.495 4.912869 +72.495 5.193067 +73.495 5.414767 +74.495 5.861018 +75.495 3.330722 +76.495 3.883945 +77.495 4.309343 +78.495 3.553871 +79.495 4.289112 +80.495 5.945142 +81.495 5.157633 +82.495 4.124648 +83.495 4.150417 +84.495 3.965337 +85.495 3.452004 +86.495 4.220101 +87.495 5.871353 +88.495 5.968219 +89.495 4.216883 +90.495 4.910265 +91.495 4.364788 +92.495 4.418641 +93.495 2.983683 +94.495 3.532853 +95.495 4.406537 +96.495 5.281766 +97.495 5.846073 +98.495 6.900974 +99.495 4.993888 +100.495 5.01344 +101.495 5.836103 +102.495 6.814361 +103.495 5.295947 +104.495 5.458851 +105.495 6.426154 +106.495 5.965657 +107.495 5.041414 +108.495 4.897183 +109.495 4.500224 +110.495 5.418111 +111.495 5.677549 +112.495 6.762825 +113.495 6.83103 +114.495 6.735544 +115.495 6.795608 +116.495 6.762779 +117.495 6.056893 +118.495 6.296188 +119.495 6.069157 +120.495 6.69384 +121.495 6.51264 +122.495 6.139268 +123.495 6.424421 +124.495 6.2766 +125.495 5.810904 +126.495 5.793117 +127.495 4.723606 +128.495 5.404977 +129.495 6.632844 +130.495 6.559532 +131.495 6.73709 +132.495 6.377484 +133.495 6.385852 +134.495 6.390564 +135.495 6.481876 +136.495 6.519546 +137.495 6.424363 +138.495 6.213209 +139.495 6.448448 +140.495 6.072065 +141.495 6.232355 +142.495 6.133897 +143.495 6.285806 +144.495 5.979782 +145.495 5.902345 +146.495 4.774288 +147.495 4.985182 +148.495 4.523976 +149.495 4.298417 +150.495 3.555156 +151.495 3.881785 +152.495 2.986247 +153.495 3.687659 +154.495 6.278628 +155.495 5.906808 +156.495 6.056681 +157.495 5.988139 +158.495 5.967813 +159.495 4.378355 +160.495 4.040305 +161.495 4.199613 +162.495 4.03333 +163.495 3.812861 +164.495 4.445457 +165.495 4.702903 +166.495 4.492487 +167.495 4.369803 +168.495 4.434697 +169.495 4.446601 +170.495 5.85261 +171.495 4.960565 +172.495 4.810213 +173.495 5.099955 +174.495 6.129668 +175.495 4.632645 +176.495 4.434772 +177.495 5.373664 +178.495 5.130775 +179.495 5.493731 +180.495 6.256959 +181.495 5.579167 +182.495 5.193838 +183.495 6.242636 +184.495 5.866744 +185.495 5.692851 +186.495 5.660518 +187.495 6.539093 +188.495 5.149898 +189.495 6.084246 +190.495 5.902113 +191.495 6.556249 +192.495 6.47089 +193.495 6.601765 +194.495 6.678838 +195.495 6.475928 +196.495 6.449563 +197.495 6.445582 +198.495 6.458978 +199.495 6.206001 +200.495 3.994532 +201.495 4.649855 +202.495 5.18968 +203.495 3.91944 +204.495 4.550412 +205.495 5.497172 +206.495 4.125317 +207.495 5.070048 +208.495 5.604442 +209.495 5.139417 +210.495 5.413501 +211.495 4.784013 +212.495 3.88686 +213.495 5.543916 +214.495 5.366814 +215.495 4.590774 +216.495 3.515021 +217.495 4.549414 +218.495 4.413313 +219.495 4.365502 +220.495 4.822679 +221.495 4.942861 +222.495 4.184449 +223.495 4.569083 +224.495 5.034656 +225.495 3.760486 +226.495 5.778256 +227.495 4.666387 +228.495 3.87934 +229.495 4.298156 +230.495 3.606369 +231.495 4.043328 +232.495 3.533107 +233.495 4.322265 +234.495 6.460613 +235.495 5.619601 +236.495 5.003014 +237.495 5.240613 +238.495 5.716251 +239.495 6.512721 +240.495 6.360552 +241.495 4.694978 +242.495 4.520795 +243.495 6.517642 +244.495 6.727004 +245.495 6.663968 +246.495 6.741717 +247.495 6.748613 +248.495 6.230022 +249.495 4.738152 +250.495 6.63096 +251.495 5.940607 +252.495 4.742698 +253.495 4.901755 +254.495 5.24829 +255.495 6.601441 +256.495 6.805718 +257.495 6.696987 +258.495 5.814055 +259.495 6.719182 +260.495 5.310413 +261.495 4.917739 +262.495 4.895024 +263.495 4.910364 +264.495 5.474503 +265.495 6.951988 +266.495 5.2517 +267.495 5.347468 +268.495 4.94037 +269.495 5.637509 +270.495 5.592732 +271.495 6.633568 +272.495 5.42893 +273.495 6.134158 +274.495 5.679378 +275.495 5.436838 +276.495 6.490301 +277.495 5.504136 +278.495 4.772426 +279.495 5.005461 +280.495 6.63088 +281.495 6.747831 +282.495 5.150361 +283.495 5.031422 +284.495 4.875282 +285.495 4.702079 +286.495 4.880232 +287.495 4.886068 +288.495 5.34387 +289.495 4.904718 +290.495 6.713236 +291.495 7.771074 +292.495 5.571742 +293.495 5.278872 +294.495 6.742266 +295.495 6.609142 +296.495 5.969145 +297.495 6.306997 +298.495 6.458366 +299.495 5.442104 diff --git a/en_disp/no.txt b/en_disp/no.txt new file mode 100644 index 0000000..67fa63a --- /dev/null +++ b/en_disp/no.txt @@ -0,0 +1,300 @@ +0.495 7.85555 +1.495 4.992043 +2.495 5.083519 +3.495 4.837184 +4.495 5.730787 +5.495 5.384058 +6.495 4.852617 +7.495 5.158381 +8.495 5.869892 +9.495 4.884564 +10.495 4.33198 +11.495 4.386514 +12.495 5.166891 +13.495 4.771049 +14.495 4.882547 +15.495 5.236072 +16.495 4.251842 +17.495 3.868952 +18.495 4.465192 +19.495 3.914108 +20.495 4.501608 +21.495 5.12093 +22.495 4.36732 +23.495 4.903208 +24.495 5.098126 +25.495 4.690235 +26.495 5.399739 +27.495 5.108307 +28.495 5.292021 +29.495 5.145338 +30.495 4.404358 +31.495 5.405853 +32.495 4.663691 +33.495 4.081963 +34.495 6.188183 +35.495 6.0188 +36.495 7.692908 +37.495 6.092902 +38.495 4.749257 +39.495 3.633642 +40.495 5.749056 +41.495 7.607848 +42.495 6.198161 +43.495 5.042036 +44.495 4.861593 +45.495 3.774541 +46.495 2.93576 +47.495 3.740174 +48.495 4.738251 +49.495 4.423623 +50.495 3.687216 +51.495 3.175314 +52.495 5.431673 +53.495 4.597431 +54.495 4.661989 +55.495 3.795582 +56.495 4.196253 +57.495 4.170956 +58.495 4.300163 +59.495 3.669111 +60.495 3.981718 +61.495 4.44312 +62.495 4.465314 +63.495 3.552949 +64.495 3.098147 +65.495 4.069936 +66.495 4.517417 +67.495 4.228989 +68.495 4.566031 +69.495 6.113259 +70.495 5.482125 +71.495 4.912869 +72.495 5.193067 +73.495 5.414767 +74.495 5.861018 +75.495 3.330722 +76.495 3.883945 +77.495 4.309343 +78.495 3.553871 +79.495 4.289112 +80.495 5.945142 +81.495 5.157633 +82.495 4.124648 +83.495 4.150417 +84.495 3.965337 +85.495 3.452004 +86.495 4.220101 +87.495 5.871353 +88.495 5.968219 +89.495 4.216883 +90.495 4.910265 +91.495 4.364788 +92.495 4.418641 +93.495 2.983683 +94.495 3.532853 +95.495 4.406537 +96.495 5.281766 +97.495 5.846073 +98.495 6.900974 +99.495 4.993888 +100.495 5.01344 +101.495 5.836103 +102.495 6.814361 +103.495 5.295947 +104.495 5.458851 +105.495 6.426154 +106.495 5.965657 +107.495 5.041414 +108.495 4.897183 +109.495 4.500224 +110.495 5.418111 +111.495 5.677549 +112.495 6.762825 +113.495 6.83103 +114.495 6.735544 +115.495 6.795608 +116.495 6.762779 +117.495 6.056893 +118.495 6.296188 +119.495 6.069157 +120.495 6.69384 +121.495 6.51264 +122.495 6.139268 +123.495 6.424421 +124.495 6.2766 +125.495 5.810904 +126.495 5.793117 +127.495 4.723606 +128.495 5.404977 +129.495 6.632844 +130.495 6.559532 +131.495 6.73709 +132.495 6.377484 +133.495 6.385852 +134.495 6.390564 +135.495 6.481876 +136.495 6.519546 +137.495 6.424363 +138.495 6.213209 +139.495 6.448448 +140.495 6.072065 +141.495 6.232355 +142.495 6.133897 +143.495 6.285806 +144.495 5.979782 +145.495 5.902345 +146.495 4.774288 +147.495 4.985182 +148.495 4.523976 +149.495 4.298417 +150.495 3.555156 +151.495 3.881785 +152.495 2.986247 +153.495 3.687659 +154.495 6.278628 +155.495 5.906808 +156.495 6.056681 +157.495 5.988139 +158.495 5.967813 +159.495 4.378355 +160.495 4.040305 +161.495 4.199613 +162.495 4.03333 +163.495 3.812861 +164.495 4.445457 +165.495 4.702903 +166.495 4.492487 +167.495 4.369803 +168.495 4.434697 +169.495 4.446601 +170.495 5.85261 +171.495 4.960565 +172.495 4.810213 +173.495 5.099955 +174.495 6.129668 +175.495 4.632645 +176.495 4.434772 +177.495 5.373664 +178.495 5.130775 +179.495 5.493731 +180.495 6.256959 +181.495 5.579167 +182.495 5.193838 +183.495 6.242636 +184.495 5.866744 +185.495 5.692851 +186.495 5.660518 +187.495 6.539093 +188.495 5.149898 +189.495 6.084246 +190.495 5.902113 +191.495 6.556249 +192.495 6.47089 +193.495 6.601765 +194.495 6.678838 +195.495 6.475928 +196.495 6.449563 +197.495 6.445582 +198.495 6.458978 +199.495 6.206001 +200.495 3.994532 +201.495 4.649855 +202.495 5.18968 +203.495 3.91944 +204.495 4.550412 +205.495 5.497172 +206.495 4.125317 +207.495 5.070048 +208.495 5.604442 +209.495 5.139417 +210.495 5.413501 +211.495 4.784013 +212.495 3.88686 +213.495 5.543916 +214.495 5.366814 +215.495 4.590774 +216.495 3.515021 +217.495 4.549414 +218.495 4.413313 +219.495 4.365502 +220.495 4.822679 +221.495 4.942861 +222.495 4.184449 +223.495 4.569083 +224.495 5.034656 +225.495 3.760486 +226.495 5.778256 +227.495 4.666387 +228.495 3.87934 +229.495 4.298156 +230.495 3.606369 +231.495 4.043328 +232.495 3.533107 +233.495 4.322265 +234.495 6.460613 +235.495 5.619601 +236.495 5.003014 +237.495 5.240613 +238.495 5.716251 +239.495 6.512721 +240.495 6.360552 +241.495 4.694978 +242.495 4.520795 +243.495 6.517642 +244.495 6.727004 +245.495 6.663968 +246.495 6.741717 +247.495 6.748613 +248.495 6.230022 +249.495 4.738152 +250.495 6.63096 +251.495 5.940607 +252.495 4.742698 +253.495 4.901755 +254.495 5.24829 +255.495 6.601441 +256.495 6.805718 +257.495 6.696987 +258.495 5.814055 +259.495 6.719182 +260.495 5.310413 +261.495 4.917739 +262.495 4.895024 +263.495 4.910364 +264.495 5.474503 +265.495 6.951988 +266.495 5.2517 +267.495 5.347468 +268.495 4.94037 +269.495 5.637509 +270.495 5.592732 +271.495 6.633568 +272.495 5.42893 +273.495 6.134158 +274.495 5.679378 +275.495 5.436838 +276.495 6.490301 +277.495 5.504136 +278.495 4.772426 +279.495 5.005461 +280.495 6.63088 +281.495 6.747831 +282.495 5.150361 +283.495 5.031422 +284.495 4.875282 +285.495 4.702079 +286.495 4.880232 +287.495 4.886068 +288.495 5.34387 +289.495 4.904718 +290.495 6.713236 +291.495 7.771074 +292.495 5.571742 +293.495 5.278872 +294.495 6.742266 +295.495 6.609142 +296.495 5.969145 +297.495 6.306997 +298.495 6.458366 +299.495 5.442104 diff --git a/envir/CMakeLists.txt b/envir/CMakeLists.txt index 9a76923..7ac6f6c 100644 --- a/envir/CMakeLists.txt +++ b/envir/CMakeLists.txt @@ -1,7 +1,8 @@ cmake_minimum_required (VERSION 2.8) -cmake_policy(SET CMP0011 NEW) cmake_policy(SET CMP0003 OLD) +cmake_policy(SET CMP0011 NEW) +cmake_policy(SET CMP0015 NEW) # set project name set (PROJECT envir) @@ -28,4 +29,4 @@ set (LIBRARIES) set (TARGETS "") set (HEADERS "") -add_subdirectory (src) \ No newline at end of file +add_subdirectory (${${PROJECT}_SOURCE_DIR}) \ No newline at end of file diff --git a/envir/README b/envir/README index 922317a..37a064a 100644 --- a/envir/README +++ b/envir/README @@ -1,4 +1,4 @@ -envir - program for search environment for chosen molecule by geometric criterion +envir - program that searchs environment for chosen molecule by geometric criterion Version: 1.0.1 License: GPL diff --git a/envir/about.dox b/envir/about.dox new file mode 100644 index 0000000..4758f00 --- /dev/null +++ b/envir/about.dox @@ -0,0 +1,65 @@ +/*! + * @mainpage envir + * @image latex ./logo.png + * + * @section intro_sec Introduction + * + * About this program: + *
    + *
  • Program that searchs environment for chosen molecule by geometric criterion + *
+ * + * Developer: + *
    + *
  • Evgeniy Alekseev aka arcanis
    + *
+ * License: + *
    + *
  • GPL + *
+ * + * @section How-To-Use How to use + * Usage: + * 
+ * envir -i FILENAME -c X,Y,Z -o FILEMANE [ -n NUM_OF_MOLECULE ] [ -r RADIUS ] 
+ *                                                   [ -l LOGFILE] [ -q ] [ -h ]
+ *
+ * Parametrs:
+ *    -i          - input file with coordinates
+ *    -c          - cell size (float), A
+ *    -o          - output file with coordinates
+ *    -n          - number of molecule for search (integer). Default is 1
+ *    -r          - radius of environment (float). Default is 6.0
+ *    -l          - log enable
+ *    -q          - quiet enable
+ *    -h          - show this help and exit
+ *
+ * + * @page Install + * + * @section Requirements Requirements + * The application statgen requires the following external stuff: + * - cmake >= 2.8 + * - gcc >= 4.8 + * + * @section How-To How to install + * + * @subsection Linux Linux + * @code + * mkdir build && cd build + * cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ../ + * make + * make install + * @endcode + * + * @subsection Windows Windows + * @code + * create project file using 'cmake' + * compile project + * @endcode + * You may also download compiled executable file for Win_x86. + * + * @page Changelog + * V.1.0.1 (2013-07-27) + * * initial release + */ diff --git a/envir/envir.cmake b/envir/envir.cmake index 427f0d4..2b4603e 100644 --- a/envir/envir.cmake +++ b/envir/envir.cmake @@ -1,22 +1,32 @@ # set directories set (${PROJECT}_BINARY_DIR bin) -set (${PROJECT}_SOURCE_DIR src:include) +set (${PROJECT}_SOURCE_DIR src) +set (${PROJECT}_INCLUDE_DIR include) set (${PROJECT}_LIB_DIR lib) -set (CMAKE_INCLUDE_PATH ${${PROJECT}_SOURCE_DIR}) -set (CMAKE_LIBRARY_PATH ${${PROJECT}_LIB_DIR}) +# include_path +include_directories (${${PROJECT}_INCLUDE_DIR}/${PROJECT} + ${${PROJECT}_SOURCE_DIR}) +# library path +link_directories (${${PROJECT}_LIB_DIR}) +# executable path set (EXECUTABLE_OUTPUT_PATH ${${PROJECT}_BINARY_DIR}) + +# verbose set (CMAKE_VERBOSE_MAKEFILE ON) +# flags if ( WITH_DEBUG_MODE ) - ADD_DEFINITIONS ( -DDEBUG_MODE=1 ) + add_definitions ( -DDEBUG_MODE=1 ) endif () - if ( CMAKE_COMPILER_IS_GNUCXX ) set (ADD_CXX_FLAGS "-Wall") set (CMAKE_CXX_FLAGS "-O0 ${ADD_CXX_FLAGS}") set (CMAKE_CXX_FLAGS_DEBUG "-g -O0") set (CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG") +elseif ( MSVC ) + set (ADD_CXX_FLAGS "/W4") + set (CMAKE_CXX_FLAGS "${ADD_CXX_FLAGS}") else () - message (STATUS "Flags not enabled") + message ("Unknown compiler") endif () \ No newline at end of file diff --git a/envir/envir.doxygen b/envir/envir.doxygen new file mode 100644 index 0000000..2e224d0 --- /dev/null +++ b/envir/envir.doxygen @@ -0,0 +1,1889 @@ +# Doxyfile 1.8.4 + +# 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 +# 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 (" ") + +#--------------------------------------------------------------------------- +# 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. + +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. + +PROJECT_NAME = envir + +# 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 = V.1.0.1 + +# 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. + +PROJECT_BRIEF = "Program that searchs environment for chosen molecule by geometric criterion" + +# 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 = /home/arcanis/Documents/github/moldyn/envir/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. + +OUTPUT_DIRECTORY = ./docs + +# 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. + +CREATE_SUBDIRS = 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, Latvian, Lithuanian, Norwegian, Macedonian, +# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, +# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +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. + +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 +# brief descriptions will be completely suppressed. + +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" + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + 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 +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# 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. + +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. + +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. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +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. + +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. + +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.) + +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.) + +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. + +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. + +INHERIT_DOCS = YES + +# 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. + +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. + +TAB_SIZE = 4 + +# 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. + +ALIASES = + +# 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. + +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. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# 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. + +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. + +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. + +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. + +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 +# 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. + +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. + +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 +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +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. + +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. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# 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. + +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. + +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). + +INLINE_GROUPED_CLASSES = NO + +# 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 (the default), structs, classes, and unions are shown on a separate +# page (for HTML and Man pages) or section (for LaTeX and RTF). + +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 +# 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 +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# 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. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# 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 respectively EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +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. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +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. + +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. + +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. + +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. + +HIDE_UNDOC_MEMBERS = NO + +# 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. + +HIDE_UNDOC_CLASSES = NO + +# 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. + +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. + +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. + +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 +# 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. + +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. + +HIDE_SCOPE_NAMES = YES + +# 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. + +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. + +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. + +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. + +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. + +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. + +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. + +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. +# 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. + +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. + +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. + +GENERATE_TODOLIST = YES + +# 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. + +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. + +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. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if section-label ... \endif +# and \cond section-label ... \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. + +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. + +SHOW_USED_FILES = 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 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. + +SHOW_NAMESPACES = YES + +# 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. + +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. + +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. Do not use +# file names with spaces, bibtex cannot handle them. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# 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. + +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. + +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. + +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. + +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. + +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) + +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. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# 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. + +INPUT = . + +# 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. + +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 = *.c \ + *.dox + +# 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. + +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. + +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. + +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/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# 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 + +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). + +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 = * + +# 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. + +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). + +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. +# 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. + +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). + +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. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MD_FILE_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 reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# 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. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +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. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +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. + +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. + +REFERENCES_LINK_SOURCE = 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. + +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. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# 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. + +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]) + +COLS_IN_ALPHA_INDEX = 5 + +# 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. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +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. + +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. + +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! + +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. + +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 left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is 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 file to +# the output directory. + +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. + +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. + +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. + +HTML_TIMESTAMP = YES + +# 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. + +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. + +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 +# for more information. + +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. + +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. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_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. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +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. + +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 +# written to the html output directory. + +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. + +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). + +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. + +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. + +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. + +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. + +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. + +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 + +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 + +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 + +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. + +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. + +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. + +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. + +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. + +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. + +DISABLE_INDEX = NO + +# 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. + +GENERATE_TREEVIEW = NO + +# 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. + +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. + +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. + +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. + +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. + +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. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and +# SVG. The default value is HTML-CSS, which is slower, but has the best +# compatibility. + +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. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# 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. + +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. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. +# There are two flavours of web server based search depending on the +# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for +# searching and an index file used by the script. When EXTERNAL_SEARCH is +# enabled the indexing and searching needs to be provided by external tools. +# See the manual for details. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain +# the search results. Doxygen ships with an example indexer (doxyindexer) and +# search engine (doxysearch.cgi) which are based on the open source search +# engine library Xapian. See the manual for configuration details. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will returned the search results when EXTERNAL_SEARCH is enabled. +# Doxygen ships with an example search engine (doxysearch) which is based on +# the open source search engine library Xapian. See the manual for configuration +# details. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id +# of to a relative location where the documentation can be found. +# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX 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 `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4 will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images +# or other source files which should be copied to the LaTeX output directory. +# Note that the files will be copied as-is; there are no commands or markers +# available. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF 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 `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = YES + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .1 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files +# that can be used to generate PDF. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in +# front of it. If left blank docbook will be used as the default path. + +DOCBOOK_OUTPUT = docbook + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed +# in the related pages index. If set to NO, only the current project's +# pages will be listed. + +EXTERNAL_PAGES = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = NO + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# manageable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/envir/envir.pdf b/envir/envir.pdf new file mode 100644 index 0000000..6004c1f Binary files /dev/null and b/envir/envir.pdf differ diff --git a/envir/logo.png b/envir/logo.png new file mode 100755 index 0000000..41adc0c Binary files /dev/null and b/envir/logo.png differ diff --git a/envir/src/CMakeLists.txt b/envir/src/CMakeLists.txt index 0f005f6..e3486ad 100644 --- a/envir/src/CMakeLists.txt +++ b/envir/src/CMakeLists.txt @@ -3,59 +3,27 @@ set ("${PROJECT}_VERSION_MINOR" 0) set ("${PROJECT}_VERSION_PATCH" 1) set ("${PROJECT}_VERSION" ${${PROJECT}_VERSION_MAJOR}.${${PROJECT}_VERSION_MINOR}.${${PROJECT}_VERSION_PATCH}) -message (STATUS ${${PROJECT}_VERSION}) +message (STATUS "${PROJECT}: Version ${${PROJECT}_VERSION}") -## set files -# main files -set (MAIN_SOURCES main) -# not public srcs -set (PRIVATE_CLASSES add_main - coords - envir_search - messages - print_struct - set_center) -# headers only files -SET (HEADERS_ONLY) -# public srcs -set (PUBLIC_CLASSES) -# public headers -set (PUBLIC_HEADERS) -# shared libraries +# set files +aux_source_directory (. SOURCES) + +# set library if (CMAKE_COMPILER_IS_GNUCXX) set (ADDITIONAL_LIB m) else () set (ADDITIONAL_LIB) endif() -set (SOURCES) - -# append list -foreach (class ${PRIVATE_CLASSES}) - LIST (APPEND SOURCES ${class}.c) - LIST (APPEND HEADERS ${class}.h) -endforeach () - -foreach (class ${HEADERS_ONLY}) - LIST (APPEND HEADERS ${class}.h) -endforeach () - -foreach (class ${PUBLIC_CLASSES}) - LIST (APPEND SOURCES ${class}.c) - LIST (APPEND HEADERS ../include/${PROJECT}/${class}.h) - LIST (APPEND PUBLIC_HEADERS ../include/${PROJECT}/${class}.h) -endforeach () # message message (STATUS "SOURCES: ${SOURCES}") # link libraries and compile -add_executable (${PROJECT} ${MAIN_SOURCES} ${SOURCES}) +add_executable (${PROJECT} ${SOURCES}) target_link_libraries (${PROJECT} ${ADDITIONAL_LIB}) # install properties -INSTALL (TARGETS ${PROJECT} - DESTINATION bin) +INSTALL (TARGETS ${PROJECT} DESTINATION bin) if (ADD_INCLUDE) - INSTALL (FILES ${PUBLIC_HEADERS} - DESTINATION include/${PROJECT}) + INSTALL (FILES ${PUBLIC_HEADERS} DESTINATION include/${PROJECT}) endif () \ No newline at end of file diff --git a/envir/src/add_main.c b/envir/src/add_main.c index 08011fa..d2da375 100644 --- a/envir/src/add_main.c +++ b/envir/src/add_main.c @@ -1,4 +1,5 @@ -/* Additional library for main.c (envir) +/** + * @file */ #include @@ -6,7 +7,25 @@ #include "messages.h" +/** + * @fn error_checking + */ int error_checking (const float *cell, const char *input, const char *output) +/** + * @brief function that checks errors in input variables + * @code + * error_checking (cell, input, output); + * @endcode + * + * @param cell massive of cell size + * @param input first trajectory step + * @param output last trajectory step + * + * @return 11 - error in 'cell' + * @return 12 - error in 'input' + * @return 13 - error in 'output' + * @return 0 - exit without errors + */ { if ((cell[0] == 0.0) || (cell[1] == 0.0) || (cell[2] == 0.0)) return 11; @@ -19,8 +38,26 @@ int error_checking (const float *cell, const char *input, const char *output) } +/** + * @fn print_message + */ int print_message (const int quiet, FILE *std_output, const int log, FILE *f_log, const int mode, const char *str) +/** + * @brief function that prints message in log and stdout + * @code + * print_message (quiet, stdout, log, f_log, 0, str); + * @endcode + * + * @param quiet status of quiet-mode + * @param std_output stdout + * @param log status of log-mode + * @param f_log log file + * @param mode number of message in "messages.c" + * @param str additional text in message + * + * @return 0 - exit without errors + */ { if ((quiet != 1) && (std_output != stderr)) message (0, mode, str, std_output); @@ -31,8 +68,28 @@ int print_message (const int quiet, FILE *std_output, const int log, FILE *f_log } +/** + * @fn set_defaults + */ int set_defaults (float *cell, char *input, int *log, int *num_of_mol, char *output, int *quiet, float *rad) +/** + * @brief function for set default values of variables + * @code + * set_defaults (cell, &from, input, &log, &max_depth, &num_of_inter, output, &to, + * &type_inter, &quiet); + * @endcode + * + * @param cell massive of cell size + * @param input mask of trajectory files + * @param log status of log-mode + * @param num_of_mol number of molecule + * @param output output file name + * @param quiet status of quiet-mode + * @param rad radius of environment sphere + * + * @return 0 - exit without errors + */ { int i; diff --git a/envir/src/add_main.h b/envir/src/add_main.h index 803a547..785a7b3 100644 --- a/envir/src/add_main.h +++ b/envir/src/add_main.h @@ -1,6 +1,20 @@ +/** + * @file + */ + #ifndef ADD_MAIN_H #define ADD_MAIN_H +/** + * @fn error_checking + */ +/** + * @fn print_message + */ +/** + * @fn set_defaults + */ + int error_checking (const float *, const char *, const char *); int print_message (const int, FILE *, const int, FILE *, const int, const char *); int set_defaults (float *, char *, int *, int *, char *, int *, float *); diff --git a/envir/src/coords.c b/envir/src/coords.c index 636dbf2..e7438cb 100644 --- a/envir/src/coords.c +++ b/envir/src/coords.c @@ -1,52 +1,67 @@ -/* Library for reading coordinates from input file - * - * Usage: - * reading_coords (mode, filename, type_interaction, labels, - * cell, &number_of_molecules, &number_of_atoms, true_label_molecule, - * label_molecule, type_atoms, coords, char_type_atoms) +/** + * @file */ #include #include - +/** + * @fn reading_coords + */ int reading_coords (const int mode, const char *filename, const int type_inter, const int *label_atom, const float *cell, int *num_mol, int *num_atoms, int *true_label_mol, int *label_mol, int *type_atoms, float *coords, char *ch_type_atoms) -/* filename - name of file with coordinates - * type_inter - type interaction (number of molecules for interaction) - * (number of molecules in aglomerate for agl) - * label_atom - types of atom for interaction - * (molecules in aglomerate for agl) - * cell - cell dimension - * num_mol - number of molecules for writing coordinates - * num_atoms - number of atoms for writing coordinates - * true_label_mol - massive of true numbers of molecule for atoms - * label_mol - massive of numbers of molecule for atoms - * type_atoms - massive of atom types for atoms - * coords - massive of coordinates - * ch_type_atoms - massive of char types for atoms +/** + * @brief function that reads coordinates from special file format + * @code + * reading_coords (0, filename, type_inter, label_atom, cell, &num_mol, &num_atoms, + * true_label_mol, label_mol, type_atoms, coords, ch_type_atoms); + * @endcode + * + * @param mode mode of reading; '1' is statgen, '2' is envir or + * frad, '3' is agl + * @param filename input file name + * @param type_inter number of needed atoms + * (number of needed molecules) + * @param label_atom massive of needed atom types + * (massive of needed molecules) + * @param cell massive of cell size + * @param num_mol number of molecules + * @param num_atoms number of atoms + * @param true_label_mol massive of true numbers of molecule for atoms + * @param label_mol massive of numbers of molecule for atoms + * @param type_atoms massive of atom types + * @param coords massive of coordinates + * @param ch_type_atoms massive of char atom types + * + * @return 1 - file $filename does not exist + * @return 2 - unknown mode + * @return 0 - exit without errors */ { char at_symb[32], file_string[256]; int atoms, cur_at_num, cur_at_type, cur_mol, i, j, tr_num_atoms, ref_mol, x, y; float cur_coords[3], *not_tr_coords, ref[3]; FILE *inp; -/* cur_*, at_symb - temp variables - * file_string - temp string variable - * atoms - total number of atoms in system - * tr_num_atoms - number of translated atoms for writing coordinates (m.b. 8*num_atoms) - * ref_mol - number of molecule for reference - * not_tr_coords - not translated coordinates - * ref - coordinates of reference molecule - * inp - file with input data + +/* cur_* temp variables + * at_symb temp variable + * file_string temp string variable + * atoms total number of atoms in system + * tr_num_atoms number of translated atoms (must be 8*num_atoms) + * ref_mol number of molecule for reference in translation + * not_tr_coords massive of not translated coordinates + * ref massive of coordinates of reference molecule + * inp input file */ +/// Work blocks + *num_atoms = 0; *num_mol = 0; -// Reading file +/// 
   reading file
inp = fopen (filename, "r"); if (inp == NULL) return 1; @@ -61,10 +76,11 @@ int reading_coords (const int mode, const char *filename, const int type_inter, sscanf (file_string, "%i%s%f%f%f%i%i", &cur_at_num, at_symb, &cur_coords[0], &cur_coords[1], &cur_coords[2], &cur_at_type, &cur_mol); +// reading variables according to selected mode switch (mode) { case 0: -// for statgen +// mode == 0 (selected atoms) for (j=0; j translation tr_num_atoms = *num_atoms; for (i=0; i<*num_atoms; i++) for (j=0; j<3; j++) coords[3*i+j] = not_tr_coords[3*i+j]; -// Assign initial value to reference coordinates +// assign initial value to reference coordinates ref_mol = label_mol[0]; for (i=0; i<3; i++) ref[i] = coords[3*0+i]; @@ -154,7 +170,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, for (x=0; x<3; x++) { if (ref[x] >= 0.0) -// if xyz >= 0.0 A +// if xyz >= 0.0 A { for (j=0; j<3; j++) if (j == x) @@ -167,7 +183,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, tr_num_atoms++; } else -// if xyz < 0.0 A +// if xyz < 0.0 A { for (j=0; j<3; j++) if (j == x) @@ -186,7 +202,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, for (y=x+1; y<3; y++) { if ((ref[x] >= 0.0) && (ref[y] >= 0.0)) -// if xyz and xyz >= 0.0 A +// if xyz and xyz >= 0.0 A { for (j=0; j<3; j++) if ((j == x) || (j == y)) @@ -200,7 +216,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[x] < 0.0) && (ref[y] < 0.0)) -// if xyz and xyz < 0.0 A +// if xyz and xyz < 0.0 A { for (j=0; j<3; j++) if ((j == x) || (j == y)) @@ -216,7 +232,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, for (y=0; y<3; y++) if ((ref[x] < 0.0) && (ref[y] >= 0.0)) -// if xyz OR xyz >= 0.0 +// if xyz OR xyz >= 0.0 { for (j=0; j<3; j++) { @@ -235,7 +251,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] >= 0.0) && (ref[1] >= 0.0) && (ref[2] >= 0.0)) -// if x and y and z >= 0.0 A +// if x and y and z >= 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] - cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] - cell[1]; @@ -247,7 +263,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] >= 0.0) && (ref[1] >= 0.0) && (ref[2] < 0.0)) -// if x and y >= 0.0 A and z < 0.0 A +// if x and y >= 0.0 A and z < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] - cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] - cell[1]; @@ -259,7 +275,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] >= 0.0) && (ref[1] < 0.0) && (ref[2] >= 0.0)) -// if x and z >= 0.0 A and y < 0.0 A +// if x and z >= 0.0 A and y < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] - cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] + cell[1]; @@ -271,7 +287,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] < 0.0) && (ref[1] >= 0.0) && (ref[2] >= 0.0)) -// if y and z >= 0.0 A and x < 0.0 A +// if y and z >= 0.0 A and x < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] + cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] - cell[1]; @@ -283,7 +299,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] < 0.0) && (ref[1] < 0.0) && (ref[2] >= 0.0)) -// if x and y < 0.0 A and z >= 0.0 A +// if x and y < 0.0 A and z >= 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] + cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] + cell[1]; @@ -295,7 +311,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] < 0.0) && (ref[1] >= 0.0) && (ref[2] < 0.0)) -// if x and z < 0.0 A and y >= 0.0 A +// if x and z < 0.0 A and y >= 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] + cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] - cell[1]; @@ -307,7 +323,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] >= 0.0) && (ref[1] < 0.0) && (ref[2] < 0.0)) -// if x >= 0.0 A and y and z < 0.0 A +// if x >= 0.0 A and y and z < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] - cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] + cell[1]; @@ -319,7 +335,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } if ((ref[0] < 0.0) && (ref[1] < 0.0) && (ref[2] < 0.0)) -// if x and y and z < 0.0 A +// if x and y and z < 0.0 A { coords[3*tr_num_atoms+0] = not_tr_coords[3*i+0] + cell[0]; coords[3*tr_num_atoms+1] = not_tr_coords[3*i+1] + cell[1]; @@ -331,7 +347,7 @@ int reading_coords (const int mode, const char *filename, const int type_inter, } } -// free memory +/// 
   free memory
free (not_tr_coords); return 0; diff --git a/envir/src/coords.h b/envir/src/coords.h index c1d9160..6bdf48e 100644 --- a/envir/src/coords.h +++ b/envir/src/coords.h @@ -1,6 +1,14 @@ +/** + * @file + */ + #ifndef COORDS_H #define COORDS_H +/** + * @fn reading_coords + */ + int reading_coords (const int, const char *, const int, const int *, const float *, int *, int *, int *, int *, int *, float *, char *); diff --git a/envir/src/envir_search.c b/envir/src/envir_search.c index b61d0f7..82d0fde 100644 --- a/envir/src/envir_search.c +++ b/envir/src/envir_search.c @@ -1,3 +1,7 @@ +/** + * @file + */ + /* Library for search environment * * Usage: @@ -8,19 +12,32 @@ #include +/** + * @fn search_envir + */ int search_envir (const int num_of_mol, const int num_mol, const float *centr_coords, const double rad, int *needed_mol, int *num_needed_mol) -/* num_of_mol - number of molecule for search - * num_mol - number of molecules for writing coordinates - * centr_coords - massive of centered coordinates - * rad - criterion - * needed_mol - massive of needed molecules - * num_needed_mol - number of needed molecules +/** + * @brief function that searchs environment + * @code + * search_envir (number_of_molecule, num_mol, centr_coords, rad, needed_mol, + * &num_needed_mol); + * @endcode + * + * @param num_of_mol number of molecule + * @param num_mol number of molecules + * @param centr_coords massive of centered coordinates + * @param rad radius of environment sphere + * @param needed_mol massive of number of needed molecules + * @param num_needed_mol number of needed molecules + * + * @return 0 - exit without errors */ { float r; int i; -/* r - radius + +/* r radius */ *num_needed_mol = 0; diff --git a/envir/src/envir_search.h b/envir/src/envir_search.h index 80ef7fd..f40ae77 100644 --- a/envir/src/envir_search.h +++ b/envir/src/envir_search.h @@ -1,6 +1,14 @@ +/** + * @file + */ + #ifndef ENVIR_SEARCH_H #define ENVIR_SEARCH_H +/** + * @fn search_envir + */ + int search_envir (const int, const int, const float *, const double, int *, int *); #endif /* ENVIR_SEARCH_H */ \ No newline at end of file diff --git a/envir/src/main.c b/envir/src/main.c index 9c45ca0..db2475d 100644 --- a/envir/src/main.c +++ b/envir/src/main.c @@ -1,3 +1,7 @@ +/** + * @file + */ + #include #include #include @@ -11,7 +15,16 @@ #include "set_center.h" +/** + * @fn main + */ int main(int argc, char *argv[]) +/** + * @return 1 - error in error_checking + * @return 2 - input file does not exist + * @return 3 - memory error + * @return 0 - exit without errors + */ { char tmp_str[2048]; int error, i, j, *tmp_int; @@ -21,25 +34,26 @@ int main(int argc, char *argv[]) float cell[3], *centr_coords, *coords, rad; int *label_mol, log, num_atoms, num_mol, num_needed_mol, num_of_mol, *needed_mol, quiet, *true_label_mol; -/* ch_type_atoms - massive of char types for atoms - * input - input file name - * logfile - log file name - * output - output file name + +/* ch_type_atoms massive of char atom types + * input input file name + * logfile log file name + * output output file name * - * cell - cell dimension - * centr_coords - massive of coordinates of center molecules - * coords - massive of coordinates - * rad - criterion + * cell massive of cell size + * centr_coords massive of centered coordinates + * coords massive of coordinates + * rad radius of environment sphere * - * label_mol - massive of numbers of molecule for atoms - * log - status of log-mode - * num_atoms - number of atoms for writing coordinates - * num_mol - number of molecules for writing coordinates - * num_needed_mol - number of needed molecules - * num_of_mol - number of molecule for search - * needed_mol - massive of needed molecules - * quiet - status of quiet-mode - * true_label_mol - massive of true numbers of molecule for atoms + * label_mol massive of numbers of molecule for atoms + * log status of log-mode + * num_atoms number of atoms + * num_mol number of molecules + * num_needed_mol number of needed molecules + * num_of_mol number of molecule + * needed_mol massive of number of needed molecules + * quiet status of quiet-mode + * true_label_mol massive of true numbers of molecule for atoms */ set_defaults (cell, input, &log, &num_of_mol, output, &quiet, &rad); @@ -68,44 +82,44 @@ int main(int argc, char *argv[]) return 0; } else if ((argv[i][0] == '-') && (argv[i][1] == 'i')) -// input file +// input file { strcpy (input, argv[i+1]); i++; } else if ((argv[i][0] == '-') && (argv[i][1] == 'c')) -// cell size +// cell size { sscanf (argv[i+1], "%f,%f,%f", &cell[0], &cell[1], &cell[2]); i++; } else if ((argv[i][0] == '-') && (argv[i][1] == 'o')) -// output file +// output file { strcpy (output, argv[i+1]); i++; } else if ((argv[i][0] == '-') && (argv[i][1] == 'n')) -// number of molecule +// number of molecule { sscanf (argv[i+1], "%i", &num_of_mol); i++; } else if ((argv[i][0] == '-') && (argv[i][1] == 'r')) -// radius of environment +// radius of environment { sscanf (argv[i+1], "%f", &rad); i++; } else if ((argv[i][0] == '-') && (argv[i][1] == 'l')) -// log mode +// log mode { log = 1; strcpy (logfile, argv[i+1]); i++; } else if ((argv[i][0] == '-') && (argv[i][1] == 'q')) -// quiet mode +// quiet mode { quiet = 1; } @@ -127,14 +141,14 @@ int main(int argc, char *argv[]) print_message (quiet, stdout, log, f_log, 2, argv[0]); -// processing -// initial variables +// processing +// initial variables print_message (quiet, stdout, log, f_log, 3, input); f_inp = fopen (input, "r"); if (f_inp == NULL) { print_message (quiet, stderr, log, f_log, 18, input); - return 1; + return 2; } fscanf (f_inp, "%i", &num_atoms); fclose (f_inp); @@ -143,7 +157,7 @@ int main(int argc, char *argv[]) label_mol = (int *) malloc (8 * num_atoms * sizeof (int)); tmp_int = (int *) malloc (8 * num_atoms * sizeof (int)); true_label_mol = (int *) malloc (num_atoms * sizeof (int)); -// error checking +// error checking if ((ch_type_atoms == NULL) || (coords == NULL) || (label_mol == NULL) || @@ -151,7 +165,7 @@ int main(int argc, char *argv[]) (true_label_mol == NULL)) { print_message (quiet, stderr, log, f_log, 19, argv[0]); - return 17; + return 3; } sprintf (tmp_str, "%6cInput file: '%s';\n%6cOutput file: '%s';\n%6cLog: %i;\n\ %6cQuiet: %i;\n%6cCell size: %.4f, %.4f, %.4f;\n%6cSelect molecule: %i;\n\ @@ -161,7 +175,7 @@ int main(int argc, char *argv[]) print_message (quiet, stdout, log, f_log, 6, argv[0]); -// reading coordinates +// reading coordinates print_message (quiet, stdout, log, f_log, 7, input); error = reading_coords (1, input, tmp_int, tmp_int, cell, &num_mol, &num_atoms, true_label_mol, label_mol, tmp_int, coords, ch_type_atoms); @@ -173,15 +187,15 @@ int main(int argc, char *argv[]) ' ', num_mol, ' ', num_atoms); print_message (quiet, stdout, log, f_log, 8, tmp_str); } -// error checking +// error checking if ((centr_coords == NULL) || (needed_mol == NULL)) { print_message (quiet, stderr, log, f_log, 19, argv[0]); - return 17; + return 3; } -// analyze +// analyze if (error == 0) { error = set_center (num_atoms, num_mol, label_mol, coords, centr_coords); @@ -203,7 +217,7 @@ int main(int argc, char *argv[]) print_message (quiet, stdout, log, f_log, 13, argv[0]); print_message (quiet, stdout, log, f_log, 15, argv[0]); -// free memory +// free memory free (ch_type_atoms); free (centr_coords); free (coords); diff --git a/envir/src/messages.c b/envir/src/messages.c index f4560f3..58c8795 100644 --- a/envir/src/messages.c +++ b/envir/src/messages.c @@ -1,16 +1,27 @@ -/* Library for printing messages at output - * - * Usage: - * message (log, mode, text, output) +/** + * @file */ #include #include +/** + * @fn message + */ int message (const int log, const int mode, const char *text, FILE *output) -/* mode - number of message - * text - additional text +/** + * @brief function that prints messages to output + * @code + * message (log, mode, text, output); + * @endcode + * + * @param log equal to 1 if print to logfile + * @param mode number of message + * @param text additional text + * @param output output file (may be stdout) + * + * @return 0 - exit without errors */ { char out[4096]; @@ -18,6 +29,7 @@ int message (const int log, const int mode, const char *text, FILE *output) if (log == 1) { char time_str[256]; + time_t t = time (NULL); struct tm* aTm = localtime (&t); sprintf (time_str, "[%04d-%02d-%02d %02d:%02d:%02d] [%2i]: ", aTm->tm_year+1900, diff --git a/envir/src/messages.h b/envir/src/messages.h index 4a500fa..6e6ed21 100644 --- a/envir/src/messages.h +++ b/envir/src/messages.h @@ -1,6 +1,14 @@ +/** + * @file + */ + #ifndef MESSAGES_H #define MESSAGES_H +/** + * @fn message + */ + int message (const int, const int, const char *, FILE *); #endif /* MESSAGES_H */ \ No newline at end of file diff --git a/envir/src/print_struct.c b/envir/src/print_struct.c index c1e6487..529698a 100644 --- a/envir/src/print_struct.c +++ b/envir/src/print_struct.c @@ -1,3 +1,7 @@ +/** + * @file + */ + /* Library for printing structure to pdb file * * Usage: @@ -8,23 +12,37 @@ #include +/** + * @fn print_structure + */ int print_structure (const char *output, const int num_needed_mol, const int *needed_mol, const int num_atoms, const int *label_mol, const char *ch_type_atoms, const float *coords) -/* output - output file name - * num_needed_mol - number of needed molecules - * needed_mol - massive of needed molecules - * num_atoms - number of atoms - * label_mol - massive of numbers of molecule for atoms - * ch_type_atoms - massive of char types for atoms - * coords - massive of coordinates +/** + * @brief function that prints structure to pdb file + * @code + * print_structure (output, num_needed_mol, needed_mol, num_atoms, label_mol, + * char_type_atoms, coords); + * @endcode + * + * @param output output file name + * @param num_needed_mol number of needed molecules + * @param needed_mol massive of number of needed molecules + * @param num_atoms number of atoms + * @param label_mol massive of numbers of molecule for atoms + * @param ch_type_atoms massive of char atom types + * @param coords massive of coordinates + * + * @return 0 - exit without errors */ { int cur_atom, cur_atom_num, cur_mol, i, j; FILE *f_out; -/* cur_atom - current atom - * cur_atom_num - true atom number - * cur_mol - current molecule + +/* cur_atom current atom + * cur_atom_num true atom number + * cur_mol current molecule + * f_out output file */ cur_atom = 1; diff --git a/envir/src/print_struct.h b/envir/src/print_struct.h index 075f60d..ad60ea8 100644 --- a/envir/src/print_struct.h +++ b/envir/src/print_struct.h @@ -1,6 +1,14 @@ +/** + * @file + */ + #ifndef PRINT_STRUCTURE_H #define PRINT_STRUCTURE_H +/** + * @fn print_structure + */ + int print_structure (const char *, const int, const int *, const int, const int *, const char *, const float *); diff --git a/envir/src/set_center.c b/envir/src/set_center.c index 32cf861..eed84f0 100644 --- a/envir/src/set_center.c +++ b/envir/src/set_center.c @@ -1,3 +1,7 @@ +/** + * @file + */ + /* Library for search center mass of molecules * * Usage: @@ -6,18 +10,30 @@ */ +/** + * @fn set_center + */ int set_center (const int num_atoms, const int num_mol, const int *label_mol, const float *coords, float *centr_coords) -/* num_atoms - number of atoms for writing coordinates - * num_mol - number of molecules for writing coordinates - * label_mol - massive of numbers of molecule for atoms - * coords - massive of coordinates - * coords - massive of coordinates of center molecules +/** + * @brief function that searchs center mass of molecules + * @code + * set_center (num_of_atoms, num_of_molecules, label_molecules, coords, centr_coords); + * @endcode + * + * @param num_atoms number of atoms + * @param num_mol number of molecules + * @param label_mol massive of numbers of molecule for atoms + * @param coords massive of coordinates + * @param centr_coords massive of centered coordinates + * + * @return 0 - exit without errors */ { int at_in_mol, cur_mol, i, j, k; -/* at_int_mol - number of atoms in molecule - * cur_mol - current molecule + +/* at_int_mol number of atoms in molecule + * cur_mol current molecule */ for (i=0; i<8*num_mol; i++) diff --git a/envir/src/set_center.h b/envir/src/set_center.h index 63a2377..73de6f7 100644 --- a/envir/src/set_center.h +++ b/envir/src/set_center.h @@ -1,6 +1,14 @@ +/** + * @file + */ + #ifndef SET_CENTER_H #define SET_CENTER_H +/** + * @fn set_center + */ + int set_center (const int, const int, const int *, const float *, float *); #endif /* SET_CENTER_H */ \ No newline at end of file diff --git a/statgen/README b/statgen/README index 524d3ea..135a81b 100644 --- a/statgen/README +++ b/statgen/README @@ -1,4 +1,4 @@ -statgen - program for analyze molecular dynamic trajectories +statgen - program that analyzes molecular dynamic trajectories using topological analysis Version: 1.0.1 License: GPL diff --git a/statgen/about.dox b/statgen/about.dox index 9310bbf..f130996 100644 --- a/statgen/about.dox +++ b/statgen/about.dox @@ -1,6 +1,13 @@ -/*! @mainpage statgen +/*! + * @mainpage statgen + * @image latex ./logo.png * * @section intro_sec Introduction + * + * About this program: + *
    + *
  • Program that analyzes molecular dynamic trajectories using topological analysis + *
* * Developer: *
    diff --git a/statgen/src/add_main.c b/statgen/src/add_main.c index 2f4a311..e714674 100644 --- a/statgen/src/add_main.c +++ b/statgen/src/add_main.c @@ -119,6 +119,7 @@ int printing_head (const char *output, const int log, const int quiet, return 0; } + /** * @fn print_message */ @@ -139,7 +140,7 @@ int print_message (const int quiet, FILE *std_output, const int log, FILE *f_log * * @return 0 - exit without errors */ -{ +{ if ((quiet != 1) && (std_output != stderr)) message (0, mode, str, std_output); if (log == 1) diff --git a/statgen/src/coords.c b/statgen/src/coords.c index ede5f54..e7438cb 100644 --- a/statgen/src/coords.c +++ b/statgen/src/coords.c @@ -15,9 +15,8 @@ int reading_coords (const int mode, const char *filename, const int type_inter, /** * @brief function that reads coordinates from special file format * @code - * reading_coords (0, filename, type_inter, label_atom, cell, &num_mol, - * &num_atoms, true_label_mol, label_mol, type_atoms, - * coords, ch_type_atoms); + * reading_coords (0, filename, type_inter, label_atom, cell, &num_mol, &num_atoms, + * true_label_mol, label_mol, type_atoms, coords, ch_type_atoms); * @endcode * * @param mode mode of reading; '1' is statgen, '2' is envir or diff --git a/statgen/src/graph.c b/statgen/src/graph.c index 6140238..327e238 100644 --- a/statgen/src/graph.c +++ b/statgen/src/graph.c @@ -23,6 +23,7 @@ int check_cycle (const int N, const int *pn) */ { int cycle, i; + /* cycle number of cycle */ @@ -58,6 +59,7 @@ int check_cycle_size (const int N, const int *matrix, const int depth, int *n_cy */ { int cur_N, cycle, i, j, k, n, p, *vertex; + /* cur_N current number of elements in submatrix * cycle if (cycle == 1) that cycle exist * n number of samples @@ -147,6 +149,7 @@ int graph_analyze (const int N, const int *matrix, const int max_depth, int *iso */ { int depth, i, j, *n_cycle, p, *pn; + /* depth depth of search for check_cycle_size * n_cycle number of cycle * p current weight diff --git a/statgen/src/main.c b/statgen/src/main.c index b69bb98..47781db 100644 --- a/statgen/src/main.c +++ b/statgen/src/main.c @@ -18,7 +18,16 @@ #include "summary_stat.h" +/** + * @fn main + */ int main (int argc, char *argv[]) +/** + * @return 1 - error in error_checking + * @return 2 - input file does not exist + * @return 3 - memory error + * @return 0 - exit without errors + */ { char filename[256], tmp_str[2048]; int error, i, index, j, k, label[2]; @@ -30,6 +39,7 @@ int main (int argc, char *argv[]) int *agl, *connect, from, *label_atom, *label_mol, log, max_depth, num_atoms, num_mol, *num_mol_agl, num_of_inter, *stat, *stat_all, step, to, *true_label_mol, *type_agl, *type_atoms, type_inter, quiet; + /* input mask of trajectory files * logfile log file name * output output file name @@ -232,7 +242,7 @@ int main (int argc, char *argv[]) if (f_inp == NULL) { print_message (quiet, stderr, log, f_log, 18, filename); - return 1; + return 2; } fscanf (f_inp, "%i", &num_atoms); fclose (f_inp); @@ -260,7 +270,7 @@ int main (int argc, char *argv[]) (stat_all == NULL)) { print_message (quiet, stderr, log, f_log, 19, argv[0]); - return 17; + return 3; } // set type_agl to zero for (i=0; i