From 0b7dc317fad8ce8bbd5422fe196c16f7f630fe64 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Fri, 16 Apr 2010 08:57:04 +0200 Subject: [PATCH] ENH: begin reworking doxygen to use xhtml/css and new OpenCFD look - drop old table-based formatting in favour of div. - use single css with @import to minimize the impact of style changes on the html documents themselves. - separate css/ directory - locate css graphic elements inside the css/ directory for easier relative addressing. --- doc/doxygen/Allwmake | 22 + doc/doxygen/Doxyfile | 1306 +++++++++++++++++ doc/doxygen/OpenFOAMdocIcon.png | Bin 0 -> 1240 bytes doc/doxygen/OpenFOAMicon.png | Bin 0 -> 1199 bytes doc/doxygen/_Footer | 9 + doc/doxygen/_Header | 68 + doc/doxygen/css/doxyLayout.css | 171 +++ doc/doxygen/css/doxyTabs.css | 100 ++ doc/doxygen/css/doxygen.css | 111 ++ doc/doxygen/css/doxygen/doxygen.css | 545 +++++++ doc/doxygen/css/doxygen/tabs.css | 105 ++ doc/doxygen/css/img/OpenCFDlogo.png | Bin 0 -> 11529 bytes doc/doxygen/css/img/bg_bullet_full_1.gif | Bin 0 -> 806 bytes doc/doxygen/css/img/bg_bullet_full_2.gif | Bin 0 -> 50 bytes doc/doxygen/css/img/bg_bullet_half_1.gif | Bin 0 -> 825 bytes doc/doxygen/css/img/bg_bullet_half_2.gif | Bin 0 -> 99 bytes doc/doxygen/css/img/bg_corner_topright.gif | Bin 0 -> 60 bytes .../css/img/bg_head_corner_topleft_25px.gif | Bin 0 -> 391 bytes .../css/img/bg_head_corner_topright_25px.gif | Bin 0 -> 389 bytes 19 files changed, 2437 insertions(+) create mode 100755 doc/doxygen/Allwmake create mode 100644 doc/doxygen/Doxyfile create mode 100644 doc/doxygen/OpenFOAMdocIcon.png create mode 100644 doc/doxygen/OpenFOAMicon.png create mode 100644 doc/doxygen/_Footer create mode 100644 doc/doxygen/_Header create mode 100644 doc/doxygen/css/doxyLayout.css create mode 100644 doc/doxygen/css/doxyTabs.css create mode 100644 doc/doxygen/css/doxygen.css create mode 100644 doc/doxygen/css/doxygen/doxygen.css create mode 100644 doc/doxygen/css/doxygen/tabs.css create mode 100644 doc/doxygen/css/img/OpenCFDlogo.png create mode 100644 doc/doxygen/css/img/bg_bullet_full_1.gif create mode 100644 doc/doxygen/css/img/bg_bullet_full_2.gif create mode 100644 doc/doxygen/css/img/bg_bullet_half_1.gif create mode 100644 doc/doxygen/css/img/bg_bullet_half_2.gif create mode 100644 doc/doxygen/css/img/bg_corner_topright.gif create mode 100644 doc/doxygen/css/img/bg_head_corner_topleft_25px.gif create mode 100644 doc/doxygen/css/img/bg_head_corner_topright_25px.gif diff --git a/doc/doxygen/Allwmake b/doc/doxygen/Allwmake new file mode 100755 index 0000000000..a34eb3fd7e --- /dev/null +++ b/doc/doxygen/Allwmake @@ -0,0 +1,22 @@ +#!/bin/sh +cd ${0%/*} || exit 1 # run from this directory +set -x + +rm -rf latex man + +# remove html directory in background +mv html html-stagedRemove$$ 2> /dev/null +rm -rf html-stagedRemove$$ >/dev/null 2>&1 & + +# ensure that created files are readable by everyone +umask 22 +doxygen + +# fix permissions (NB: '+X' and not '+x'!) +chmod -R a+rX html latex man 2>/dev/null + +echo +echo "Done doxygen" +echo + +# ----------------------------------------------------------------- end-of-file diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile new file mode 100644 index 0000000000..39b5dc6ad9 --- /dev/null +++ b/doc/doxygen/Doxyfile @@ -0,0 +1,1306 @@ +# Doxyfile 1.5.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 = OpenFOAM-$(WM_PROJECT_VERSION) + +# 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 = + +# 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, Finnish, French, German, Greek, Hungarian, +# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, +# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, +# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. + +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 = + +# 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 = $(WM_PROJECT_DIR) + +# 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 is your file systems +# 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 DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = YES + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# 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 + +# 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 make 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 + +# 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 + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 namespace 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 = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = 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 = NO + +# 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_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 + +# 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 define 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 defines 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 = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from the +# version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# 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 + +# This WARN_NO_PARAMDOC option can be abled 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 = $(WM_PROJECT_DIR)/src \ +# $(WM_PROJECT_DIR)/applications/utilities \ +# $(WM_PROJECT_DIR)/applications/solvers + +# limit input for testing purposes +INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global + +# 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++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py + +FILE_PATTERNS = *.H *.C + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# 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 filesystem 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 = */lnInclude/* \ + */t/* + + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the output. +# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, +# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = doxyFilt + +# 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, INPUT_FILTER +# is applied to all files. + +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 + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH +# then you must also enable this option. If you don't then doxygen will produce +# a warning and turn it on anyway + +SOURCE_BROWSER = YES + +# 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 (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# 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 documentstion. + +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 = 4 + +# 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 = $(WM_PROJECT_DIR)/doc/doxygen/_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 = $(WM_PROJECT_DIR)/doc/doxygen/_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 = + +# 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 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 compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. 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_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 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 + +# 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 [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag 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 (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = 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 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# Path for OpenCFD LaTeX macros + +@INCLUDE_PATH = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/ + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# 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. + +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, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# 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 = $(WM_PROJECT_DIR)/doc/Doxygen/Macros/tensorOperator + +# 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 + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 = NO + +# 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. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and 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 = YES + +# 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 is superseded by the HAVE_DOT option below. This is only a +# fallback. 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 = YES + +# 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 = YES + +# 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, SOURCE_BROWSER and HAVE_DOT tags 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 = YES + +# If the CALLER_GRAPH, SOURCE_BROWSER 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 = YES + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will 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, jpg, or gif +# 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 MAX_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 if the number +# of direct children of the root node in a graph is already larger than +# MAX_DOT_GRAPH_NOTES 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 = 3 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# 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 = YES + +# 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 = YES + +# 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 + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = YES diff --git a/doc/doxygen/OpenFOAMdocIcon.png b/doc/doxygen/OpenFOAMdocIcon.png new file mode 100644 index 0000000000000000000000000000000000000000..705a314103c5da2d696e3ab829aac944555f8925 GIT binary patch literal 1240 zcmV;}1Sk86P)Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2igP= z4Fwg-;Glv400dY`L_t(o!{wJZENz;5lL+SU`A)^%-x{&61l|~Bk3UJqYjYe03N`op+(GnWKJbWVaD_l zoVCD-WU_tJyX$>?zZvwK9vo;$1mgrrsLE(W6-A^M7gQC=lONq{tVP$hY&exXdAuEC z>WRm8pN#;(ih8?mNy5D+qDw$T48e)E&dwlECxROk@qP%0ytea*n?novq`%nt)tKao zU#qd+Yu(O!000QNwq;#XIv3G$BO-^6oo?TIpsiTI`o35a=#jUn7a zJof3iQ>M4=im7%3%05-a^Q3TcZDmIgD1waa3W}ro`nC@?jt8QkTY5XcAb?C<+*61U z1j^Xz!DVG7;iOXqWa-f8j+^rV5CrBK)I|_kbfI~3k(~Wf&^QRH$Za=Ngn=$FXi&K^ z=hU0F@-8%Z4510-V9o%VrrI;WM&K`iVdVwh$l*mPRRy&ZD&~E=Ag2_RR14@Kkk{E7 z)7&EfG}W6epgRG4--NEac8L0(NsEXT{AlI;T~&R0pVssoxGF?e5|16dn3?JOrgG0` zwS?-cA_Wzt;VxB0l<}g4k5@&%zF6k?{T-9(&%n3Ir!$fYWkW)P$BiD+9s~{%DGl(O z&Oi864Y-A%%ZSJJ{%Zg)-dBE7M3*Yy0+@7TMc7)?p{l6LtYP!^*Y!v{?Rpi}V<78t zA*#vEsN+phJ)|hsNMY^uWhtj9C{9iDh`IXF5r(9G7@&;J>Km+B)&fVU8F zBBEoiE)JCx`<+=W9~+2`a&NQ+)>IO&er$MfBJH-L%Reoqbx{~2iF+`>7P zc6(IahR+wufa}TA+0Yc^R^Rsd(O`a{Z@gxzgPYr3wFUFS?fdZnQP>w%hV z!CDDC1bi}(4-UkB3a}YC2Bd&a;4rZ5asl}NwZ8$LHOWL#m`Er90000Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2igP= z4FU&t7)K2N00b{dL_t(o!|j(#Y?W0Mg};6N|G$^MXbUYbk<^Blf{%((Fd;?-qb)>( zk%2}d3Z#j^1i?GPM}o+$A(nt50d!Dfj0r(+Ei;3n1Bsd-qC)V20xAkcDk<&lf0ly+ zu{_GXl}b$9vy-z=*2+F>uYC?&=CB^CnJbHs4>9|9&@-t&!ZV9|8p=>t6L14kf5Hm0 zB(M#b9Rl3H=76F zq_wr}jkh*LL{TH?iyj(S(h`p|tVObFOhTBQr3Fb?p87a_CJ4~Frj5s2j~;Hrxmq%* zU1ur)&`=xfS=!>?Hq%ltGe>;nSVu=3%bVd#io$P`iSXDt!p$KP5nUhc_;hsZkzc9^ z!k15j_aFd}@W+;STKQZ|gPob}KXjsP_r7Dr20;{Q^Q`Grs{`khPZdTCGrzuRYt`5L zc5NjHenLEZ;Wh-8yca)i<~9I$ulA;QzfZG6Z7QoDvE09tccallH z|Mx9-c5Xvmuo1CG5@BcsQ)(*P<5(CrvNJBO&lfwmZ{-A_9<=3b@bePru8V&HGvZi` ztr|FJP+79oOMopKQosGidl^vp6rx_i3z5HM@Q6ucHVxpnXATNegW7{GO5+QVf0EMT^DYb^ri%Ya7s;Om-mV> zL$W6o7mPYb_4lp~Mb`pE1@O?tuE||2AqrX-c3Ub8DoqR=S6$i`#~w2)kBQRfUVL^8 z_(h=QWKz5TF@fjr9(>eH%LMosCSPBX3g~z3+kCxUx>OIF?|EJHdn83Ih%@Q*O>GxKuJ-Qs2)|^X=WZH05>Nrso4w~ z4z`#~>ck}{u(CG!JH|SJdEu@dQyvUR2HoZa6QiKwR56KuE + +
+ Copyright © 2000-2010  + OpenCFD Ltd. +
+ + + diff --git a/doc/doxygen/_Header b/doc/doxygen/_Header new file mode 100644 index 0000000000..a11df43510 --- /dev/null +++ b/doc/doxygen/_Header @@ -0,0 +1,68 @@ + + + + + OpenFOAM® programmer's C++ documentation + + + + + + + + +
+
+
+
+
+ +
+

