From 1af938251fd0c43973e6644cc9ef92a80604539a Mon Sep 17 00:00:00 2001
From: asl <asl@opencascade.com>
Date: Thu, 11 Jun 2015 08:44:45 +0300
Subject: [PATCH] draft documentation

---
 .gitignore                                    |    3 +
 doc/salome/gui/HYDRO/HYDROGUI.doxygen         | 1719 +++++++++++++++++
 doc/salome/gui/HYDRO/create_polyline.html     |   10 -
 doc/salome/gui/HYDRO/create_profile.html      |   10 -
 .../gui/HYDRO/generate_HYDROGUI_doc.bat       |    3 +
 .../gui/HYDRO/images/immersible_zone_dlg.png  |  Bin 0 -> 8467 bytes
 .../images/immersible_zone_with_hole.png      |  Bin 0 -> 3401 bytes
 .../HYDRO/images/simple_immersible_zone.png   |  Bin 0 -> 1857 bytes
 doc/salome/gui/HYDRO/immersible_zone.h        |   30 +
 doc/salome/gui/HYDRO/mainpage.h               |   34 +
 10 files changed, 1789 insertions(+), 20 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 doc/salome/gui/HYDRO/HYDROGUI.doxygen
 delete mode 100644 doc/salome/gui/HYDRO/create_polyline.html
 delete mode 100644 doc/salome/gui/HYDRO/create_profile.html
 create mode 100644 doc/salome/gui/HYDRO/generate_HYDROGUI_doc.bat
 create mode 100644 doc/salome/gui/HYDRO/images/immersible_zone_dlg.png
 create mode 100644 doc/salome/gui/HYDRO/images/immersible_zone_with_hole.png
 create mode 100644 doc/salome/gui/HYDRO/images/simple_immersible_zone.png
 create mode 100644 doc/salome/gui/HYDRO/immersible_zone.h
 create mode 100644 doc/salome/gui/HYDRO/mainpage.h

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000..88d6704e
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+html
+latex
+documentation.log
diff --git a/doc/salome/gui/HYDRO/HYDROGUI.doxygen b/doc/salome/gui/HYDRO/HYDROGUI.doxygen
new file mode 100644
index 00000000..f07f517e
--- /dev/null
+++ b/doc/salome/gui/HYDRO/HYDROGUI.doxygen
@@ -0,0 +1,1719 @@
+# Doxyfile 1.7.3
+
+# 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 a sequence of words surrounded 
+# by quotes) that should identify the project.
+
+PROJECT_NAME           = HYDROGUI
+
+# 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         = 1.4
+
+# 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          = "HYDROGUI module"
+
+# 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           = 
+
+# 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       = 
+
+# 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, 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.
+
+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               = 8
+
+# This tag can be used to specify a number of aliases that acts 
+# as commands in the documentation. An alias has the form "name=value". 
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
+# put the command \sideeffect (or @sideeffect) in the documentation, which 
+# will result in a user-defined paragraph with heading "Side Effects:". 
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES                = 
+
+# 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  = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
+# sources only. Doxygen will then generate output that is more tailored for 
+# Java. For instance, namespaces will be presented as packages, qualified 
+# scopes will look different, etc.
+
+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 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 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 SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
+# determine which symbols to keep in memory and which to flush to disk. 
+# When the cache is full, less often used symbols will be written to disk. 
+# For small to medium size projects (<1000 input files) the default value is 
+# probably good enough. For larger projects a too small cache size can cause 
+# doxygen to be busy swapping symbols to and from disk most of the time 
+# causing a significant performance penalty. 
+# If the system has enough physical memory increasing the cache will improve the 
+# performance by keeping more symbols in memory. Note that the value works on 
+# a logarithmic scale so increasing the size by one will roughly double the 
+# memory usage. The cache size is given by this formula: 
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE      = 0
+
+#---------------------------------------------------------------------------
+# 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 and 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_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       = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
+# will put a list of the files that are included by a file in the documentation 
+# of that file.
+
+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 sectionname ... \endif.
+
+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
+
+# If the sources in your project are distributed over multiple directories 
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES       = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
+# This will remove the Files entry from the Quick Index and from the 
+# Folder Tree View (if specified). The default is YES.
+
+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 <command> <input-file>, where <command> is the value of 
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
+# provided by doxygen. Whatever the program writes to standard output 
+# is used as the file version. 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. The 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            = 
+
+#---------------------------------------------------------------------------
+# 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 \
+                         *.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
+
+# 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              = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should 
+# 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.
+
+EXCLUDE                = 
+
+# The EXCLUDE_SYMLINKS tag can be used 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             = ./images
+
+# 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 <filter> <input-file>, where <filter> 
+# is the value of the INPUT_FILTER tag, and <input-file> 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.
+
+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 = 
+
+#---------------------------------------------------------------------------
+# 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 and C++ 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.
+
+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 the tag is left blank doxygen 
+# will generate a default style sheet. Note that doxygen will try to copy 
+# the style sheet file to the HTML output directory, so don't put your own 
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET        = 
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 
+# Doxygen will adjust the colors in the stylesheet and background images 
+# according to this color. Hue is specified as an angle on a colorwheel, 
+# see http://en.wikipedia.org/wiki/Hue for more information. 
+# For instance the value 0 represents red, 60 is yellow, 120 is green, 
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 
+# 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_ALIGN_MEMBERS tag is set to YES, the members of classes, 
+# files or namespaces will be aligned in HTML using tables. If set to 
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS     = 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. For this to work a browser that supports 
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS  = NO
+
+# 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 
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS  = 
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 
+# project's 
+# filter section matches. 
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 
+# Qt Help Project / Filter Attributes</a>.
+
+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 at 
+# top of each HTML page. The value NO (the default) enables the index and 
+# the value YES disables it.
+
+DISABLE_INDEX          = NO
+
+# This 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
+
+# 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.
+
+GENERATE_TREEVIEW      = YES
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES       = NO
+
+# 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 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 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.org site, so you can quickly see the result without installing 
+# MathJax, but it is strongly recommended to install a local copy of MathJax 
+# before deployment.
+
+MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
+
+# 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 PHP enabled web server instead of at the web client 
+# using Javascript. Doxygen will generate the search PHP script and index 
+# file to put on the web server. The advantage of the server 
+# based approach is that it scales better to large projects and allows 
+# full text search. The disadvantages are that it is more difficult to setup 
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH    = NO
+
+#---------------------------------------------------------------------------
+# 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 a4wide 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           = 
+
+# 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
+
+#---------------------------------------------------------------------------
+# 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 stylesheet 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           = NO
+
+# 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          = .3
+
+# 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 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 
+# in the INCLUDE_PATH (see below) will be search if 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. 
+# Optionally an initial location of the external documentation 
+# can be added for each tagfile. 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. If a location is present for each tag, the installdox tool 
+# does not have to be run to correct the links. 
+# 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
+
+# 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         = YES
+
+# 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 write a font called Helvetica to the output 
+# directory and reference it in 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 output directory to look for the 
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
+# different font using DOT_FONTNAME you can set the path where dot 
+# can find it using this tag.
+
+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 
+# 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 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, SHOW_DIRECTORIES 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 png, svg, gif or svg. 
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT       = png
+
+# 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/doc/salome/gui/HYDRO/create_polyline.html b/doc/salome/gui/HYDRO/create_polyline.html
deleted file mode 100644
index 1e178460..00000000
--- a/doc/salome/gui/HYDRO/create_polyline.html
+++ /dev/null
@@ -1,10 +0,0 @@
-<!-- HTML header for doxygen 1.8.3.1-->
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<head></head>
-<title>Create polyline</title>
-<body>
-
-<p>Create Polyline help page</p>
-
-</body>
-</html>
diff --git a/doc/salome/gui/HYDRO/create_profile.html b/doc/salome/gui/HYDRO/create_profile.html
deleted file mode 100644
index 1a53ce8e..00000000
--- a/doc/salome/gui/HYDRO/create_profile.html
+++ /dev/null
@@ -1,10 +0,0 @@
-<!-- HTML header for doxygen 1.8.3.1-->
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<head></head>
-<title>Create profile</title>
-<body>
-
-<p>Create Profile help page</p>
-
-</body>
-</html>
diff --git a/doc/salome/gui/HYDRO/generate_HYDROGUI_doc.bat b/doc/salome/gui/HYDRO/generate_HYDROGUI_doc.bat
new file mode 100644
index 00000000..7cbbb4c1
--- /dev/null
+++ b/doc/salome/gui/HYDRO/generate_HYDROGUI_doc.bat
@@ -0,0 +1,3 @@
+
+echo Generating documentation...
+doxygen.exe HYDROGUI.doxygen 2> documentation.log
diff --git a/doc/salome/gui/HYDRO/images/immersible_zone_dlg.png b/doc/salome/gui/HYDRO/images/immersible_zone_dlg.png
new file mode 100644
index 0000000000000000000000000000000000000000..73951191e93d1450cb6a13a5f2d7d35eabfb10b3
GIT binary patch
literal 8467
zcmbu_byQr>mmu(mB@nD}g1Zw4kl^091$PJ#+=9CVcY-?v2*Du)_awMmaA^XK(-0c>
z?R;nEw==u5d(NKyqviFfe)YP#?yb+c^`hUX%3(hvdj<diwt_rZ0|1a55buAXBO{*q
z2@<3bFGy}0a#BFeIK>{~0M%MjMG^q&5;5=0&=AKM@8$K~005`w?*nPTx$GSP(3B~F
zCAGXwV5<RIgu40sf9%%IYP~(x-XodP(aEat9K<<z+N6-G6KcI-PS{vV8mkF$VMZbv
z?9G(0P8JmI$_+lnqJR6E7MC<dg+e#}t(I0Q6R$KMuh6sCsB-ab3ghEPRBj0vZ;y}X
zI*pB2jaS`0JlNMSQ-r*atNon$Z35gXEBAOB7YrBx(wNb5EA?k_)w5r`2G7aoRl0BQ
zkHOeLM0&T<b-Q!-y^humuPbzrUM_K$a(ZpbN$7O(`4j+1kNoP+^F7^GQQw;=Q!iHK
zE0`1x3m<G1&m+JFxEn<HwhFuNE=|EQ$qzTR4+g0#_w%L?v0Vv%Zz=M|y|GRbBff(6
zS{8oTjn#^@?2EP<CkK8#*<5YKjfx4(uyfmXukO6sCn!3S4qp8!caEBE8u&-vH*#6C
z^*{~x``73pg6^ArcJ-tQF*qC!?kjI=yBXo?{`@lxgCG!c;g?AJFa;u}Tg_<Wx?fJt
zs#Wzrn4Ty|^`d}eUMUZ-4~Y3&<r>YxrVW+y8y<TFmp@5B-~)TB;svY~qcnFf0Fg<>
z-%E}5MRWxL0u(svE<9Pvrv4{rL`-V=cah=`lFy~`w(hZx*H@*aS-^Bf#cDABSuIaH
zCEtdRU0d(6_Ga^#i;HXL9=wOXs3_qR3^)q)UF0tDB@8QS%LafgHkiny0`mROHTPDn
z@34L^NUV7`dJZMpL)LnkuTPeBi`6QIkvwQjaG@vAJn0o7ff02)jb8OB$%hwuDGD)B
z$+3Z5v6?yF?H$p1*%P0e<`y+aC$1iT17XONJEEPU!?M~jSg+Ebj*Dr%!EHU;QPTP{
zNlQo_mQkMM$to=m?mdw{XVu?Rz++SJxvh1~Qb9}krQ>Yi1zS4jtS{TdRP)j^tTFDM
zGlzNKgm1b|Y>EdQN~FgN8MRv#&lON5W;XU&sU&fDh()sOl5=N)%d4w+Q`G3vM8$4C
zYSe64+`vAaOYAcT-Ic24?At`iJ)I}`xWCNYH0U-A312o5hxAo(!Y>0m`?8bGjg=sE
zm8XrqGc%ZwJKlr7{D%+k)@;ga*W(|81OQqIId5k*F2{zhPw~{JYu?msWs#F}i;F{{
zveCE|8pYEe4A9BxRTLFd*$p_J+jdO;(vvgm5n|dVGT0}}(X&|EKDgC6{SmE@0u|Th
zi?k`Ce-oJ5yQqI?1GUWl+F6-HbbGLV@FA61tye4B=eEYtrIC%}0D4UC(l}25du-pW
zd9hHSO`BLcp8iurCwZEO!|^sTYUkKNSy|P#e#G&^<9i@vp1xQrpJeR=OMrmM)(fMS
zPaJw>654gr{mb+V;`Uo_U~-1#g0!^xua)u+{-kHeq{%ujN&o!*h*IL%WC<go{ASOW
zFRS>?Kkjzj3w}gKOe;d)*1oj$`uY7knW0GGi=GdD8Ln&UTj69r5@i!A=(TW1ICRJ#
zTME(3xyhO;Z8G1`xwvvoI}>{$c=IvNJ^82Zal;9kyrzP`l*N~opX25oKDZbu4^%8J
z=VD#Wff{?KYcJ{2pHjVChg!prvUe`69le@bIS1Ncjz!QO%G=-HJC!=${khoNQ?otY
z?Wu(NCHkug#{PDZ*0v*TPfHtwEvs#3D3ok(6gP(#_suAke7j>Vm*1qsS@XReYE5s0
zSG>>>(a8O%J*H@!2b+#*tzs@5hvijiKQDRJ+xJS4eF&|Ht-h36@9Ef6b72{^W;w4M
zZPwXWgW|z8J-5qOUY`%oFOA)`i4INw^oxtrR2=1z?`sf$t~0K%#$RXvXeH%ZZu&5t
zhbzfD5`707sFjO(5)&cA-dSX}89ZTN_1w6JfuQ5Sw-y^^QymJ~7sGY9ZgMjTCO6DM
zIq94t@2UJ?)uEeI)W%Gg0uN*d+(KR>>`GSf4>Rdp1#@#|$9q|V7HbXPO669q=Hoge
zzt-@~L$zEd2{JBQGxlt(w*rN2MEU3MlFzQ}onJACiN(OuKW{l3!|#r4ingYIOcm#+
zM+W`Lyfuj*+KOh_^S0DC%<1)dd6shfeO7<-!@|sQkU{WAbycCOlVi!nk&~d%juWjB
z*4Frw*`I<ChbMsacrP@1K#hVV?SW&|WDw%;#a>=`?E;58Ocaq@d*pCp6@$`68he?#
zVaD@_Tz7>g5?pAv4^gFjX&zRF8vKZyUqj0Q{-X{6pxniJt9sCnNPHxT_dL8j`cW%h
zkboj2K!TZ=ZoZ~Ha0nNW;JWs*27r)o5E38_q66NdOQ8Z-l2Je~Ejk{+jY^9QM9_eN
z@1QVrfE0gJSf|->l}RylCZY(t2o;Ff!@*PhC=*K(J-ps<$?um$4-^)0fmtM7(|4kV
z-!|Q@t`6b_f1JdlOQmU52zpps!UY?@J`YDZ*6WWM{-km1$?1yvT_AuqxtqyUYp`S~
z_bg(xr`;{I!}@qtx3Tz{AoAOfU6s5&#!iPfdk0^>!S570mh4pW1(F=+bk^Qm%)@hy
z+lRe3!Pe|2`{jRLg)Q}gN>2J~a<|&|t2<nL?y<9HwTb=3KWa*v{dgOcM7mxxLqeyn
zs{7y=kTujM8iZW?x;wLSCHS@1iJ@*8>-4*uhQsgR9c-KCk@$*y&bfpYlANvA%rM$9
za%%C9)hkC{Te3cJE3-acCYp-`7UDX?v;G=ExSyri@u29zcx0u#CoU&N(3-L`d5(u1
zMSLB3k9mG!XWL~hd`Kp3h1LtTCYT}T?7JLTct@QftMKKw_Rey-A*0omkr%@skFu+f
zZG{WujCHmzZzW7v<eHpT+1P;ft(*9RBB+conD6Oi5>q5PWeRcmL-xTZcj5KC$c71!
zI^-LFA6tT3)-lMIP4zua{orpR`KYTv8n5wVOrSx<_q~Q+WdFUTU_dEvXJ=<*EQbfX
zUC;w6QC@$X-y7GnXvLkr*H0_Y1Su4YD_3?t>ijZk_1Aas%YRPqwcZd(@ghOZCX@bB
zT>rI7R%A<C#V|hCZ2%1s1A4IJjTCgQaAO6NE5In-cSL1>H1{Tk5?1BC`}Q7}XVgV&
z-^{E1oyz{VHtUmxaBWwG!dIW~H_&Vsl~00ydH*gF`7-eP{e@PBpD&}y#iN9jj1L+<
z>USDrT6jj@<FV-8*@0WHHm=XIcUVHdoM{Ec;|+z5@vN?Xdz|H<muPcI*D=&W+gRuP
zkmWjSMYB+l!D+FQ%e`tNQG4ZO;Qk(tFeIRTV0KpfC<VL-K^b}<KtjXd-oYegb0W^S
zR;T#qi*_(@9i##_jRFlP{dj2SMeP<t0kwc4(F-XGYoBL5?-1JMd(B5D2_Tc)fM`YJ
zp0FZ*^$Rl$JfOuZ3?4uS095~b*u0Z4&9iN6jKK$1Sj)Gy)LqGXGrU>BN7Oz+VXQwt
z%eW&4PqKP<t@nsh$HdI6<0LI4)#2fBfa&P=aM^|}vvyH|!qdZS>qvvBxH$6XLvVUJ
zp6T;65->A>o)_f1T@Yaq)!Wx6BdhKThS#dAtBXjM(Fh?)>{jX3nU{sj`%8)3idYhp
zrP9Hv$B|8lk<eQimD0mF!3&Z3>8kMSsR}bm+GK7vS~i1+<C}IhYonW?9q|Ir9eH>6
zvpk%niOOwJUzeWwWh;g0sq?z0I{}T3O$$9`7i$4>uY0#U=reSVsA$wMo<tv39sY@s
z&$-HdSHgHm%VT#|mYGRv5Z$}7aF6TOhWX;rT-BW~9R1Z=U)taR+GPOWV-Wjx6x)op
z;O#9X<B_9R<bD=bE;Cwa-%6|7c|=r=Jw<w(?~uj{gPk2A%LxVsT!-$$YyO?(yjI4a
z{=<Ezas_STY{g!d9U87X1FXDmu&jnv=E5_Eo8j^6Q+vBP2y>2MfaStV?W|S}Q7<Qt
z#sZw)MR&-JMaKthgYLkZdYQ%Aqje5BImM*-qEMTnPbqZ8TSfg))f)Zih4O3V)Y97g
zpF0gsU#f(!VF?^2qXyYGI>p`Nz)|mq(#Ubl65E^uhS+&Lh?e<U!B$7N*6lOPAj5Le
zP=3Xd83M9Yc&$(57jvcdmTs+f&(}k=bgm3^AyNz)VoA|)SH@F))OEN%%^5i{RAd)P
z8Z`onN`wZjnFjY>0yir^Pq#c<VRt`wQYD4yO};c`J2Z)J(2#GgNybE_D^1}|kDubU
zCwjqVvyBF8l9)?Gt=z6L7k?GGds4*d37pPn=yP41T@KC&<7~t3(45cstGP08k8Q_p
z@%%`Gzek~{;jSJx$uDa#cd8dxF}}0SsXZp}@=#FDW_V;(s;fzx@W8jWE@83UpIqzf
z=YKU<@~))bEZQeLy-n6M7LQZhznCTEUeN48Lx?Qa$7iEwx-~YhibX-O*eWujb9TGr
zl=*8@h>FjwANhh)a<lvq3xTEzi;as`s{xTu&a;kz5r37VY5k<zhiL;J5f5Tsg{)Y(
z!*LKpes}##pO{6@wQ<FJwSzD9=50f%Ml8|Clr#<@-Xl6o_4>D%Mx_i=nlHs)szZ1x
zOdU(CED6=ph5L0fM|A~HD~zX#2dlnu1(>>Ln*46f$Sh@uO(yP6siXt%cX+EhrKrD+
zO2&OCs23&<d^dCbZfpk^#Pg%$nD=FEh&i~C%#6#C&njjni*Sk*U5OGKFUO73EfRWC
zPo$42UbGq&`cajI>c!}}7*-$rJN=W~JLQ@LkT0PD1?%Asf=$vv6Z$BIYXSvq5_+fv
zbcFPk&DJne^`(CMRbyB(V~<A?)Av_01`#DSxwSUgium6|RFi(j;8gF=d-L!??KxiY
zk*`LdMvo`1HJ7V}M0F3X(ub7^v+uBH-}sF`YwmQ==#FIqibF8*i0O%jvqRICIq!r<
zPA?Q#9WTDaX&jYSKTq#D{EG2BxDajw4OJDPMff{$9~-saeA+f@FAsHpbMScMGi}nu
ze|=x#Igz34ueSEJWb#XH3P@-{JFk&ierm!^r%bI+xmKm_X^RyS`m{vQz<y?(MFciE
zF##p7L(5&-@XMD|Q&T;WxTVtIGn8P^%bYQ@fC6+Z2KYG%*L_|DQW%-kyGad`8;{Tw
zl9ri&WyI&ZTvbl1ZQ5GEdIG6N0W&gyf>bjONRZP0hbcn-10GQqvsrlbvQf`~V1~W+
zUQ7TakURdrGUVf16TQ_Yj~o_kEAp7vQTPDqCt(CPh&fFd*g_ZAAcryu0BPyJ1hU@z
zk3fJ>_b_xuc_#zt@O6$j0ru!G5}Xc;=j?1={abBmr{WXBx5E}iPV%tj#z8!Q{w!QR
zu>Vi)*?8kcfhg@#wyA1O?t5>qBLVepf)}%G;!le!Jhf=$fRHc8`=ft;PcgB^tkz0q
z3ivGTDa~(f#2b&KFsr8W+gH{z4%m$q61V<nM|riy0nv8eiXS;}#&Xt93)iV6?R(m2
zFk>pt+1adE-Ud7OeX|o*gJbgS8D>PkQXk+I-UW(|;X5%r#nerpyyCOmKxKR7?0+ZG
zq_Uz=Z?V;HWmi02Fqbo@xtZ=hhU1#}ZCrWHhRx6Xa6qxu;0QE(XYLf)7*1wbMcK-w
zVR%FAS*of;nKR>8J0DuZcOvZ3CS+5XhVF_=Bk-TlV$-8}X_=GfHIb^nU+d_(Dv@H(
z7VSLR(j{2k&a~{n^*O{wS3p>P^_4!_^hE%C?D&`E{+oP<;%^#n;$2k^f@*!KboNNL
z(8Z>SBvJ|zm1lAA#*p0OhG>hjFqJi3LP`=yY)d}j(dAPjKf~KWXX;aoPZk2-9j4Xo
zeAiT4I}lb`@QT!x1scNOygGij6gWdu^9Qi^F8)$Ixg#01MqU2j9LSD0=kzO44iIj5
z&!yC%98T282mWi7;{3Tslf_Kyi$9&mB6>GQ9;G(tVW>#x*<GMkkIDhs^NSVubl^!y
zgM$@Y?VAEjl4YMCi~8*-X%xc_6|QQvy(8tkZu{(>gT}Z-iN<=2Poiz_kG1*N+RpRb
z6uF4Dh~z=RpZ2hlj(we!0wB@FYK;Gmjd{r!;eIvIRkPAfomu^QlmnM`xwH4|mkLF9
zyGm)BrUgB+)%z^hi{Aw7VwCbk&pWk;$P;ajw8eKJ-C9{^Hxv(_DsR~Aw{VUSKKV{V
zSsM*9xWFy(s>1KECHiDa+vP*FH8^>-`aHz600|wudmJn$C}qma!|Uzw(aymJ90H)y
zaWqds1$oM75l|sa2O$Of$+18X;kJ(SUj+Y8v^_bP&C)TfWI>XUFUi)F8M3u8*(d=;
z$H%|AMj&D(rN*c=IW3KmO=v9h<>tQ;WfD8-uTby^pPy+P(-aYW7cH->XXoYB)N;>$
zWj`lMNJqaZD=Q0z|B8xxhqhI@i~3$o=&|(FZF>}tD9>gc(ZI#UB}tu-oRI8=y85p$
z&<DSzEMDvBX+H6QuR*8VW9^Yr3|+N8W78v*s?OQJZ=g02QoRS3Nk`e?;TqRLs8?o{
zOEw7uLYQ4wG9QBk0k2`^0)Kcf7R<1sca3@k(=_0oh|7C$d>F?tszt0yOTMn@aOBkG
zjc-6(#ixebeGvDvB-DYSJI0LDhd=NX^{G_Ksi~S;6I!^B_O{w*Q_4|luKhO3MNrOZ
z0z>u6{dtpq5ysnKJFzK|fE#yp7rBGW;o;#%`}wsN7iqp$!w&DdHPF;K+2?Rbpyb*<
zQyTFv_gKm{#+o&28c6{`R%JXUPgw#LLHy@L1eDUtUn`x*yT#M-Gn$e&dm{QKiKScd
ziB!T7pT@@LU2bd7c^84**#&=8h&2=R)zt~Y9&dhhi?K~vcpvpeIDT?Oxa{KG&Z*&G
zo1g#QYm$8z^Lg|TtD`3#oeCpDNe=9`8`!EUeHca2=~Vg^qlIk89L@8Dr@zO?<0b@&
z2x;+B8Q`&Wh}uB}w!O*YeSp&A8RuzfHB4!anq1a=mmxCY(c+-{k-Fg++Q!;b*6}%j
z{a|N*OL`7x-@|nkS|-n$Oa;6RE=H8Mn$_HjjUg*{{XtJVL$H&M=x>)blDF!!{;J3S
zX}SG*vP>Rfa%#G*?Qtr38%$%)0hUtGG<`qh-%@gf{n99_zHiBibuIxfaQr9NK$+`1
zlQCF2wx)R|t0q+vosEZ-4dXZK^RK2N4$aX4a^g$2CQTpHN*%lfop<Eqwsg9Sl*bo=
zCp<zgMCM3_W!sOA6hDvC={&{2*q&B6zr7MQCp+K>zw1kCz*1U%pm$<TeyQMOV`np=
zczJ>x1En}JSeeXa?FceADJ-d(nm6ywi11e=<*7B`1LZU{-2J{3-zU^IXIIu~%WE%N
zLgHR1Cm~VTOi7LRT<sW=0<V@GaU{+$@6LmB`MVB|G&<L$UeYM4Mi1ea$ZJ}(*Lp;8
zA$UTimo8M^sYI!KFVMh5XMRlQNkAUixxzsf?X!0mvQcupqr+mG<n`u=(VjJv#sDb-
zIN#W~3qSp(VPMc!Xe0fQ?Jtz4-{7t8>)W<Cnt;1h`LAB_Q<$Rh_nIneA>7gR^$dO`
z4_Gdk99>Wh<&68>)aJo+C(&lc{;&`O>$rC>hARW(pFXQL{L)^8_7?pO*9#kAzl*9_
zyOLMvjOdSv3l6XCE_Ye`56lF>3xdkVK8*()z4V;;GxbXccex`r8WZ}->kmS)?YMAe
zH3daQGEv{N!6bS)LW=a{K==ju&i2Vn>dGl@j^hrjs8Ts033~TLF{vUH_w+Q&XJ^>H
z4)lRmrn6;zIcs8E3s$DVjNa&dR;Us;-{T!6Z)=E%8dd93D)!H9_a?DV3}QbkD^9oK
zsE;i=tsYs>@-UTNBnExz)6><RpRLsGzJrfEmdlrJW1yAh?yzWUb0)Agv1PrP+z>G<
zq;oDNb-BP~kupL-dLoo~js{s;TDo|!;!*>#`5kWMkk-mwLF$%_Q;f43oRy*=JBxPq
zl)Rp!U(I?JELTZA_1T$ZAEaMQ!llkIjja35pi((yETdbV9Y)BZqxqtKvhh@mY$kzM
zm*RKO=7Ol043F@GpEp*#t8JC_1f#e0a}ffPKSMbAI%p-|zQJ#<n0Kw%N@cOd+dM~i
zj$+t`&0KzC0m7tAzxH~I{v@XZ-s?trga?{;P@&@m)5=$|pAl@HllD@hef2odQAYyO
zii+sy<pw(8K8U6RD`S<s05|min@nu~My9ZYBTykKVsa&wVX^rI)sqM!gIsT<!tfca
zeG<yBq}m~?@f1ktoRqXu7|A)rt*#H-6JV73&+x=rkr%`HFXpRrAAQyqb*VI;nal0&
z7PMZ#44~)|=zD%<9^T6CVGRzY_Zu=@l!1GvjgMDr@xPb!b_Pj3XrX5lx!p`bAG^Mw
zaC0M;(Z6tFGoVQ9iB!wZ5glWw;P>QI%NI~ztE$#=Zv4_6XyEIt%`>}DW?{MC*<&~Y
z{(wEY=n?ubsNYq&Hhjxb+bv1ZGAvc8EfSX5a}ILAuY45=tAOV&B5FNI2-j#K9H;ep
zh#_kM`>K_F04MX?4D*|EpUusu-yGq_T#j=IY2-P@)6EN2tcOmShSQ5>Hwn=jbC2iC
zkT!gxG_i^4DU~2u8RMhWolmL-=^j?_=gO99arb(xy8QKl>SJ8no_dQ6|CETz$L?vx
zs`;x+nZH_w?u?S{#yvp{Dn40lbnif4Y;t>1Q4zM<YKG$rk9LStOk>|^jTa(q$3LIv
zFZG!JTMODphPkKZD1K|pU+r#d7ihPKb<IZqqbyIh!8{|&>}rukS<8}1h_v_kXf~gE
z!g{Cy67ugIdd)^@up2<>>Ker|z*bls&=#=z%H@!lS#KX|)g-jb5BAm|Tq>}B>R)8|
z{t7{^Gv$~xGR85`Nv1yet>>R->=J;~_4CTk0GvqZE`e7WjYYrc;6Y^UCIQ(tLR(w#
ztrW`{@0@9U(P3>WUbhdM8?|IFI5Gug58sywl_Tmvnr1SbV_Z$56O-Iyk$-aaQSkp6
z`N3*KQJnJTo%D^(&~tH8lAr^f+dj<cZ&~FXNjF9<3*(p_^}eZ<6#Sx_QupC;doHf=
zo&u>^+FSW1(HWZ7+rM-V-=3}sX^D86r5R28qfcasYNhJZNCHwa)=~cRZaK!-zcb`*
z3}<z(FL;EsHq$$Aq#|v&j!4DN-6QkJG_BQ2#>o@Ess}($==F@PDEkxf<%D1@tDE~!
zw*TZZDsyeQp^1eaJ8@K(oJEz{1U81hGuc}uY*Jr>1ybj`wHoyBh}+RR#Zf^E^|L~F
zOrjP9>4<S<VCWV;?Yo`WcF4$w+#gUU5_1-ASX<rQU`c?af}V;D<K1K@W&NlOm9dbf
zM~n%&S!+DgMA8p53}jI5S41^+MOf-u3=aTs|C>7N?!N==`^R)URU*dHNh1W%eD=%h
zi;&;T3GPx?usj*Ih<dc6aaSQ7yfe$?esw+>O~CA}U;CWb%D-htTHWO*qY3HZjc8zp
z57vn(c32GtN|tyBLCi$Qq*~m(v~JX7eQyM8+*$H&`IK~{n{06VC0JM6?R2-evZA&8
zRzBcI^3IeTqM0uS`D+K1Ao8#5c&Ezk7Pk3i-nTjYhmUYs(!gr!BcHpV`ZmPA-v8|4
z;;&PJwxClr4v75bt%CYQ?4nyIPbA{1_KDPd*oRT-HH=%|TR#3JZGHW{?og8-5$J|#
zsX|cLr=5+kbcPa~TV)@0_@Ly}*aZF)Kx)(?pwQu8?uh~wYR}L=HT*)6>GUeA>dW5P
zkhT+2lGppO5ENnMp#g`gyJ9Gul4+)LX2hZrM~u!FwO;FVJtzW6fR^+n@F*2Of#_fK
zA31cjUdKP;_@d#_HP{IWPn=bH5aRb<G#Wpo7``zySgE7;Sq&O)lq0qb3|NPhAAYU2
zcN)w+9L=Ulx1+k7;0Bmc>7T5dmYrPp2p10ANG;mT1Nzb2K2NWGh7);w@>)%WCLK(<
zWzP5a@54D2n-_-6<v^?lKOV7A-b-<t0}tV31&F_-;=kiXOB%XgiN%zOi_i?~5=OOf
zLZ|0jMHqPyJ=tf>>tAvX<9$lp|Lv)ExN=L=r>Cc}Wys<4(3!o_qQ2PanVB)Giy)7G
zM?@Kk&e$ch63K;5Y&O)uoV&?`nnLd@xNFYO)42y~PQ~J*l*iSGEb$jU4SAw|b9Rl>
zWMTMWk8%#L$s7I72oa0gzI(qXN3%#%jHzdNe52Re<9d&I!J+v4R=(-vPZP)L{N@3Z
zmI#l^7|sbxuEyaIy$YW{;ypkvD2_BZsIY$r_c(074-GQz@A<_}E=@?Xtgjf?5iwmP
z?~tiP=Ou`B?Wm;hbWvXJGNID%GAoFy8ULsG(~qI4iF*&v=!RP2va+(e6H8-E&ux2J
z1opX2h(?-zM*#{*OvSEY%&9bIv&F`Xh&9(e99@R;wS!k6<_08x0Q5L3@j8*Vts*-|
zj@npzOl5Tday*`EC&;L10QEVWBBE>1`}u!~4y+Z(23iaI6<$&7Kj+%b=KlD166opf
zGWQ>R0Dbt7SUc-+@;9!~jR~Ic1bH(P9z47MdmTo3i)|j2Wx)5zlFNN8r(z7?{yU=y
zfKLB+f8}4bkbgE|rn-c9&3n-i9Qeo(kl~F4AV<zT|6jLc{_9u%5BoO%Z;gT(?y1cZ
XwY@_H_1O_OG5`uPs^A)_w;}%n1xjoW

literal 0
HcmV?d00001

diff --git a/doc/salome/gui/HYDRO/images/immersible_zone_with_hole.png b/doc/salome/gui/HYDRO/images/immersible_zone_with_hole.png
new file mode 100644
index 0000000000000000000000000000000000000000..043aecc326d099217989b6318f1dfc5db4f68e2a
GIT binary patch
literal 3401
zcmXw6c{~&T|DTa-42c$&RLGGl_aaB-D)*S>K66h-xyoFVR(x{iSYJ6BCUYipj0p+l
zUXHSa&#;g)!gu|SKi-e`^YwhcpRf1zc)uR6*JEo-6MkMXUH|~VZ)SSk764!~WHml+
zAd4BV%p7BNY~i*hMu0a%5)78X;b(Z8HKR5i^vB}_%jQ9uI)wuOVCvt-)*DLj1_1cJ
znq4=vf8ffTX4FZ%7r8-?W&b)B%ArYfPvnQFcxG{&6cgOUy_6}^LJm9E{G5Kf*gsHz
zzTFKx17G^_74F0H+V6Pq`IHZ~tf|be!_SOaN41?E$^Cz{x-Ngu{5?qdkAD{R(F)+&
zrP*%cEv@3Ra9VJYk4%cLJ$KtwZnnce_#=D-TYz0X)sAzw=4aXK4xb_;J>*vFh-^v4
z75s*z`FESd5X9oMs0Ka9T}52Y#Cs;HVHw|LG)72;Hnqhc5-u}7gzA939pfV^cx-fW
zq-C`rD~**7s_E;Sooevntsj#!3f(rD3uEDy$VujxbIHggpEuT6lLVT7nC3fq#zxIM
z@znf@l*7Q&MQB>buUVlXBk`4DYHC&_#(3B_e@*3iX&fEhfJuSjwg_jn<*McNj-=mm
z7uzJGypd+nTNWYUx>x!1)rRIBU0f=GNBjC^LK*miXaE>&|Kx5t)iiM`IdlA0Fd8Cd
z&4udDCt|?!tK-6jjWVWge+mOrE;#0*{uL|x3O=YYz}h|&XZviBtuzGeO@iD_6@vv~
z5{=KIog$!36!{EZ7i$-6SWX(>m(NZN`lokiwT&taOgTg%AhNPhDft#9y+3l306&=`
zBVV-j4Q!bG$n6XXk%RjX?8RALA>JWym6@rHH>1-k%0wIDf2v!qTn~oZ%#bl40H>;{
z+C2W?QiZHIT^xJHqH)i6Q-OyA)6|`^8$TMX@VkxF0UEhM@kezGV^eZ7hZN$^zmSZZ
ziwGLEslDs37Z%VuTX-ay*r=C8vY3v5e9UgbNbLBPfW4|max!{`f`&ahUNyqJ>tq@A
zlE0=%xBZn(eI*^%RB|pcLBChyp$^)qcULBuDv`2qpkZ)6)WNzhfb6iU;vfU(E)KS7
zIW~4>*OZ2XhJ!6zj^kX}CoYcjF@itJLwgcR_ob-(wbYUD)G&pdHI<$78XO)W3DBG)
zfnUxY=(U5^b423+AzK$6m|_veeKP0+*b8JkdJnnB|Moe0jof;QXb><9e`<Blwcve-
z5Y-}%(9sjw%r9-0OV{T8!)~(YGh3<1Pp&p^IdH)XTnT*U^@a4~1XMXJDMrv81FxkX
zz(jfO%;MwP0p!YF;JZ#j%Xn?Wi5#cL^Gy0sA~i?e1N+u4++UeAFzKPAktZ&9i(vQE
zVK>W1pMs3c{rRw9iSj@<+I2Sb>9*8^7qw60%B(sDGd)zGS+QO=ZD}*!L{F2*2ddc9
z$_}RtX);~{F)#4%`aZd*I?b+tKPeN-Vh~-f<ye8uZgiiLrmzD=#*3Ytm)8+5;6iHC
zdOYEc>u7r{*9{q_eZAu}KUiwjJ}B&-qHV5T%j+We`U51^f{_{e3sHQw*2Iyi=ad{G
zLg<mL5A`xv3R@9E%;_YILF__((dz8&Ntf4SCm!gPj6N>-S-^A=otT!!wPLn5w4zSU
zg!P(ZRLP6f=j5b+CN-7H!}LopuSb)XkAfudVW+8WJN>{Ke$bl0qDwYZ21m?xXC8L8
zu9!(aD&k68mx|lw)IZ}K_^-ZYfscQ;59-NbEk(S(=ZUFgToE>v6oMo2qhBfvkU3$o
z?}2OFe#0;LUukRso9pq2xwzl*_z&RFjmDCX#0`l=-I<Lv)rv?D>=I<mW5!zRPud%-
z23|3458f{Fvs^%09b$LT#kS40skE>ovAZANoj2vOTjM!E&iW5@N7`9d!tRmE+WC-l
zwUAfrqRq(mG+7e0(sUQ9r1C5FZRxv?BIH~@y>&k^YRN(}Hd~pp0JGM`oq=a_*LdQt
z+U?IdwF4$YX5knsUwgO_de3`VXO&c$Xt#3mCVt+w92RpPIp=WwfrxV6O&D?c`oAbl
zg)I40pmSYBp5-|22))czo-tG(E9_k7@8gzdsX^V?=C!l(!on{|xYej^t82-S>(|cQ
zdfos2cVW+*a4F1fu|694eZ1U~(|#}k-AtJio`HloSNKOZ>qI_i7KHZP4FG~`y&$o~
zt)txEiq7RO3y+@-k8u=w^{VV4A`#hLI+1*d={{JvT%p%Dm4i!5n@>UN{3R74+P&=_
zJ2tB%d6A{`a?pUjdGxWreln<GW!ZS&TUSHM9=pV$ak%t9TosX%r6|^QcK<_XDSWV8
z%dONr3;xFw^bc#|FrxVvI_9sZYU&A1mCrB0yA3d0dCJ_S3lvUH^EJJ}_;0~tH|>m3
zSwimY>}9)nZ_1h`YY$S|{oEwXUuAL$4j>L8EP->6J<^BA1PgsRMo+H9AT)UQup`M(
zeRkIJsxW7F0prs9FTE-0f7K!$Fq|Hr2kY)&SDmAG!#Mxk9aYIkV#0CkF_12B)lKbQ
zZ4y>WcMbLXA{AZfMiXEFt03pwHnrIwHuy{P=UHw)neiZca<g8FMrYkbWuh_PiK@R+
zUF~jbQrcfBhGGA%PjY0`Rfkbza%P=eO`iJr0aq#dOgYQn>Gtu%EVhp6mb%k?gnas*
z(Tf~7jF^^1?b=9A2<97mgaz>t0_bzEIyE_Yhdtch-{w9#sYJ?P9XLR!m6~Z6fQ5q!
zk?OP_6obifJ{m{CRX&v*LG-a~Wwp822iE5kRN*3pjs`5s@A>S4@Gy9CAa}hm_9g>`
zQH2Y@aLKrP?T5_<lCdI_AAqN6A1+~7k92FC0{#?B?p`L<e4j$h0byqp+O}`#CkJkE
zWCplt7sdD6@v%5(>{87wiw$XKcUj@mw`Uja;*?KQ1C+IM^GKOI=Og!);jwCUnu`|A
z6wC5=s)Nl4KNX^;FGhfr<3Ca$u<67i%u`fqnv&*Id0;OT?_xm%RfBscS%FXH$u#S@
zWD<o7@lhi89<FMqS1eS(L~yjO(;`&APpdPTjBXsv>}))#cukS$BLfS<YJGRyVw+HN
z+n-EieGjsu^c{%vlX?nQU=lOOtsA=4FILkJl=Qgrghc)1G@p%_yAb3n7r7^p=d$TE
zSF-JTl7-vTa(ys0)O(`nn1C>axcVN8S_&&Fe>6Y-bJZ<{%y8wA)cjAa;(7#P==<vW
znTZErQ0y$HQ_CSxHN9KRDp7;;?d>#97xw$2Ng8LR7weA_27h^Bm1}$0o!n_^I*D&i
z{Z1lo`1o8C-8<FPP`TB!6vaK`sV-fPNadZ55p8PFgk8<j-~`38AZDw_FY4S(pn;=?
zzLSMP)2<9+OmlVpZf5~5_+RcPQv=P~-^;1Ih<UZTnr|S|o6BG5j0E*BJFZPJd?PC_
z7wD*6-5=t2mQ$E*aQ@fV_Q5KNX-5G;F<8Qn8Roj@{@pqzlz^Yd-;;#goP_GeKh@}5
z24lyW3T+Rsr6)(BCpOhy2Gz)83%ZL|)K*dVg^g1x(3!?&0SfiwMSKNB!~NdFt8AR3
z)!@cXF)iPSC5qaLsvbPgnhI?}$5$(@JP?_Q@9FZa^2F}m4?<$31@0f3@H!iXyN@@%
z*gi`kAVmYBc#m5}9dmF4j(uQ@B`M~3{y|<R%~mpFGrz3k+sE*|8?T45OfUS%zB3nD
z3#@SIixkd@`r$5Q8=fC?c=mGmw}&=W{(a$hL}PZ`<!pro=S467K8$CYW*f(gXS<Sf
zPbWdmB8)-`e6b>+lhc^3so7RV;;l-qx+&}eD;R{0{1hC<6G!Mk@vNN$@10(7)g7H`
zk+sTF$F;?5_u{|F$+K!29T=Fc87~+aItxBct7*Xh+Q9AI$Z$PWujzl3jTCPVSToy6
zpn2X4ByL|1S?j#HdB^KA_zXzlkU84QA4n`ahwKcVq<4u0%3L&mUk=r$RG1o{yP-Q(
zOg-_;qy<11S{<bWmoBmaOA1Om9zNeqxRMFZ5O!(u!-6F63C35|yN94ksI)YmiqEKn
z`^}UvdGJL;Vf$fvSBLI1PPWh9jp#i<FY#!uTf;4SA=6nz;#~_Sal*E81x3FfVTEc&
zI!7<eJIh`-43-n{lpr|RZoi6?dfT@XLc~N|IA57LK5KC$#>CT}M<TN+*Y!wSi-T>%
z6{R#~;{{a`lnLhXD;8^*q_cZlRCWD=XFI@R;|czTh{non*P}~XgB_2Mq7zm78sF#_
zK3?U@sYog9h|Pi}qL*c81!ChK*mOZB5yU^bpTn`~8S~a8-fh|IEVSmjaB2mS2#Tf^
z9kL<L^nOhdIh+$<gjS6}3_HuNJ<5yVZTtfIX|C&o?KSKb#aNh@(CE@o{g14?ze){d
zJH1L8(}XEDUT)j+$QgUHHNxd&Oa4D@5Nr`#|F`6LBI*6V#RqGkY3qBDVg>yEuVcXU
Yi#HDP2Bo)H<qyE@hUN7)M(zp!1-M9u3IG5A

literal 0
HcmV?d00001

diff --git a/doc/salome/gui/HYDRO/images/simple_immersible_zone.png b/doc/salome/gui/HYDRO/images/simple_immersible_zone.png
new file mode 100644
index 0000000000000000000000000000000000000000..5b9d12de52af1ca0e904b9a6010009e3da018963
GIT binary patch
literal 1857
zcmYL~d05if8pm-X!9o+;ye?g9MAXn0Ya-1(F_BbE0hd8cDa+jY6{FoJMYMEKYYYt)
zCudX;aic|YvQcEp%+O4rQB!fd2{~blc+2Xd^US?}yr1))^PcZ}&hxxyDG0#@Y=Bxq
zK_JkEK#X6QuAR_XkFmavMJ4!3U89!~7T^PFmRim0I)+s5U~dqpt;A#{&PdmXq+*B}
zAP}r))$|^v@J@h0V0oaQcQ`F}Vd#`_)X&08Ij(moA+rCfnU8t?{qlnhrk6OgqCR>y
z6FBokI9ytb|M2<t$V+XtW@>^raQKtEiB%)}?r{W#4^|9foLb<lbNc1ONGAat`QB8k
z7|&Em`nEtzMnswwd^AdMK3Fr9OiJRsm@QN)D}}A-wtK<d4tL4B0m|{pyf(q8zDkmL
zI~Um$rT{3mXhuO3mbQdEZ+vLb6`SJL(Fo5_&~D5?8C2VNPuH`-+1F4c7l0zEfK12m
zP%6m@mdV`xZ;RBDeJpG6183#@qZiOQUb^dl>P|)=9&(3VzxtmHLDbh*wEiHKHN$(t
z{`CSgAbx&{;<mNaQk?WLyak61cpB$z4L$ayU=taoGL#QjS^^Y16|_vongS@BRq(s=
z0wF*#RBb!2$fW~Qiz?gwFQOaJi)VHjExm}Ktz77bnaYLa$_=wE@MALbIBpYxTiipc
z?2Sgm^89<!)lZ0s@%l|&g-%Z*5V3W#uAfgsOTH8nCj&|F*Bup_S1sS#+WhjN`=Pow
z1W{dcM?CJ-ii-g?x+I_Fh&m%o^(@>Pabr>c$XVY9QC#}{aq6k$bw?deWO78!cflUl
z$(#yfkLza5o)SoEXfmAND@D7Rh<i^T<%oXT5BvUvMe|`vkTTsI`gnE<owf_<z4IP{
z`_>CVjE+E{cD`hg=5FC;8RSH0<eO=X=<+$^r~MW-4@!0@ZH7X76N}q`Dew?TvX>3;
zjo<GrTH{k5dhyZFR^CZ{b-1_je3(+JU36Zl+h^|65x)F6#w!17DT-c&qHr8x{zcR^
zUZ}^d6z$v4VToK>LczK&VV>V?ye7c2wm0qmi}@<a{1DdowLmjEN`n@c&H2Xn2=K>i
z+TxUo_C<>-r-Yn-FoB!on`nTO7r^V7W}`@X19*-52S-EY4Xad^A6Rs#`ert7ycive
zfc<#X3%D%6KfT%ED{m+>vmtOvJ~T2X38M6-Y3yyp8^aEsd{eKP1l$>K>e2_tgXIkm
z*SK_bq8i|P%(P#q#a%?Q^7Xai&x(zjx^O+au{Io_xA9K`w<Fv5g7~xNj>)|Z`hKE#
zj>-s)72rF)E(eOVRKtrqWH~UnI^1P2j`IId0l?q#$`zuG_3t_mX07u)e=E#RsYU-i
zsd$*ZmhJ|Do0((0DmPn`+hN5oBNxpMmpXbe0!5z!+!+J4(7!{gi!xR-UvXXCo6(<)
zpT1lPP{ubn%(UyarT=ym;@Qdk-$0V-!UB;y;+vJFls=(ZJSgw;&dNflv8jx3eg3bH
z(Xy>;H2={+9Ug>%i8)&qEv$AXT%Os!vTO(IB8DBgvTzmPZ<CzwMa#fP5A~sCpgo6X
zu^fn$rK=iuwMb+G@xqq0t;J=DKCAA(7oDq6!TGoIiCmR;B=s*A@%MI5V9I?$<8=xz
z+zukQ&^Ks0FKS>KvmA74Cu5(k0?y&*uBEDpR*<iboIC~!@a90iL|JCj>|1f0a?<M|
zp6)+PE5WM=Rro}OO*Nf2t6=w|S=;FB=_xdP?8u0(<K8^m>W4u}pCK5UopO`|Y5u0>
zs<T*oY}!!7*4>YpJ#A7$?eoNcGMNJWt(%4S>lN(DpGPbtA#@-KdOf69fQCntqO!q#
zkO_~1jLC75hhfO@m@av&Q@*S`kz;9+)w11}1F5cIb$2vA##8CqlWwiADg=1n*4aLB
z`!NcNcB2gTsmX<^o5al%lcFFKhl{r<uaWFt->&Hg>}mWmqtP=?mpBj`fq$2I7Mb%=
z_rw%vo=y|=ZCcL8rNtnRQ|U;aFM*f>m9xp4RqOW4xI(~wYhh-#HQ;pdox|q5d%Rs|
zxEa5zv98<i&^zC|T>R`1k-fWNk02iDC}Wdj`36yhvP_+(s!*&c=Ou9<_B<cgr96HN
zm449C1)KHEa`;{@JLxc%W+aYOv~5}+SsK^c_)I7@#LMek2Uw?~sr0ndJDF*$5yidS
zXQx3&+9{pGZ1OsN=4lf&KVzL!D1Bpc!17!468P6YoS6x^nSzXUjUyIJ$}MquWE+(*
z+M!%fbxN(zq$Oww3%h=iS~~;t8niVjjFUxpC!E}6Y4$)=Xp+~YU4KA<F=>8hKRjqK
z76KR4N-IMG-9-6wCf~U;)%p49-M{e|9~9qj76xey?&z+UtY_JF!R2km^7W5c-M0q{
M^vC%%`;h7X1+-yy$p8QV

literal 0
HcmV?d00001

diff --git a/doc/salome/gui/HYDRO/immersible_zone.h b/doc/salome/gui/HYDRO/immersible_zone.h
new file mode 100644
index 00000000..788e9ea8
--- /dev/null
+++ b/doc/salome/gui/HYDRO/immersible_zone.h
@@ -0,0 +1,30 @@
+
+/**
+  @file
+  \brief Help for the immersible zone
+*/
+
+/**
+  \page imzone Immersible zone
+
+  The <b>immersible zone</b> is a natural object.
+  In the HYDROGUI module it is the face limited by one polyline.
+  It simulates the zone under the water.
+
+  The immersible zone can be created via the main menu HYDRO => Create immersible zone.
+
+  In the dialog box: 
+
+  \image html immersible_zone_dlg.png "Immersible zone dialog box"
+
+  the user should select the polyline limited the immersible zone and the bathymetry object associated with the immersible zone.
+
+  The immersible zone can be defined on the polyline with one contour, in this case it will be a simple face limited by the contour:
+
+  \image html simple_immersible_zone.png "A simple immersible zone"
+
+  Also the immersible zone can be defined on the polyline with two contours (one inside another),
+  in this case it will be a face limited by external contour with the hole limited by the internal contour.
+
+  \image html immersible_zone_with_hole.png "An immersible zone with a hole"
+*/
diff --git a/doc/salome/gui/HYDRO/mainpage.h b/doc/salome/gui/HYDRO/mainpage.h
new file mode 100644
index 00000000..9e6ec0e3
--- /dev/null
+++ b/doc/salome/gui/HYDRO/mainpage.h
@@ -0,0 +1,34 @@
+
+/**
+  @file
+  \brief Help for the main page of the HYDROGUI module
+*/
+
+/**
+  @mainpage
+
+  The HYDRO GUI project has been developed for a hydrodynamic laboratory in the EDF R&D company
+  in the domain of the landscape modelling (construction of channels, dams, changing the course of the rivers etc).
+  It represents a pre-processor for the geometry modelling of the natural and artificial objects on the landscape.
+  The user starts work with raster maps where he can create analytic curves and regions describing the existing natural objects, 
+  such as banks, coasts, lakes, rivers etc. Also he can create artificial objects (channel, dam) using the algorithms of the geometry modelling.
+  The objects are referenced to the real territory using the geodesic coordinates.
+   Finally the constructed landscape study is prepared for the further meshing and using in the hydrodynamic solvers.
+
+  The HYDRO module is implemented on the base of the SALOME platform and powered by the OpenCascade and SALOME platforms.
+
+  It supports the following features:
+  - raster maps (import from files and georeferencement by geodesic coordinates);
+  - geometry curves (creation on the map and import from SALOME GEOM module);
+  - geometry objects (creation and import from SALOME GEOM module);
+  - support of natural objects (immersible zones, lakes, rivers) and artificial objects (obstacles, channels, dams);
+  - georeferencement of the objects when the objects are connected with points on real territory using the geodesic coordinates;
+  - geometry algorithms on analytic objects (extrusion, partition) for complex objects construction;
+  - support of the results of the territory level measurement (bathymetry);
+  - partition of objects on zones of intersection and specifying the properties for these zones;
+
+  In the perspective the pre-processor can be completed by the post-processor showing the calculated results.
+
+  The HYDROGUI module supports the following objects:
+  - \ref imzone "Immersible zone"
+*/
-- 
2.39.2