Programmer's C++ documentation

+
+
+
+ +
+ + + + + + + +
+
+
+ +
+ diff --git a/doc/doxygen/css/doxyLayout.css b/doc/doxygen/css/doxyLayout.css new file mode 100644 index 0000000000..4c00546d7d --- /dev/null +++ b/doc/doxygen/css/doxyLayout.css @@ -0,0 +1,171 @@ +/* import doxygen-specific adjustments */ +@import url(doxygen.css); +@import url(doxyTabs.css); + + +*{padding:0; margin:0;} + body { font-size:62.5%; background-color: #ffffff; font-family:arial,sans-serif;} /*Font-size: 1.0em = 10px when browser default size is 16px*/ + + p:after {content:"."; display:block; height:0; /*clear:both*/; visibility:hidden;} + +.clear-contentunit {clear:both; width:100%; height:0.1em; border:none; background:rgb(210,210,210); color:rgb(210,210,210);} + + + +/*page-container **************************************/ +.page-container {width:960px; margin:0px auto; margin-top:10px; margin-bottom:10px; font-size:1.0em;} +.page-container:after, .header:after, .header-bottom:after, .header-breadcrumbs:after, .main:after, .main-navigation:after, .main-content:after, .main-content div:after, .main-subcontent:after {content:"."; display:block; height:0; clear:both; visibility:hidden;} + +/*********************header***************************************************/ +.header {width:960px;} +.header-top {width:954px; height:80px; border-top:solid 3px rgb(175,175,175); border-left:solid 3px rgb(175,175,175); border-right:solid 3px rgb(175,175,175); margin-top:10px; background:#ebebeb; background:#d5e1f0; overflow:visible !important /*Firefox*/; overflow:hidden /*IE6*/;} +.header-bottom {width:954px; border-bottom:solid 3px rgb(175,175,175); border-left:solid 3px rgb(175,175,175); border-right:solid 3px rgb(175,175,175); border-top:solid 1px rgb(175,175,175);background:rgb(225,225,225);} +.header .round-border-topleft {width:25px; height:25px; position:absolute; z-index:100; background:url(img/bg_head_corner_topleft_25px.gif) no-repeat; margin-top:-3px; margin-left:-3px;} +.header .round-border-topright {width:25px; height:25px; position:absolute; z-index:100; background:url(img/bg_head_corner_topright_25px.gif) no-repeat; margin-top:-3px; margin-left:932px;} + +/********************sitelogo *************************************************/ +.sitelogo {width:924px; height:40px; position:absolute; z-index:1; margin:20px 0 0 15px; background:url(img/OpenCFDlogo.png) no-repeat;} + +/**************************sitename ************************************************/ +.sitename {width:400px; height:45px; position:absolute; z-index:1; margin:25px 0 0 320px; overflow:visible !important /*Firefox*/; overflow:hidden /*IE6*/;} +.sitename h1 {font-weight:normal; font-size:240%;} +.sitename h2 {margin:-2px 0 0 0; color:rgb(125,125,125); font-weight:normal; font-size:120%;} +.sitename a{text-decoration:none; color:rgb(125,125,125);color:#333;} +.sitename a:hover {text-decoration:none; color:rgb(125,125,125);} + +/*****************header-breadcrumbs ***************************************/ +.header-breadcrumbs ul {float:left; width:560px; list-style:none; padding:7px 0 0 3px; font-family:verdana,arial,sans-serif;} +.header-breadcrumbs {clear:both; width:954px; padding:1.0em 0 1.5em 0; border-left:solid 3px rgb(175,175,175); border-right:solid 3px rgb(175,175,175);} + +.header-breadcrumbs ul li {display:inline; padding:0 0 0 5px; color:#323232; font-size:100%;} +.header-breadcrumbs ul a {color:rgb(70,122,167); text-decoration:none;} +.header-breadcrumbs ul a:hover {color:rgb(42,90,138); color:#333; text-decoration:underline;} +.header-breadcrumbs .searchform {float:right; width:285px; padding:0 17px 0px 0px !important /*Non-IE6*/; padding:0 12px 0px 0px /*IE6*/;} +.header-breadcrumbs .searchform form fieldset {float:right; border:none;} +.header-breadcrumbs .searchform input.field {width:10.0em; padding:0.2em 0 0.2em 0; border:1px solid rgb(200,200,200); font-family:verdana,arial,sans-serif; font-size:120%; } +.header-breadcrumbs .searchform input.button {width:3.0em; padding:1px !important /*Non-IE6*/; padding:0 /*IE6*/; background:rgb(230,230,230); border:solid 1px rgb(150,150,150); text-align:center; font-family:verdana,arial,sans-serif; color:rgb(150,150,150); font-size:120%;} +.header-breadcrumbs .searchform input.button:hover {cursor:pointer; border:solid 1px rgb(80,80,80); background:rgb(220,220,220); color:rgb(80,80,80);} + + + + +/************** NAV STUFF *****************************/ +.nav0 {width:350px; position:absolute; z-index:2; margin:25px 0 0 0; margin-left:610px !important /*Non-IE6*/; margin-left:613px /*IE6*/;} +.nav0 ul {float:right; padding:0 20px 0 0;} +.nav0 li {display:inline; list-style:none;} +.nav0 li a {padding:0 0 0 3px;} +.nav0 a:hover {text-decoration:none;} +.nav0 a img {height:20px; border:none;} +.nav1 {width:350px; position:absolute; z-index:3; margin:55px 0 0 610px;} +.nav1 ul {float:right; padding:0 15px 0 0; font-weight:normal;} +.nav1 li {display:inline; list-style:none;} +.nav1 li a {display:block; float:left; padding:2px 5px 2px 5px; color:rgb(125,125,125); text-decoration:none; font-size:110%;} +.nav1 a:hover {text-decoration:none; color:rgb(50,50,50);} +.nav1_ln { float:right; height:2.1em; width:300px;} +.nav1_ln ul {float:right; padding:7px 15px 0 0; font-weight:normal;} +.nav1_ln li {display:inline; list-style:none;} +.nav1_ln li a {display:block; float:left; padding:2px 5px 2px 5px; color:rgb(125,125,125); text-decoration:none; font-size:110%;} +.nav1_ln a:hover {text-decoration:none; color:rgb(50,50,50);} +.nav2 {white-space:nowrap /*IE hack*/; float:left; width:954px; background:rgb(225,225,225); color:rgb(100,100,100); font-size:130%; height:2.1em;;} /*Color navigation bar normal mode*/ +.nav2 ul {list-style-type:none;} +.nav2 ul li {float:left; z-index:auto !important /*Non-IE6*/; z-index:1000 /*IE6*/; border-right:solid 1px rgb(175,175,175);} +.nav2 ul li a {float:none !important /*Non-IE6*/; float:left /*IE-6*/; display:block; height:2.1em; line-height:2.1em; padding:0 16px 0 16px; text-decoration:none; font-weight:normal; color: rgb(100,100,100);color:#333;} +.nav2 ul li ul {display:none; border:none;} +.nav2 ul li:hover {position:relative;} /*Sylvain IE hack*/ +.nav2 ul li:hover a {background-color:rgb(215,215,215); text-decoration:none;} /*Color main cells hovering mode*/ +.nav2 ul li:hover ul {display:block; width:12.0em; position:absolute; z-index:999; top:2.0em; margin-top:0.1em; left:0;} +.nav2 ul li:hover ul li a {white-space:normal; display:block; width:12.0em; height:auto; line-height:1.3em; margin-left:-1px; padding:4px 16px 4px 16px; border-left:solid 1px rgb(175,175,175); border-bottom: solid 1px rgb(175,175,175); background-color:rgb(240,240,240); font-weight:normal; color:rgb(100,100,100);color:#333;} /*Color subcells normal mode*/ +.nav2 ul li:hover ul li a:hover {background-color:rgb(215,215,215); text-decoration:none;} /*Color subcells hovering mode*/ +.nav2 table {position:absolute; top:0; left:-1px; border-collapse:collapse;} +.nav2 ul li a:hover {position:relative /*Sylvain IE hack*/; z-index:1000 /*Sylvain IE hack*/; background-color:rgb(215,215,215); text-decoration:none;} /*Color main cells hovering mode*/ +.nav2 ul li a:hover ul {display:block; width:12.0em; position:absolute; z-index:999; top:2.1em; t\op:2.0em; left:0; marg\in-top:0.1em;} +.nav2 ul li a:hover ul li a {white-space:normal; display:block; w\idth:12.0em; height:1px; line-height:1.3em; padding:4px 16px 4px 16px; border-left:solid 1px rgb(175,175,175); border-bottom: solid 1px rgb(175,175,175); background-color:rgb(240,240,240); font-weight:normal; color:rgb(50,50,50);} /*Color subcells normal mode*/ +.nav2 ul li a:hover ul li a:hover {background-color:rgb(215,215,215); text-decoration:none;} /*Color subcells hovering mode*/ + +/*nav3-grid ****************************************/ +.nav3-grid {width:199px; border-bottom:solid 1px rgb(200,200,200);} +.nav3-grid dt a, .nav3-grid dt a:visited {display:block; min-height:2.0em /*Non-IE6*/; height:auto !important; height:2.0em /*IE6*/; line-height:2.0em; padding:0px 10px 0px 20px; border-top: solid 1px rgb(200,200,200); text-decoration:none; color:rgb(70,122,167); font-weight:bold; font-size:100%;} +.nav3-grid dd a, .nav3-grid dd a:visited {display:block; min-height:1.7em /*Non-IE6*/; height:auto !important; height:1.7em /*IE6*/; line-height:1.7em; padding:0px 10px 0px 40px; border:none; font-weight:normal; text-decoration:none; color:rgb(70,122,167); font-size:100%;} +.current, .nav3-grid dt a:hover, .nav3-grid dd a:hover {background-color:rgb(225,225,225); color:rgb(42,90,138); text-decoration:none;} + +/*nav3-nobullet *********************/ +nav3-bullet {width:170px; margin:10px 0 0 20px;} +.nav3-bullet dt a, .nav3-bullet dt a:visited {line-height:2.0em; padding:0 0 0 10px; background:url(img/bg_bullet_full_1.gif) no-repeat 0px 50%; text-decoration:none; color:rgb(70,122,167); font-weight:bold; font-size:120%;} +.nav3-bullet dd a, .nav3-bullet dd a:visited {line-height:1.7em; margin:0 0 0 15px; padding:0 0 0 10px; background:url(img/bg_bullet_half_1.gif) no-repeat 0px 50%; text-decoration:none; color:rgb(70,122,167); font-weight:normal; font-size:120%;} +.nav3-bullet dt a:hover {background:url(img/bg_bullet_full_2.gif) no-repeat 0px 50%; text-decoration:underline; color:rgb(42,90,138);} +.nav3-bullet dd a:hover {background:url(img/bg_bullet_half_2.gif) no-repeat 0px 50%; text-decoration:underline; color:rgb(42,90,138);} +.nav3-nobullet {width:170px; margin:10px 0 0 20px;} +.nav3-nobullet dt a, .nav3-nobullet dt a:visited {line-height:2.0em; text-decoration:none; color:rgb(70,122,167); font-weight:bold; font-size:120%;} +.nav3-nobullet dd a, .nav3-nobullet dd a:visited {line-height:1.7em; margin:0 0 0 15px; text-decoration:none; color:rgb(70,122,167); font-weight:normal; font-size:120%;} +.nav3-nobullet dt a:hover, .nav3-nobullet dd a:hover {text-decoration:underline; color:rgb(42,90,138);} + +/*main-navigation ************************************************/ +.main-navigation .loginform {width:160px; margin:-10px 20px 0 20px;} +.main-navigation .loginform p {clear:both; margin:0; padding:0;} +.main-navigation .loginform fieldset {width:160px; border:none;} +.main-navigation .loginform label.top {float:left; width:125px; margin:0 0 2px 0; font-size:110%;} +.main-navigation .loginform label.right {float:left; width:125px; margin:5px 0 0 0; padding:0 0 0 3px; /*IE6*/; font-size:110%;} +.main-navigation .loginform input.field {width:158px; margin:0 0 5px 0; padding:0.1em 0 0.2em 0 !important /*Non-IE6*/; padding:0.2em 0 0.3em 0 /*IE6*/; border:solid 1px rgb(200,200,200); font-family:verdana,arial,sans-serif; font-size:110%;} +.main-navigation .loginform input.checkbox {float:left; margin:5px 0 0 0 !important /*Non-IE6*/; margin:2px 0 0 -3px /*IE6*/; border:none;} +.main-navigation .loginform input.button {float:left; width:5.0em; margin:10px 0 5px 0; padding:1px; background:rgb(230,230,230); border:solid 1px rgb(150,150,150); text-align:center; font-family:verdana,arial,sans-serif; color:rgb(150,150,150); font-size:110%;} +.main-navigation .loginform input.button:hover {cursor:pointer; border:solid 1px rgb(80,80,80); background:rgb(220,220,220); color:rgb(80,80,80);} +.main-navigation .searchform {width:160px; margin:0 20px 0 20px;} +.main-navigation .searchform p {clear:both; margin:0; padding:0;} +.main-navigation .searchform fieldset {border:none;} +.main-navigation .searchform input.field {float:left; width:158px; padding:0.1em 0 0.2em 0 !important /*Non-IE6*/; padding:0.2em 0 0.3em 0 /*IE6*/; border:1px solid rgb(200,200,200); font-family:verdana,arial,sans-serif; font-size:120%;} +.main-navigation .searchform input.button {float:left; width:3.0em; margin-top: 0.5em; padding:1px; background:rgb(230,230,230); border:solid 1px rgb(150,150,150); text-align:center; font-family:verdana,arial,sans-serif; color:rgb(150,150,150); font-size:120%;} +.main-navigation .searchform input.button:hover {cursor:pointer; border:solid 1px rgb(80,80,80); background:rgb(220,220,220); color:rgb(80,80,80);} +.main-navigation h1.first {clear:both; margin:0px; padding:4px 20px 3px 20px; background-color:rgb(190,190,190); background-color:#89aad6;font-family:"trebuchet ms",arial,sans-serif; color:rgb(255,255,255); font-weight:bold; } +.main-navigation h1 {clear:both; margin:30px 0 20px 0; padding:4px 20px 3px 20px; background:rgb(190,190,190);background:#89aad6; font-family:"trebuchet ms",arial,sans-serif; color:rgb(255,255,255); font-weight:bold; font-size:1.2em;} +.main-navigation h2 {clear:both; margin:20px 10px 10px 20px; font-family:"trebuchet ms",arial,sans-serif; color:rgb(100,100,100); font-weight:bold; font-size:150%;} +.main-navigation h3 {clear:both; margin:10px 10px 5px 20px; color:rgb(80,80,80); font-weight:bold; font-size:110%;} /* Note: h2 not existent, to make identical to formats for main-navigation for easier exchange */ +.main-navigation p {clear:both; margin:0 10px 10px 20px; color:rgb(80,80,80); line-height:1.3em; font-size:110%;} +.main-navigation p.center {text-align:center;} +.main-navigation p.right {text-align:right;} +.main-navigation ul {list-style:none; margin:0.5em 5px 1.0em 5px;} +.main-navigation ul li { margin:5px 0 0.2em 2px; background-image:none; line-height:1.4em; font-size:90%; color:#467aa7; font-weight:normal;} +.main-navigation a, .main-navigation ul li ul li,.main-navigation ul li ul li a, .main-navigation ul li ul li a:visited{color:#333;font-weight:normal;} +.main-navigation ol {margin:0.5em 10px 1.0em 40px !important /*Non-IE6*/; margin:0.5em 10px 1.0em 45px /*IE6*/;} +.main-navigation ol li {list-style-position:outside; margin:0 0 0.4em 0; font-size:110%;} + +.main-navigation {font-size:14px;display:inline /*Fix IE floating margin bug*/; float:left; width:200px; height:100%; overflow:visible !important /*Firefox*/; overflow:hidden /*IE6*/; background:rgb(245,245,245);} + +.main-navigation .round-border-topright {width:10px; height:10px; position:absolute; z-index:10; margin:0 0 0 190px; background:url(img/bg_corner_topright.gif) no-repeat;} + +.main-navigation h2 {margin: 5px 10px 5px 10px;} +.main-navigation h1.first ,.main-navigation h1{ background-color:#89aad6 !important;} +.main-navigation {background-color:#d5e1f0 !important;} + + +/******************footer ************************************************/ +.footer {clear:both; width:954px; padding:1.0em 0 1.0em 0; border-top:solid 3px rgb(175,175,175); border-left:solid 3px rgb(175,175,175); border-right:solid 3px rgb(175,175,175); border-bottom:solid 3px rgb(175,175,175); background:rgb(225,225,225); font-size:1.0em; overflow:visible !important /*Firefox*/; overflow:hidden /*IE6*/;} +.footer p {line-height:1.3em; text-align:center; color:rgb(125,125,125); font-weight:bold; font-size:110%;} +.footer p.credits {font-weight:normal;} +.footer a {text-decoration:underline; color:rgb(125,125,125);} +.footer a:hover {text-decoration:none; color:rgb(0,0,0);} +/*.footer a:visited {color:rgb(0,0,0);}*/ +.footer:after {content:"."; display:block; height:0; clear:both; visibility:hidden;} + +/*******************main **********************************************/ +.main {clear:both; width:954px; padding-bottom:30px; border-left:solid 3px rgb(175,175,175); border-right:solid 3px rgb(175,175,175); background:transparent url(img/bg_main.gif) top left repeat-y;} +.main img {clear:both; margin:3px 10px 7px 0; padding:1px;} +.main img.center {clear:both; float:none; display:block; margin:0 auto; padding:1px;} +.main img.right {clear:both; float:right; margin:3px 0 7px 10px; padding:1px;} + +.main a {color:rgb(70,122,167); font-weight:bold; text-decoration:none;} +.main a:hover {color:rgb(42,90,138); text-decoration:underline;} +/*. main a:visited {color:rgb(42,90,138);} */ +.main a img {border:solid 1px rgb(150,150,150);} +.main a:hover img {border:solid 1px rgb(220,220,220);} + +/********************************/ +/* PRINTING and MISCELLANEOUS */ +/********************************/ +@media print {.header-top {width:954px; height:80px; background:rgb(240,240,240); overflow:visible !important /*Firefox*/; overflow:hidden /*IE6*/;}} +@media print {.header-breadcrumbs {width:954px; background:transparent;}} +@media print {.nav2 {float:left; width:954px; border:none; background:rgb(240,240,240); color:rgb(75,75,75); font-size:1.0em; font-size:130%;}} /*Color navigation bar normal mode*/ +@media print {.main {clear:both; width:954px; padding-bottom:30px; background:transparent;}} +@media print {.main-navigation {display:inline /*Fix IE floating margin bug*/; float:left; width:199px; border-right:solid 1px rgb(200,200,200); border-bottom:solid 1px rgb(200,200,200); background-color:rgb(240,240,240); overflow:visible !important /*Firefox*/; overflow:hidden /*IE*/;}} +@media print {.footer {clear:both; width:954px; height:3.7em; padding:1.1em 0 0; background:rgb(240,240,240); font-size:1.0em; overflow:visible !important /*Firefox*/; overflow:hidden /*IE6*/;}} +@media print {div.crosslinks {visibility:hidden;}} + diff --git a/doc/doxygen/css/doxyTabs.css b/doc/doxygen/css/doxyTabs.css new file mode 100644 index 0000000000..3c567bb529 --- /dev/null +++ b/doc/doxygen/css/doxyTabs.css @@ -0,0 +1,100 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +div.tabs +{ + float : left; + width : 100%; + margin-bottom : 2px; + padding-bottom : 6px; +} + +div.tabs ul +{ + margin : 0px; + padding-left : 0px; + border-right : 1px solid #84B0C7; + list-style : none; +} + +div.tabs li, div.tabs form +{ + display : inline; + margin : 0px; + padding : 0px; +} + +div.tabs form +{ + float : left; + padding : 0px 9px; +} + +div.tabs a +{ + float : left; + font-size : 12px; + font-weight : bold; + text-decoration : none; + border-right : 1px solid #000000; +} + +div.tabs a:hover +{ + background-position: 100% -150px; +} + +div.tabs a:link, div.tabs a:visited, div.tabs a:active, div.tabs a:hover +{ + color : #000000; +} + +div.tabs span +{ + float : left; + display : block; + padding : 0px 9px; + white-space : nowrap; +} + +div.tabs input +{ + float : right; + display : inline; + font-size : 12px; +} + +div.tabs td +{ + font-size : 12px; + font-weight : bold; + text-decoration : none; +} + +/* Commented backslash hack hides rule from IE5-Mac \*/ +div.tabs span { float : none; } +/* End IE5-Mac hack */ + +div.tabs a:hover span +{ + background-position: 0% -150px; +} + +div.tabs li#current a +{ + border-width : 0px; + border-right : 1px solid #000000; + color : #0000ff; +} + +div.tabs li#current span +{ + padding-bottom : 0px; +} + +div.nav +{ + background : none; + border : none; + border-bottom : 1px solid #000000; +} + diff --git a/doc/doxygen/css/doxygen.css b/doc/doxygen/css/doxygen.css new file mode 100644 index 0000000000..116e51ab41 --- /dev/null +++ b/doc/doxygen/css/doxygen.css @@ -0,0 +1,111 @@ +body { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +body { + background: #fff; + color: #000; + margin: 0px; + text-decoration: none; +} + +main { + padding: 10px; +} + +/* @group Heading Levels */ + +/* +h1 { + text-align: center; + font-size: 150%; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} +*/ + +a:link, a:link:hover, a:visited, a:visited:hover { + text-decoration: none; + color: #0000ff; +} + +a:link img { border: 0; } +a:visited img { border: 0; } +a:active img { border: 0; } +a.menuLefton { color: #0000ff; font-size: 12px; font-weight: bold; } +td.leftmenu { font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; background: #ddddff; text-align: left; font-size: 14px; height: 20px; width: 200px; } + +a.menuTopoff { color: #000000; font-size: 14px; } +a.menuTopoff:visited { color: #000000; font-size: 14px; } +a.menuTopoff:hover { color: #0000ff; font-size: 14px; } +td.topmenu { font-family: verdana, arial, helvetica, sans-serif; background: #ddddff; text-align: center; font-size: 16px; width: 150px; font-weight: bold; } + +h1 { font-size: 18px; } +h2 { font-size: 16px; } +h3 { font-size: 14px; } + +/* formatting for member functions: + * Since the OpenFOAM code already has nice line-breaks, wrapping the lines + * just looks terrible. + * Give a slightly different background to make it easier to find. +*/ +.memitem { + padding: 4px; + background-color: #eef3f5; + border-width: 1px; + border-style: solid; + border-color: #dedeee; +} + +.memproto { + background-color: #d5e1e8; + width: 100%; + border-width: 1px; + border-style: solid; + border-color: #84b0c7; + font-weight: bold; +} + +table.memname { + width: 100%; + background: #f7f7ff; + white-space: nowrap; +} + + +.indexkey { + vertical-align: top; + background: #f7f7ff; +} + +.indexvalue { + vertical-align: top; + background: #f7f7ff; +} + +.paramkey { + width: 5%; +} + +.memItemLeft { + background: #f7f7ff; +} + +.memItemRight { + background: #f7f7ff; +} + +.mdescLeft { + margin: 0px; +} + +.mdescRight { + font-style: italic; +} diff --git a/doc/doxygen/css/doxygen/doxygen.css b/doc/doxygen/css/doxygen/doxygen.css new file mode 100644 index 0000000000..d6aaf2804c --- /dev/null +++ b/doc/doxygen/css/doxygen/doxygen.css @@ -0,0 +1,545 @@ +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + text-align: center; + font-size: 150%; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #153788; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #1b77c5; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { + color: #3030f0; +} + +a.codeRef { + color: #3030f0; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} + +td.indexkey { + background-color: #e8eef2; + font-weight: bold; + border: 1px solid #CCCCCC; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #e8eef2; + border: 1px solid #CCCCCC; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #f0f0f0; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} + +th.dirtab { + background: #e8eef2; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #666; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #FAFAFA; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #ccc; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memTemplParams { + color: #606060; + white-space: nowrap; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} + +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.memitem { + padding: 0; + margin-bottom: 10px; +} + +.memname { + white-space: nowrap; + font-weight: bold; + margin-left: 6px; +} + +.memproto { + border-top: 1px solid #84b0c7; + border-left: 1px solid #84b0c7; + border-right: 1px solid #84b0c7; + padding: 0; + background-color: #d5e1e8; + font-weight: bold; + /* firefox specific markup */ + background-image: -moz-linear-gradient(rgba(228, 233, 245, 1.0) 0%, rgba(193, 205, 232, 1.0) 100%); + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 8px; + -moz-border-radius-topleft: 8px; + /* webkit specific markup */ + background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, from(rgba(228, 233, 245, 1.0)), to(rgba(193, 205, 232, 1.0))); + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 8px; + -webkit-border-top-left-radius: 8px; + +} + +.memdoc { + border-bottom: 1px solid #84b0c7; + border-left: 1px solid #84b0c7; + border-right: 1px solid #84b0c7; + padding: 2px 5px; + background-color: #eef3f5; + border-top-width: 0; + /* firefox specific markup */ + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0.5em; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +address { + font-style: normal; + color: #333; +} + +table.doxtable { + border-collapse:collapse; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #153788; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #254798; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; +} + diff --git a/doc/doxygen/css/doxygen/tabs.css b/doc/doxygen/css/doxygen/tabs.css new file mode 100644 index 0000000000..a444163416 --- /dev/null +++ b/doc/doxygen/css/doxygen/tabs.css @@ -0,0 +1,105 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs #MSearchBox +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; + text-align : center; + margin : 2px; + padding : 2px; +} diff --git a/doc/doxygen/css/img/OpenCFDlogo.png b/doc/doxygen/css/img/OpenCFDlogo.png new file mode 100644 index 0000000000000000000000000000000000000000..15c03032cad560b323539fd1567fcdac036612da GIT binary patch literal 11529 zcmXwfbzBtR+x7qoh$xG+gp_o5cPpJsN_TgIlz@PMfPgd-(%nmUce6@&cfRBI_q@Z0 zWtl%__uS`>D^9qQg7ho2w`c$WypolXPyqm>pWu5MR7CKV*x1Me{Da`EA}t1#ju7pD z{~#NEkd^?R{{3XO)=B|YWz3M$m zOQwXRkd~8@lFDJe%rt5bb(QQsY;44pm|fW$$ZncbQqx`3c2qW~_|*Fu2OCF1f+3TX zG=h9!LRKcZp;efv2VV>|(bxabTUe1Kou$Eab0vA5-+V+6MQDT;`N=Bt$KYrXKpOmK zb}uA5AX)I)GsHjYcd1r<@bqQ)ogy4W=g8D=)IVR!%|CC=lL5^#=gxqKrZ!7ju-rqjwMDGoB zJDBqi%zh3iJ>6nurt!w_BRLJ6i**MlzEbD-68|Sr9?rfeaqy zQMf^N(O@_wcEjbrPZ1&YffBGg{`NT1_j6?ZgnzvLA}z7U+4k zyT-9Ws}efUmZLm{*}l}!C_q9T-!2t3$39CZ)C#p$oj>mnjg7r;Qk3gcm;Uej|FtH? zc1WE?gC*Mgd*s>D>FHUN$11w;HH7~X z=m{S1^IY%p!F~S9ushZMLCfWQ{Q5*C`1rRw_S@etfp3l(l|Q6Al!1WhcD{p!il`K8 zCu0cO?5zk|$J3mRk+b0Z3%{67~zkW)wCj#Tq2f5vx2STdrYH7LbPW3mqy4youIdTNJ_qze%GC+$6{(?Xh>Gf$iS8^gMkrK_)_yXqmp9G z71dUMGJF2osvRzN^Web1CeKJ$S64?zw&i3V3hb$HqZF({_YT`hcuv9(%O4u?ear(diApPOcLR2$qlseW zesSVBI60xce(iRCT>2PmU#F3roUDBq-qPZ$_OWsmzO#m`*W@Oj8j)@*s9Bx@io)YAc>FVl=i6N4hp#H73 zUF5sFFPP|Xcvn_k%@L9PQC{BF)sqs5>MuMxceuz$=)sX9B+lku$^-yn)y82f-zr>TgP3Ub31qjox1Xjc z)$O&Bki=tUo{>$Bk7pIU^?g&$I5{*`d@IdN0#E1goQT9@K5h*S4IKt^W^adfY+P1e zUjD;}!M;8KSo+YowYFB}ak830#r)gWe&?7%8X_hpNCsr8=r(Zs*pGS1XXA>|Kv376 zczYc=XBq#&GDzp?6uRHJzr@9$)-QCLa1JHKnG;RY^%{@i3^}`$#n_;4-xxCezYlagvQf zi$N2S!ezS<^76HYLi#`yX)sUp8js!G<$?TC)65QlrOX?s`;Fe+60kIdd*#x#T}M`KAr#T9e;0fQbk2YeS{3?5^nGAM)ex?PZo1^ zhx&7L=3?#W{gb_p|A>YfCNk+QR2WOghYq)9QQ*iHyin~nG`wGZBQi&3BDxxk zGq@yf%C6ccV>4I&^CywQ$Z$F*|EX9)=Zlc% z*C!9Dis?MG5L6Skd9crE+M;Q0+xegaz(T>_jyCo2@o_3DDh~NppBty$@BQ$l!kDNU zR8asDY|-mxn1)@V)K&te?=sVN-Ru0F!p6>y1d!^nN1H267J04t`T1#$H#Ro*bambH z*rCD9zg5VvzKkYWF_g~E|CmgkG059KDi)2Y4@}yL#s6W9a*uH%)GRf+ zi<1*&nuQcpt(M`%#Z*&h^2gdw?Vqh$PhA8B)8otntl+a$I2Mf7)01n{=gzv5Zp6Op z-1-qp>WGD}2&-QO9k+j6RESDWlGhXMB!y%~Zn5l_Lt_bNTd@3%k%hP@bMilZcEI|{sJjGdXY zWyyUGeK|G6S8?2GU7{;P$(-GJC05c@@zbt#bJ49jM}xwhw~`j&xz*zMY7^J^%BMY0&oN%;J)tWg=Vxh zjpylwkF2b=7iWIxL1{6<(}fq+zMLaRv7`#}CaexW2wVUyn(APdr!S zIGgxwKg@Ac3bA%waw=BP8qpj?4mJl9(B4a1tPS(21&_}a_J{NZCZ_rc)(0I(mAtU`CxT`eKeHGVjRAJ4oiD!-% zmY8NO7>8F_r~2Qu;na|mlardNBfqyjd8BuDchovOH1xK~6#;Pg#caO}yVxGjSe+lTuDD&YFyes{xT zV@g5U-PCaAL2fBY$%OCU*Vor2-eK%<54GMB<7nQp@!gUGZ9P4ChLe{-fZM^sa~r*W0^wu{XO;nD~!NJ>i2b zIRru;>~(cmvZ0c3TgwQ(BgVmb4)D0HuE)(RA7fbDq~-?(1_A-U1`|(j?kkLYH#atD zHPN+6IJ__SQ#7iu*K?oUS5h8s%5Ox0<%5m-?BVX}$@f7zD{Lt0*r(1RKxH>_Q`j^`KSUw&R1+mX?;N zWI`FjZu>mLt#s;H^u z>ejiY&VVSHyT-P#c7xiztXR8-k9MbYz>S(Z-}7wC`{He0rSE*DDVQY|i?z0DE@kq2 znhy;Jqn}$}et*f~Xj5s}87ei*?^}$TAZQ(XnO=itubmZ8Bs%4n9n1E2ChGK*4G1VH zDVe?Mtl>?@4<%qX8+zw|k3c5icCK~QzE&jbz;}8d0xl8=C@W)Lxt=V@SY2Hu4ZgcN zGSEpaz=`bMl==+9wBGLS?yjyWHHMRg{`-3$;=pM0I#JA~nOJ+RfAsF&xU08!jXD?x zb46`nw;0Q;G9M)mesi><-ba#>_Z$&nu+kk1tIlRcMN7-V*m$x<$DQ4IGB?*-vrHfS z3=quw-Cf$cQipBD*nz;YIXfE>_+(|ZJKa9mJ^g;eZ=gh{PEJmaoPt7CWS_pdQkCc?dCwBZI9cO1}Z*T8V!}Kiy|AadRn|y8FgErr&k_qO{?A6>U=lO)byFrx))y>raH+ba6oSUbneFyfaq3r3 zLFSCFgOr-g{~MhYQxWbnxq>)fwub+6JW=R*uWaY~I z3Xtg_;rBxy9UsdQKj~2rqWBsWg(;?4s$0UziQ4PvL$X|EU;vDP8GWcHoKrgo)*@-J zt-zvIDjGdKy|5}ATrOf@=KBH$Zfa^204(sIX=&AEb5k|6iMq`C&6!#iV!{0;Yz?}8 zhf6md9UYEqJ$hff>q#xvraT9^js*Qc=mG+~l)S6``LjQlH!*&9ygT5>RAdu#+v(a& zRDH9(^V543ta=*K~x#{0<3N^e8Iiep?b@d(_mtK1Saq2S=g0Qx0m6(Br!bDS0`C?&i&gb)1 zzV@{btTO0yHd8bR`C495@_9_Cnv+wdE)@#E!^88Z+Hipsdn`RY{Tkil`Z!ArjUrep z5hq;2`|9vH@OZgsuguynnq@dB-dPIwgao#W4#}4FA#wD-QB#&ifTf`zHyKY2nLypyF0i2dg%|I3?U&P zU_kEVWUZGoqaLITk*3Q{R}i!iAb{O`>WelFZA6nN7THv*zkhL%`nlkLliVO2><0HD zDh3Ad^1#SToL7u`#l^({;MCCkXPSK@h9=@O@tuxDI((KDB`*)%^i)@~F@Z_Y+iu6cQW~BA>>K z(T<@}a?={p*w6s(Zmi7taeI!H8@*Kr%BZ%(k$zNq%{$LYCY&PTSFyqJie;6~H8%67 z&PN=Oj!quqp0AHBd{O5I*{5$gGwJ;({I2$$`BW^F0TDU5i1gQ;CZ_79zU5U_lQ6Q_ zU{?o+wxg%VJA3skBr@Prd&iA4E`zeiHn|K+30zfQgM^qkEiKL0<)|kXYm;W`I9oFE zcnTQ>g;~3r=0Y-DYasj=5%6iXD}01$1PKM5fsRfa=F{EJgrtV7z<|qbG4|)YP*q-6 zo33$hzSq4e(9a+P2I(+yZJ-31BWsS+p|0LD5Dss>{ySEI!-+vuXHo)#3H>J94&42# zn92pt>u;venvohGA^(d_-vJ%{7B6+qmzQp?Dazj7cii?X0I;&zYCETPv;8NlGYmjP z&BUaT`ay6CPmnw5iX!0OJdW*jYPbhmQ%*j^j1Ory4qKL|@hDe1YXvLFd+%OV3?vZ& zq?;2r*&SkF$4eLV`g~>hU%iW5qqOY>L&P#5f&)uS_h9K6Rq!w~EAp1(+1dWh4*8vz zji_8S0vk@{R+N+TIzLt(S<{KAHrX1@2!nuhXT*R-xJ)KnMVVp4Z0M)s;Sz81M_dw^ z{jV@?K!mQW5&hbPe zL|c3eNu3cN56}H@sbL$03cEbMw;XhX4@x8zXsuWX21@zf-+Q8phz!`$O=$>k9RFwm z0pS(0t)dj=+1*s*Wy^@)mOdFQvWd>3K_gq=-L*11%B$5FO&2^#?dtk{Av_vq3~%-fg6uBT z6oJACQ${5RE=}vlR~~8n?yi=*h=7c&va#vjQiJM66dNum!2Nk(U}W52|IL;2n+5ga z+sDh5DlUy_tsjkztb&f>tYdukJ%gCQZzc%GrE({KSupL9@_ipOyk_eYj(bl$7 z@kO)ba1J#Y(bWqEi|5X5nQZrKjTl0mNfazS-OPR=rWA`LCSP=AXM0=etBB(SnT-F* zz0OHe%+}`S>fq=|4;%kerz00@xHgYpvtZlpSi_UbppgjKneyabJOA0Tpew{ODV1 z6>QBuhb~4SpenLTZG<)AWCNm^Z`|jhu~BPd2<0SbzH<8%kG=Nr`>+mIq@+=V3hqFF*>>FOn=B$?)>J&w;`OAnrY!vUTSI)-idsd1MMDr>Onoe9uzBdC)g+aC)(1~? zkZ!ASvK^sSYX+r=o9*oFS!1d0IrsVcTc4!exU=#0&MhpgKEc;p#$h;F0V6&d@AKbk zaTRdAYFk=r&Rese%p1-U4}*w}vZXh8xFl4dE@G1fgJh?$W-m84cb8m+D*ntGrU!8L zCbStsHb_V@R%FKjXcYq2a14FmP!;p-c;xUQDs8XCBM#>U1u zb6S_TvO_iaKX)leNkwWMvLZN%h4l^brI?bQwuGOOu^`1aKi9^`@?%D$_P9^a&ajMg z90qg=BFph&>*}~y36TIHKOV7)f%-TipbztS0c6trj`gJ= zi2MO^P*x5`^ZD=Jv1w>0*nrP69aK~+?MFJbHifH}0anqL-NrQCIc|~!fg%A{g&CCnU)o6XeqmMwl(TJ`KDNJVMhD?jo&F~@PHP| z(dzyi0^hrgj9c&7(e+THx z_@Q+V0}<(Oa&!c>PNHy18z(0=08kklAIHp)(ppA)#s{t+Z_5500|QNgg=@?AbH#!G z?rQ>7)8g)x>YDC6^_=xx>}Mi9*-Uy(L;@ZVz~S+}!7@_AO7#OxX3RT&rucr+;L_4k zqLLzugX64D00=eAQ%JJ{lX_4ssS2dPgQNehm?nq%wJYJNi8Rl6ken{pJ5q3Q;X0{M zAhig)zoVt4W#wkKUp5Uu_Er2R;dRU!Z;xdWa@(!*9QIrgCezNQ2{u~PzMh#}(`#}d z2P53n^ZG4Mxz`P-Mo)2(V~^RNu6*LOxfePS0lh~&*voM|FAU+AW5y^TQcT3W1u`&!l{1xR-oEa*Y(8;_cKexN-yw^XXt zA`MD|7kh9FvS(yV&7M_UB_NM-KUh&$Rz@JRnJQ3rtzvg$EGWDM_Y48R&c#k22crQ5 zL`0lwN39spkskM^yt#Z!ZaeiQelW133fDjPi+qv%SkS1l6S4Ob$e7W{hDJtUPF5LQ ztajZA6JNwJ=VCvNWr{|`dj534Y~lxTp^xP8ZR{g^uR=Pv;et=M^-ykucrR!&*q@AL zbsi@WkdTxPD?IX?N&_N(evb(SohrQUhx<^}EcYwBl#Bm^{TN6ew#JR6oQb3-&xexP zH!8JpkCMKtGw9TQ&9jVN3q>a|vbs{%(%9Gg_U&6{ZK+I0x{&i*KxERTH=6iFirSo7 zP*4!n(8!2f=TxkP2hvI?Sg`ng99ER{u~!G1tVQVEuOBr5dCE>~z6_3tde z79A2O)t1n5*}C4}-#hSB_4OG$YG!lDU^-K@N1cV0>bFF^%L1vN?}_CGkNnG)V)>9+ zg?C?~qCy~O&ptz|%+$jdR?+4Q!kxi<2LRAWTbx0*&`=Y2OSSZMzQGvf66*)6ap+s# zps`()B#~)X)drpwFM#CakV3ZhXhp_PsxWB8d6iv+gBn z35idI3uX4LphhUu5kYC=81nI?!|Y-SalG76yn?>(K&Q?*W2vyFx763K&GPT6eQ#28 z|3_KR0LbY9{AqC4`@ho#yIuFDS+%vb41=Kb=3~)Xn(#c?Ov-B280~p=F^#tcycAq2 z!=SddHnQ!Us$QECwz`%UKFl>Cf~b-UXQjyxbaoKLwl_D;=5t*Wf>~jhmRin6L9(mY>L@FUL3W3fzt;NaVRfMG}Hc?5Wm$IO94$Z z#qWW`g?HDLYi`=W9Y`8U`yuGf)ycvz`1+Xm&!3r_!FRFI(b~KbNx4VxCg+*`c^{#S zwR%hnKS+w^^W z-^Znf)mg;4Cr;tR0rAHz+zO4B?LGAZJ#OyQUWgL& zyUEGRKL@sVb`F-CG;LMqv!yGS9zUJGo5#pyZf~mVGrropxR~f+ay!6t(ka8oq#C!?8@Jrz5R{RjiQTd&`O1xsO!VtIlYntnhn{$Em)mOBi>$0HY{`fFvr+$$C)3F;y?I6VwTS0+_RD!R z12Z#jKj8aij)F7-)|iNp?1#Hot7{uQJ+3dkj*~~1K&xi~q;{V_fByLsPtfc9{$e%& zf#M#syH^vtwmWZ0pw4V~;rsVH58}DF_Xq=r@3uzLI_=2x_4O}`^{fvZrxbJEU}2F3 z=PRV?*I#QMJ7!kwp6|^bP4%lnlc69Q3WT`rtsGcO@BN!Oh*=uNX$$Fmt^;5t@bfnn z7rXSwy)V)zsRXT1N4MC4T*Y*O{{DXDTpWv~`V-KsF8(QCZ6!~G9U+nZ0*lIJ|623u z@xfDIC7Ipa$k@1I1te#7##b>!%zMzLQm~VOgc1m-A+uKeDexCGB{nxN!C-wzVlp&G zPBhgl)-qfvpvw0u4*F(UU$s z{@V%eM#o_$7}*QWYXkWd4$GBh-d?Aj(TS?6%5Ec8AtGvO>Sm&XMpU(ZH$Crsng~Pu zlss|pu!oo!$M^63CSa(VUjI}gsmF*s%45=Q-#QcH4n+i*3>tlICN{t}*jQgbx4`9d zRr=>|PMG3EI?d;WTB~V3fqUleRZ5)l13p&Pil+Rt^1q!Rd^*{^D2k_6Frpv_NI5vv z8cM%PVwo{FId6@CvO-m5CG6`OeRKOs@yKBv~%Xz+TZc0*YeB`1)R6UfS9Vk$CEleAu~(k1(6<`s4vd2?>cYj^WCEP&lcHO>MbFXF=Dc zdlMcJ89AEH%jSw$*@Ee#jl0mf?~zkdC4YCs2AZ01-Jm>l#@FXX@k3HJYS zL?n=H6jxXFa;eVVKvq^3gj;JMfD-mA*3I*KxCM73g@aips9=?+6g=MngCXHE=|b@S zUHR8)nwnR$0R|}1=^8CYM`UZAUw0oK?~Ztxo!I`nz6*15az1b#&!!{w($;S8u^3h0 z_ddOe?6x{nm!*88D?<5ZXOAU?f$36wKUg%y{TT*FlG(TVu4G9T3`R}6Z21zhBHnz!hmpD{aC?W<1DosGZ=-S02EQ1SKP0C`T%s|*DzXr4u zGX7$nj6_P13wY6OV0PQj!j^BGw-5jg4GlW$XE*5TP-u9}1D1m6e(#pq zNQT4SObKX)f^9-e3>2zr?BOsSdjrtUwx&o(NbtkT=dj&%I_>Ju^_G>Clmz2wHJ;tw z7Kjv8oHCv-`^cvx7kqVU5r zz+$|)LA!l-t_u^-0uFmvj9aLh-QA`T7TyVcg$RhumM&5Mu*CVAfwTQ|wmz7|L`m6& zhli7&pKr{#H`i4Wm2Y0QBA5kpm3Q^OKat+&TLR_q#>+)80-)jGW1ZEkhp9FP%J}pB z4KTfzHHrMw`^EB$=S$wzTRGQ}tgN#W>A4%QAw~uU6Z{^K{#S|ykt~C~@d_#1YP9%n z*&Qzbqh)BXEirN&56twBlhr{%LHYSxqw!Qof`chm&u!<{wzlvH2$DgmJvo^+R%U2u z$i~*z`(k(cDlDTY>1eJZr?8MVV{{g4x6rm+eNW@sF(^D-w&d<>RE=Azi<1)|HWmEB zm3nYgH^HhZE7k5*bhZVfV1@DKvHdBeJ(mwLNUUyXD` z{06%jY*velgutJ}&5@lHtI61}lEM$?s`~mQ!Qa++EDgEfUHY1%<)CxLmOQkqC;#>f zYfi6P1U&)(_kZ%e_%PMq|KdnoUiRsqGa_>B)u+|PU3)au3)5+Rm*D@t0(pWf4l@`u z^y#Tb=MijiqAYgoW{v;Mks$S2O-5QT>f7>NAplb*pKF{hbz!9~p@?)}D5rvx6MCax zoWeifoP9WMEL23^NpZa*et5`ab#-MU;uZwTCdQrW5>AMDO(llueN0X<$S|k)Z3ISW zOHHld`I04|>>zYMJJTJBhXnZD9n@9CZ~1nd_-M}>eEUJOQf(X##pz)Q*~DzNs{jW6->K;Q{^@p!CQ`Fo2_pI7e*;nKKqBx-Ua}~m;K2l@mzrIJ^`R8)zfyUe z4S@J{r1*9`VbQSt|5LXBkZ9_d$iRjTCpVZ=iFAhktut}>2cf{zr1T=F7w6|DY{}8l zuL)j}TOqJ6{GTw5JI-nS^P2|-=&FDGVtSa`%vi{IE1H&RV(Q5Zl2zQ9OPNm}dy@WH g(f`mG#<72bL?F$ip>!m8xEGL>RFEhY`}Fz$0f!5aX8-^I literal 0 HcmV?d00001 diff --git a/doc/doxygen/css/img/bg_bullet_full_1.gif b/doc/doxygen/css/img/bg_bullet_full_1.gif new file mode 100644 index 0000000000000000000000000000000000000000..45cce6f70731fde7681290309d061eb3485885d2 GIT binary patch literal 806 zcmV+>1KIpXNk%w1VFdsM0QUd@000010RaL60s{jB1Ox;H1qB8M1_uWR2nYxX2?+`c z3JVJh3=9kn4Gj(s4i66x5D*X%5fKs+5)%^>6ciK{6%`g178e&67#J8C85tTH8XFrM z92^`S9UUGX9v>ecARr(iAt53nA|oRsBqSsyB_$>%CMPE+C@3f?DJd!{Dl021EG#T7 zEiEoCE-x=HFfcGNF)=bSGBYzXG&D3dH8nOiHa9mnI5;>tIXOByIy*Z%JUl!-Jv}}? zK0iM{KtMo2K|w-7LPJACL_|bIMMXwNMn^|SNJvOYNl8jdN=r*iOiWBoO-)WtPESuy zP*6}&QBhJ-Qd3h?R8&+|RaI72R##V7SXfwDSy@_IT3cINTwGjTU0q&YUSD5dU|?Wj zVPRroVq;@tWMpJzWo2e&W@l$-XlQ6@X=!R|YHMq2Y;0_8ZEbFDZf|dIaBy&OadC2T za&vQYbaZreb#-=jc6WDoczAeud3kzzdV70&e0+R;eSLm@et&;|fPjF3fq{a8f`fyD zgoK2Jg@uNOhKGlTh=_=ZiHVAeii?YjjEszpjg5|uj*pLzkdTm(k&%*;l9Q8@l$4Z} zm6ev3mY0{8n3$NEnVFiJnwy)OoSdAUot>VZo}ZteprD|kp`oIpqNAguq@<*!rKP5( zrl+T;sHmu^si~@}s;jH3tgNi9t*x%EuCK4Ju&}VPv9YqUva_?Zw6wIfwY9dkwzs#p zxVX5vxw*Q!y1To(yu7@dCU$jHda z$;ryf%FD~k%*@Qq&CSlv&d<-!(9qD)(b3Y<($mw^)YR0~)z#M4*4Nk9*x1lt)=I7_<=;-L_>FMg~>g((4 z?Ck9A?d|UF?(gsK@bK{Q@$vHV^7Hfa^z`)g_4W4l_V@Sq`1ttw`T6?#`uqF){QUg= k{r&#_{{R2~EC2ui00jUA06+)}0DlP_NU)$mf&l>lJ8I*E{r~^~ literal 0 HcmV?d00001 diff --git a/doc/doxygen/css/img/bg_bullet_full_2.gif b/doc/doxygen/css/img/bg_bullet_full_2.gif new file mode 100644 index 0000000000000000000000000000000000000000..98807b21e1924965ac7c8f294b91e2a7c4b39860 GIT binary patch literal 50 ucmZ?wbhEHbWMyDwn8?6jo6*kz13DlENZf&gn}Lx-#$&?*$0kNb25SJWVg|kd literal 0 HcmV?d00001 diff --git a/doc/doxygen/css/img/bg_bullet_half_1.gif b/doc/doxygen/css/img/bg_bullet_half_1.gif new file mode 100644 index 0000000000000000000000000000000000000000..04e6f94141bc53e94305667bff3619674efee4ca GIT binary patch literal 825 zcmV-91IGMENk%w1VFmyO0QUd@000010RaL60s{jB1Ox;H1qB8M1_uWR2nYxX2?+`c z3JVJh3=9kn4Gj(s4i66x5D*X%5fKs+5)%^>6ciK{6%`g178e&67#J8C85tTH8XFrM z92^`S9UUGX9v>ecARr(iAt53nA|oRsBqSsyB_$>%CMPE+C@3f?DJd!{Dl021EG#T7 zEiEoCE-x=HFfcGNF)=bSGBYzXG&D3dH8nOiHa9mnI5;>tIXOByIy*Z%JUl!-Jv}}? zK0iM{KtMo2K|w-7LPJACL_|bIMMXwNMn^|SNJvOYNl8jdN=r*iOiWBoO-)WtPESuy zP*6}&QBhJ-Qd3h?R8&+|RaI72R##V7SXfwDSy@_IT3cINTwGjTU0q&YUSD5dU|?Wj zVPRroVq;@tWMpJzWo2e&W@l$-XlQ6@X=!R|YHMq2Y;0_8ZEbFDZf|dIaBy&OadC2T za&vQYbaZreb#-=jc6WDoczAeud3kzzdV70&e0+R;eSLm@et&;|fPjF3fq{a8f`fyD zgoK2Jg@uNOhKGlTh=_=ZiHVAeii?YjjEszpjg5|uj*pLzkdTm(k&%*;l9Q8@l$4Z} zm6ev3mY0{8n3$NEnVFiJnwy)OoSdAUot>VZo}ZteprD|kp`oIpqNAguq@<*!rKP5( zrl+T;sHmu^si~@}s;jH3tgNi9t*x%EuCK4Ju&}VPv9YqUva_?Zw6wIfwY9dkwzs#p zxVX5vxw*Q!y1To(yu7@dCU$jHda z$;ryf%FD~k%*@Qq&CSlv&d<-!(9qD)(b3Y<($mw^)YR0~)z#M4*4Nk9*x1lt)=I7_<=;-L_>FMg~>g((4 z?Ck9A?d|UF?(gsK@bK{Q@$vHV^7Hfa^z`)g_4W4l_V@Sq`1ttw`T6?#`uqF){QUg= z{r&#_{{R2~A^8Le00930EC2ui00saC06+*90RIUT`0L-Vg9is99B8m$Lxd221q1*) D%&UxL literal 0 HcmV?d00001 diff --git a/doc/doxygen/css/img/bg_bullet_half_2.gif b/doc/doxygen/css/img/bg_bullet_half_2.gif new file mode 100644 index 0000000000000000000000000000000000000000..9be6bc623d141645afceebe8c36a34711102d034 GIT binary patch literal 99 zcmZ?wbhEHbWMyDw*v!CSo6#RoJ}aedY5CL*8xLJPa`Eo#_n-g$`}hC i0|N(x4oDJYh69HHgCK_s!-55ljqHL<3K<3p4AuaX5*rBs literal 0 HcmV?d00001 diff --git a/doc/doxygen/css/img/bg_corner_topright.gif b/doc/doxygen/css/img/bg_corner_topright.gif new file mode 100644 index 0000000000000000000000000000000000000000..95b146294bb3ffdc32b3ecdbeca7cfa00d32a132 GIT binary patch literal 60 zcmZ?wbhEHbP-#>r;{PE+*w{PFReEIVE^XK>P-@kkJ z?&ZsuPo6w^`0(NV`}gnMxpV8*ts6IPT)ler%9SgZFJHcN>C(lE7cX46aOTXJlP6Ce zKYsk^(W6I>965aW@S#J84jw#s;J|@>`}XbKyLZ>FT|0N~+_7WFwr$(CZr!?N%a+ZX zH*egyal?iU>({RbI)i~Mp!k!8k%2*%K?kH8-<#KObFbx$V$v3yH_`7mDafw-*kKa#m~4zR{oyPrS7XNRM+Olt?4Vz z-`4KJ;jN=B+1Ka76f#+S+H_|L->Gx^8F+o=7SCf$)lu$US9*SeveNzF%oTf2ad zR_&fr21Os4Lv?K0KE)?W_pC)60|1L9 Bw2A-# literal 0 HcmV?d00001 diff --git a/doc/doxygen/css/img/bg_head_corner_topright_25px.gif b/doc/doxygen/css/img/bg_head_corner_topright_25px.gif new file mode 100644 index 0000000000000000000000000000000000000000..1bcf6a6a4c610a6a28601037b62c3e838f141381 GIT binary patch literal 389 zcmZ?wbhEHblw^=(xXQrr|NsBLfB*jZ^XK>P-#>r;{PE+*w{PFReEIVE^XK>P-@kkJ z?&ZsuPo6w^`0(NV`}gnMxpV8*ts6IPT)ler%9SgZFJHcN>C(lE7cX46aOTXJlP6Ce zKYsk^(W6I>965aW@S#J84jw#s;J|@>`}XbKyLZ>FT|0N~+_7WFwr$(CZr!?N%a+ZX zH*egyal?iU>({RbI)i~Mp!k!8k%2*%K?kH8N2_3l^xdS!m{UtIJ$14rbW>UT{K~g;m7+1|elW