Changeset 7401 for code/trunk/doc/api
- Timestamp:
- Sep 11, 2010, 12:34:00 AM (14 years ago)
- Location:
- code/trunk
- Files:
-
- 4 edited
- 2 copied
Legend:
- Unmodified
- Added
- Removed
-
code/trunk
- Property svn:mergeinfo changed
/code/branches/doc (added) merged: 7290-7292,7296-7300,7302-7304,7306-7312,7315-7318,7323,7325,7327,7331-7332,7334-7335,7345-7347,7352-7353,7356-7357,7361,7363-7367,7371-7375,7388
- Property svn:mergeinfo changed
-
code/trunk/doc/api/CMakeLists.txt
r6417 r7401 46 46 #ENDIF (NOT DVIPS_CONVERTER) 47 47 48 SET(INTERNAL_DOCFILE ${CMAKE_CURRENT_BINARY_DIR}/Internal.dox) 49 IF(WIN32) 50 SET(_working_dir ${RUNTIME_LIBRARY_DIRECTORY}) 51 ELSE() 52 SET(_working_dir ${CMAKE_CURRENT_BINARY_DIR}) 53 ENDIF() 54 ADD_CUSTOM_COMMAND( 55 OUTPUT ${INTERNAL_DOCFILE} 56 COMMAND orxonox-main 57 ARGS --noIOConsole --generateDoc ${INTERNAL_DOCFILE} 58 WORKING_DIRECTORY ${_working_dir} 59 COMMENT "Generating additional Doxygen documentation from Orxonox executable" 60 ) 61 ADD_CUSTOM_TARGET(doc_internal DEPENDS ${INTERNAL_DOCFILE}) 62 IF (NOT EXISTS ${INTERNAL_DOCFILE}) 63 FILE(WRITE ${INTERNAL_DOCFILE} "// empty...") 64 ENDIF() 65 66 # Take care of most of the conditional compilation problems 67 # (Doxygen requires separate input for that) 68 IF(WIN32) 69 SET(DOXY_PLATFORM_DEF "ORXONOX_PLATFORM_WINDOWS") 70 ELSEIF(APPLE) 71 SET(DOXY_PLATFORM_DEF "ORXONOX_PLATFORM_APPLE ORXONOX_PLATFORM_UNIX") 72 ELSE() 73 SET(DOXY_PLATFORM_DEF "ORXONOX_PLATFORM_LINUX ORXONOX_PLATFORM_UNIX") 74 ENDIF() 75 IF(MSVC) 76 SET(DOXY_COMPILER_DEF "ORXONOX_COMPILER_MSVC") 77 ELSE() 78 SET(DOXY_COMPILER_DEF "ORXONOX_COMPILER_GCC") 79 ENDIF() 80 48 81 IF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in) 49 CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in ${CMAKE_CURRENT_BINARY_DIR}/doxy.config @ONLY)50 82 # use (configured) doxy.config from (out of place) BUILD tree: 51 83 SET(DOXY_CONFIG ${CMAKE_CURRENT_BINARY_DIR}/doxy.config) 52 84 SET(DOXY_LOGFILE ${CMAKE_CURRENT_BINARY_DIR}/doxy.log) 85 CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/doxy.config.in ${CMAKE_CURRENT_BINARY_DIR}/doxy.config @ONLY) 53 86 ELSE() 54 87 MESSAGE(FATAL_ERROR "Warning: Could not find dox.config.in in the root directory.") -
code/trunk/doc/api/doxy.config.in
r6085 r7401 1 # Doxyfile 1. 4.51 # Doxyfile 1.6.3 2 2 3 3 # This file describes the settings to be used by the documentation system … … 15 15 #--------------------------------------------------------------------------- 16 16 17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 17 # This tag specifies the encoding used for all characters in the config file 18 # that follow. The default is UTF-8 which is also the encoding used for all 19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 20 # iconv built into libc) for the transcoding. See 21 # http://www.gnu.org/software/libiconv for the list of possible encodings. 22 23 DOXYFILE_ENCODING = UTF-8 24 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18 26 # by quotes) that should identify the project. 19 27 20 28 PROJECT_NAME = "@PROJECT_NAME@" 21 29 22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 23 # This could be handy for archiving the generated documentation or 30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 31 # This could be handy for archiving the generated documentation or 24 32 # if some version control system is used. 25 33 26 34 PROJECT_NUMBER = "@ORXONOX_VERSION@ Codename: @ORXONOX_VERSION_NAME@" 27 35 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 29 # base path where the generated documentation will be put. 30 # If a relative path is entered, it will be relative to the location 36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37 # base path where the generated documentation will be put. 38 # If a relative path is entered, it will be relative to the location 31 39 # where doxygen was started. If left blank the current directory will be used. 32 40 33 41 OUTPUT_DIRECTORY = @DOXY_OUTPUT_DIR@ 34 42 35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 36 # 4096 sub-directories (in 2 levels) under the output directory of each output 37 # format and will distribute the generated files over these directories. 38 # Enabling this option can be useful when feeding doxygen a huge amount of 39 # source files, where putting all generated files in the same directory would 43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 44 # 4096 sub-directories (in 2 levels) under the output directory of each output 45 # format and will distribute the generated files over these directories. 46 # Enabling this option can be useful when feeding doxygen a huge amount of 47 # source files, where putting all generated files in the same directory would 40 48 # otherwise cause performance problems for the file system. 41 49 42 50 CREATE_SUBDIRS = NO 43 51 44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 45 # documentation generated by doxygen is written. Doxygen will use this 46 # information to generate all constant output in the proper language. 47 # The default language is English, other supported languages are: 48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 52 # Swedish, and Ukrainian. 52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 53 # documentation generated by doxygen is written. Doxygen will use this 54 # information to generate all constant output in the proper language. 55 # The default language is English, other supported languages are: 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 53 62 54 63 OUTPUT_LANGUAGE = English 55 64 56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 57 # include brief member descriptions after the members that are listed in 58 # the file and class documentation (similar to JavaDoc). 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 66 # include brief member descriptions after the members that are listed in 67 # the file and class documentation (similar to JavaDoc). 59 68 # Set to NO to disable this. 60 69 61 70 BRIEF_MEMBER_DESC = YES 62 71 63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 64 # the brief description of a member or function before the detailed description. 65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 73 # the brief description of a member or function before the detailed description. 74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 66 75 # brief descriptions will be completely suppressed. 67 76 68 77 REPEAT_BRIEF = YES 69 78 70 # This tag implements a quasi-intelligent brief description abbreviator 71 # that is used to form the text in various listings. Each string 72 # in this list, if found as the leading text of the brief description, will be 73 # stripped from the text and the result after processing the whole list, is 74 # used as the annotated text. Otherwise, the brief description is used as-is. 75 # If left blank, the following values are used ("$name" is automatically 76 # replaced with the name of the entity): "The $name class" "The $name widget" 77 # "The $name file" "is" "provides" "specifies" "contains" 79 # This tag implements a quasi-intelligent brief description abbreviator 80 # that is used to form the text in various listings. Each string 81 # in this list, if found as the leading text of the brief description, will be 82 # stripped from the text and the result after processing the whole list, is 83 # used as the annotated text. Otherwise, the brief description is used as-is. 84 # If left blank, the following values are used ("$name" is automatically 85 # replaced with the name of the entity): "The $name class" "The $name widget" 86 # "The $name file" "is" "provides" "specifies" "contains" 78 87 # "represents" "a" "an" "the" 79 88 … … 90 99 the 91 100 92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 93 # Doxygen will generate a detailed section even if there is only a brief 101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 102 # Doxygen will generate a detailed section even if there is only a brief 94 103 # description. 95 104 96 105 ALWAYS_DETAILED_SEC = NO 97 106 98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 99 # inherited members of a class in the documentation of that class as if those 100 # members were ordinary class members. Constructors, destructors and assignment 107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 108 # inherited members of a class in the documentation of that class as if those 109 # members were ordinary class members. Constructors, destructors and assignment 101 110 # operators of the base classes will not be shown. 102 111 103 112 INLINE_INHERITED_MEMB = NO 104 113 105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 106 # path before files name in the file list and in the header files. If set 114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 115 # path before files name in the file list and in the header files. If set 107 116 # to NO the shortest path that makes the file name unique will be used. 108 117 109 118 FULL_PATH_NAMES = YES 110 119 111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 112 # can be used to strip a user-defined part of the path. Stripping is 113 # only done if one of the specified strings matches the left-hand part of 114 # the path. The tag can be used to show relative paths in the file list. 115 # If left blank the directory from which doxygen is run is used as the 120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 121 # can be used to strip a user-defined part of the path. Stripping is 122 # only done if one of the specified strings matches the left-hand part of 123 # the path. The tag can be used to show relative paths in the file list. 124 # If left blank the directory from which doxygen is run is used as the 116 125 # path to strip. 117 126 118 STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ 119 120 121 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 122 # the path mentioned in the documentation of a class, which tells 123 # the reader which header file to include in order to use a class. 124 # If left blank only the name of the header file containing the class 125 # definition is used. Otherwise one should specify the include paths that 127 STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \ 128 @CMAKE_BINARY_DIR@/src 129 130 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 131 # the path mentioned in the documentation of a class, which tells 132 # the reader which header file to include in order to use a class. 133 # If left blank only the name of the header file containing the class 134 # definition is used. Otherwise one should specify the include paths that 126 135 # are normally passed to the compiler using the -I flag. 127 136 128 STRIP_FROM_INC_PATH = @ CMAKE_SOURCE_DIR@129 130 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 131 # (but less readable) file names. This can be useful is your file systems 137 STRIP_FROM_INC_PATH = @DOXYGEN_INCLUDE_DIRECTORIES@ 138 139 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 140 # (but less readable) file names. This can be useful is your file systems 132 141 # doesn't support long names like on DOS, Mac, or CD-ROM. 133 142 134 143 SHORT_NAMES = NO 135 144 136 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 137 # will interpret the first line (until the first dot) of a JavaDoc-style 138 # comment as the brief description. If set to NO, the JavaDoc 139 # comments will behave just like the Qt-style comments (thus requiring an140 # explicit @brief command for a brief description.145 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 146 # will interpret the first line (until the first dot) of a JavaDoc-style 147 # comment as the brief description. If set to NO, the JavaDoc 148 # comments will behave just like regular Qt-style comments 149 # (thus requiring an explicit @brief command for a brief description.) 141 150 142 151 JAVADOC_AUTOBRIEF = YES 143 152 144 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 145 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 146 # comments) as a brief description. This used to be the default behaviour. 147 # The new default is to treat a multi-line C++ comment block as a detailed 153 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 154 # interpret the first line (until the first dot) of a Qt-style 155 # comment as the brief description. If set to NO, the comments 156 # will behave just like regular Qt-style comments (thus requiring 157 # an explicit \brief command for a brief description.) 158 159 QT_AUTOBRIEF = NO 160 161 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 162 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 163 # comments) as a brief description. This used to be the default behaviour. 164 # The new default is to treat a multi-line C++ comment block as a detailed 148 165 # description. Set this tag to YES if you prefer the old behaviour instead. 149 166 150 167 MULTILINE_CPP_IS_BRIEF = NO 151 168 152 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 153 # will output the detailed description near the top, like JavaDoc. 154 # If set to NO, the detailed description appears after the member 169 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 170 # member inherits the documentation from any documented member that it 171 # re-implements. 172 173 INHERIT_DOCS = YES 174 175 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 176 # a new page for each member. If set to NO, the documentation of a member will 177 # be part of the file/class/namespace that contains it. 178 179 SEPARATE_MEMBER_PAGES = NO 180 181 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 182 # Doxygen uses this value to replace tabs by spaces in code fragments. 183 184 TAB_SIZE = 4 185 186 # This tag can be used to specify a number of aliases that acts 187 # as commands in the documentation. An alias has the form "name=value". 188 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 189 # put the command \sideeffect (or @sideeffect) in the documentation, which 190 # will result in a user-defined paragraph with heading "Side Effects:". 191 # You can put \n's in the value part of an alias to insert newlines. 192 193 ALIASES = 194 195 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 196 # sources only. Doxygen will then generate output that is more tailored for C. 197 # For instance, some of the names that are used will be different. The list 198 # of all members will be omitted, etc. 199 200 OPTIMIZE_OUTPUT_FOR_C = NO 201 202 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 203 # sources only. Doxygen will then generate output that is more tailored for 204 # Java. For instance, namespaces will be presented as packages, qualified 205 # scopes will look different, etc. 206 207 OPTIMIZE_OUTPUT_JAVA = NO 208 209 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 210 # sources only. Doxygen will then generate output that is more tailored for 211 # Fortran. 212 213 OPTIMIZE_FOR_FORTRAN = NO 214 215 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 216 # sources. Doxygen will then generate output that is tailored for 217 # VHDL. 218 219 OPTIMIZE_OUTPUT_VHDL = NO 220 221 # Doxygen selects the parser to use depending on the extension of the files it parses. 222 # With this tag you can assign which parser to use for a given extension. 223 # Doxygen has a built-in mapping, but you can override or extend it using this tag. 224 # The format is ext=language, where ext is a file extension, and language is one of 225 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 226 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 227 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 228 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 229 230 EXTENSION_MAPPING = 231 232 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 233 # to include (a tag file for) the STL sources as input, then you should 234 # set this tag to YES in order to let doxygen match functions declarations and 235 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 236 # func(std::string) {}). This also make the inheritance and collaboration 237 # diagrams that involve STL classes more complete and accurate. 238 239 BUILTIN_STL_SUPPORT = YES 240 241 # If you use Microsoft's C++/CLI language, you should set this option to YES to 242 # enable parsing support. 243 244 CPP_CLI_SUPPORT = NO 245 246 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 247 # Doxygen will parse them like normal C++ but will assume all classes use public 248 # instead of private inheritance when no explicit protection keyword is present. 249 250 SIP_SUPPORT = NO 251 252 # For Microsoft's IDL there are propget and propput attributes to indicate getter 253 # and setter methods for a property. Setting this option to YES (the default) 254 # will make doxygen to replace the get and set methods by a property in the 255 # documentation. This will only work if the methods are indeed getting or 256 # setting a simple type. If this is not the case, or you want to show the 257 # methods anyway, you should set this option to NO. 258 259 IDL_PROPERTY_SUPPORT = YES 260 261 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 262 # tag is set to YES, then doxygen will reuse the documentation of the first 263 # member in the group (if any) for the other members of the group. By default 264 # all members of a group must be documented explicitly. 265 266 DISTRIBUTE_GROUP_DOC = NO 267 268 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 269 # the same type (for instance a group of public functions) to be put as a 270 # subgroup of that type (e.g. under the Public Functions section). Set it to 271 # NO to prevent subgrouping. Alternatively, this can be done per class using 272 # the \nosubgrouping command. 273 274 SUBGROUPING = YES 275 276 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 277 # is documented as struct, union, or enum with the name of the typedef. So 278 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 279 # with name TypeT. When disabled the typedef will appear as a member of a file, 280 # namespace, or class. And the struct will be named TypeS. This can typically 281 # be useful for C code in case the coding convention dictates that all compound 282 # types are typedef'ed and only the typedef is referenced, never the tag name. 283 284 TYPEDEF_HIDES_STRUCT = NO 285 286 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 287 # determine which symbols to keep in memory and which to flush to disk. 288 # When the cache is full, less often used symbols will be written to disk. 289 # For small to medium size projects (<1000 input files) the default value is 290 # probably good enough. For larger projects a too small cache size can cause 291 # doxygen to be busy swapping symbols to and from disk most of the time 292 # causing a significant performance penality. 293 # If the system has enough physical memory increasing the cache will improve the 294 # performance by keeping more symbols in memory. Note that the value works on 295 # a logarithmic scale so increasing the size by one will rougly double the 296 # memory usage. The cache size is given by this formula: 297 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 298 # corresponding to a cache size of 2^16 = 65536 symbols 299 300 SYMBOL_CACHE_SIZE = 0 301 302 #--------------------------------------------------------------------------- 303 # Build related configuration options 304 #--------------------------------------------------------------------------- 305 306 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 307 # documentation are documented, even if no documentation was available. 308 # Private class members and static file members will be hidden unless 309 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 310 311 EXTRACT_ALL = YES 312 313 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 314 # will be included in the documentation. 315 316 EXTRACT_PRIVATE = YES 317 318 # If the EXTRACT_STATIC tag is set to YES all static members of a file 319 # will be included in the documentation. 320 321 EXTRACT_STATIC = YES 322 323 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 324 # defined locally in source files will be included in the documentation. 325 # If set to NO only classes defined in header files are included. 326 327 EXTRACT_LOCAL_CLASSES = YES 328 329 # This flag is only useful for Objective-C code. When set to YES local 330 # methods, which are defined in the implementation section but not in 331 # the interface are included in the documentation. 332 # If set to NO (the default) only methods in the interface are included. 333 334 EXTRACT_LOCAL_METHODS = NO 335 336 # If this flag is set to YES, the members of anonymous namespaces will be 337 # extracted and appear in the documentation as a namespace called 338 # 'anonymous_namespace{file}', where file will be replaced with the base 339 # name of the file that contains the anonymous namespace. By default 340 # anonymous namespace are hidden. 341 342 EXTRACT_ANON_NSPACES = NO 343 344 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 345 # undocumented members of documented classes, files or namespaces. 346 # If set to NO (the default) these members will be included in the 347 # various overviews, but no documentation section is generated. 348 # This option has no effect if EXTRACT_ALL is enabled. 349 350 HIDE_UNDOC_MEMBERS = NO 351 352 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 353 # undocumented classes that are normally visible in the class hierarchy. 354 # If set to NO (the default) these classes will be included in the various 355 # overviews. This option has no effect if EXTRACT_ALL is enabled. 356 357 HIDE_UNDOC_CLASSES = NO 358 359 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 360 # friend (class|struct|union) declarations. 361 # If set to NO (the default) these declarations will be included in the 155 362 # documentation. 156 363 157 DETAILS_AT_TOP = NO 158 159 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 160 # member inherits the documentation from any documented member that it 161 # re-implements. 162 163 INHERIT_DOCS = YES 164 165 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 166 # a new page for each member. If set to NO, the documentation of a member will 167 # be part of the file/class/namespace that contains it. 168 169 SEPARATE_MEMBER_PAGES = NO 170 171 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 172 # Doxygen uses this value to replace tabs by spaces in code fragments. 173 174 TAB_SIZE = 4 175 176 # This tag can be used to specify a number of aliases that acts 177 # as commands in the documentation. An alias has the form "name=value". 178 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 179 # put the command \sideeffect (or @sideeffect) in the documentation, which 180 # will result in a user-defined paragraph with heading "Side Effects:". 181 # You can put \n's in the value part of an alias to insert newlines. 182 183 ALIASES = 184 185 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 186 # sources only. Doxygen will then generate output that is more tailored for C. 187 # For instance, some of the names that are used will be different. The list 188 # of all members will be omitted, etc. 189 190 OPTIMIZE_OUTPUT_FOR_C = NO 191 192 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 193 # sources only. Doxygen will then generate output that is more tailored for Java. 194 # For instance, namespaces will be presented as packages, qualified scopes 195 # will look different, etc. 196 197 OPTIMIZE_OUTPUT_JAVA = NO 198 199 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 200 # include (a tag file for) the STL sources as input, then you should 201 # set this tag to YES in order to let doxygen match functions declarations and 202 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 203 # func(std::string) {}). This also make the inheritance and collaboration 204 # diagrams that involve STL classes more complete and accurate. 205 206 BUILTIN_STL_SUPPORT = NO 207 208 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 209 # tag is set to YES, then doxygen will reuse the documentation of the first 210 # member in the group (if any) for the other members of the group. By default 211 # all members of a group must be documented explicitly. 212 213 DISTRIBUTE_GROUP_DOC = NO 214 215 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 216 # the same type (for instance a group of public functions) to be put as a 217 # subgroup of that type (e.g. under the Public Functions section). Set it to 218 # NO to prevent subgrouping. Alternatively, this can be done per class using 219 # the \nosubgrouping command. 220 221 SUBGROUPING = YES 222 223 #--------------------------------------------------------------------------- 224 # Build related configuration options 225 #--------------------------------------------------------------------------- 226 227 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 228 # documentation are documented, even if no documentation was available. 229 # Private class members and static file members will be hidden unless 230 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 231 232 EXTRACT_ALL = YES 233 234 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 235 # will be included in the documentation. 236 237 EXTRACT_PRIVATE = YES 238 239 # If the EXTRACT_STATIC tag is set to YES all static members of a file 240 # will be included in the documentation. 241 242 EXTRACT_STATIC = YES 243 244 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 245 # defined locally in source files will be included in the documentation. 246 # If set to NO only classes defined in header files are included. 247 248 EXTRACT_LOCAL_CLASSES = YES 249 250 # This flag is only useful for Objective-C code. When set to YES local 251 # methods, which are defined in the implementation section but not in 252 # the interface are included in the documentation. 253 # If set to NO (the default) only methods in the interface are included. 254 255 EXTRACT_LOCAL_METHODS = NO 256 257 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 258 # undocumented members of documented classes, files or namespaces. 259 # If set to NO (the default) these members will be included in the 260 # various overviews, but no documentation section is generated. 261 # This option has no effect if EXTRACT_ALL is enabled. 262 263 HIDE_UNDOC_MEMBERS = NO 264 265 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 266 # undocumented classes that are normally visible in the class hierarchy. 267 # If set to NO (the default) these classes will be included in the various 268 # overviews. This option has no effect if EXTRACT_ALL is enabled. 269 270 HIDE_UNDOC_CLASSES = NO 271 272 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 273 # friend (class|struct|union) declarations. 274 # If set to NO (the default) these declarations will be included in the 364 HIDE_FRIEND_COMPOUNDS = NO 365 366 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 367 # documentation blocks found inside the body of a function. 368 # If set to NO (the default) these blocks will be appended to the 369 # function's detailed documentation block. 370 371 HIDE_IN_BODY_DOCS = NO 372 373 # The INTERNAL_DOCS tag determines if documentation 374 # that is typed after a \internal command is included. If the tag is set 375 # to NO (the default) then the documentation will be excluded. 376 # Set it to YES to include the internal documentation. 377 378 INTERNAL_DOCS = NO 379 380 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 381 # file names in lower-case letters. If set to YES upper-case letters are also 382 # allowed. This is useful if you have classes or files whose names only differ 383 # in case and if your file system supports case sensitive file names. Windows 384 # and Mac users are advised to set this option to NO. 385 386 CASE_SENSE_NAMES = NO 387 388 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 389 # will show members with their full class and namespace scopes in the 390 # documentation. If set to YES the scope will be hidden. 391 392 HIDE_SCOPE_NAMES = NO 393 394 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 395 # will put a list of the files that are included by a file in the documentation 396 # of that file. 397 398 SHOW_INCLUDE_FILES = YES 399 400 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 401 # will list include files with double quotes in the documentation 402 # rather than with sharp brackets. 403 404 FORCE_LOCAL_INCLUDES = NO 405 406 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 407 # is inserted in the documentation for inline members. 408 409 INLINE_INFO = YES 410 411 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 412 # will sort the (detailed) documentation of file and class members 413 # alphabetically by member name. If set to NO the members will appear in 414 # declaration order. 415 416 SORT_MEMBER_DOCS = YES 417 418 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 419 # brief documentation of file, namespace and class members alphabetically 420 # by member name. If set to NO (the default) the members will appear in 421 # declaration order. 422 423 SORT_BRIEF_DOCS = YES 424 425 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 426 427 SORT_MEMBERS_CTORS_1ST = YES 428 429 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 430 # hierarchy of group names into alphabetical order. If set to NO (the default) 431 # the group names will appear in their defined order. 432 433 SORT_GROUP_NAMES = NO 434 435 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 436 # sorted by fully-qualified names, including namespaces. If set to 437 # NO (the default), the class list will be sorted only by class name, 438 # not including the namespace part. 439 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 440 # Note: This option applies only to the class list, not to the 441 # alphabetical list. 442 443 SORT_BY_SCOPE_NAME = YES 444 445 # The GENERATE_TODOLIST tag can be used to enable (YES) or 446 # disable (NO) the todo list. This list is created by putting \todo 447 # commands in the documentation. 448 449 GENERATE_TODOLIST = YES 450 451 # The GENERATE_TESTLIST tag can be used to enable (YES) or 452 # disable (NO) the test list. This list is created by putting \test 453 # commands in the documentation. 454 455 GENERATE_TESTLIST = YES 456 457 # The GENERATE_BUGLIST tag can be used to enable (YES) or 458 # disable (NO) the bug list. This list is created by putting \bug 459 # commands in the documentation. 460 461 GENERATE_BUGLIST = YES 462 463 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 464 # disable (NO) the deprecated list. This list is created by putting 465 # \deprecated commands in the documentation. 466 467 GENERATE_DEPRECATEDLIST= YES 468 469 # The ENABLED_SECTIONS tag can be used to enable conditional 470 # documentation sections, marked by \if sectionname ... \endif. 471 472 ENABLED_SECTIONS = 473 474 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 475 # the initial value of a variable or define consists of for it to appear in 476 # the documentation. If the initializer consists of more lines than specified 477 # here it will be hidden. Use a value of 0 to hide initializers completely. 478 # The appearance of the initializer of individual variables and defines in the 479 # documentation can be controlled using \showinitializer or \hideinitializer 480 # command in the documentation regardless of this setting. 481 482 MAX_INITIALIZER_LINES = 30 483 484 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 485 # at the bottom of the documentation of classes and structs. If set to YES the 486 # list will mention the files that were used to generate the documentation. 487 488 SHOW_USED_FILES = YES 489 490 # If the sources in your project are distributed over multiple directories 491 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 492 # in the documentation. The default is NO. 493 494 SHOW_DIRECTORIES = YES 495 496 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 497 # This will remove the Files entry from the Quick Index and from the 498 # Folder Tree View (if specified). The default is YES. 499 500 SHOW_FILES = YES 501 502 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 503 # Namespaces page. 504 # This will remove the Namespaces entry from the Quick Index 505 # and from the Folder Tree View (if specified). The default is YES. 506 507 SHOW_NAMESPACES = YES 508 509 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 510 # doxygen should invoke to get the current version for each file (typically from 511 # the version control system). Doxygen will invoke the program by executing (via 512 # popen()) the command <command> <input-file>, where <command> is the value of 513 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 514 # provided by doxygen. Whatever the program writes to standard output 515 # is used as the file version. See the manual for examples. 516 517 FILE_VERSION_FILTER = 518 519 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 520 # doxygen. The layout file controls the global structure of the generated output files 521 # in an output format independent way. The create the layout file that represents 522 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a 523 # file name after the option, if omitted DoxygenLayout.xml will be used as the name 524 # of the layout file. 525 526 LAYOUT_FILE = 527 528 #--------------------------------------------------------------------------- 529 # configuration options related to warning and progress messages 530 #--------------------------------------------------------------------------- 531 532 # The QUIET tag can be used to turn on/off the messages that are generated 533 # by doxygen. Possible values are YES and NO. If left blank NO is used. 534 535 QUIET = NO 536 537 # The WARNINGS tag can be used to turn on/off the warning messages that are 538 # generated by doxygen. Possible values are YES and NO. If left blank 539 # NO is used. 540 541 WARNINGS = YES 542 543 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 544 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 545 # automatically be disabled. 546 547 WARN_IF_UNDOCUMENTED = YES 548 549 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 550 # potential errors in the documentation, such as not documenting some 551 # parameters in a documented function, or documenting parameters that 552 # don't exist or using markup commands wrongly. 553 554 WARN_IF_DOC_ERROR = YES 555 556 # This WARN_NO_PARAMDOC option can be abled to get warnings for 557 # functions that are documented, but have no documentation for their parameters 558 # or return value. If set to NO (the default) doxygen will only warn about 559 # wrong or incomplete parameter documentation, but not about the absence of 275 560 # documentation. 276 561 277 HIDE_FRIEND_COMPOUNDS = NO278 279 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any280 # documentation blocks found inside the body of a function.281 # If set to NO (the default) these blocks will be appended to the282 # function's detailed documentation block.283 284 HIDE_IN_BODY_DOCS = NO285 286 # The INTERNAL_DOCS tag determines if documentation287 # that is typed after a \internal command is included. If the tag is set288 # to NO (the default) then the documentation will be excluded.289 # Set it to YES to include the internal documentation.290 291 INTERNAL_DOCS = NO292 293 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate294 # file names in lower-case letters. If set to YES upper-case letters are also295 # allowed. This is useful if you have classes or files whose names only differ296 # in case and if your file system supports case sensitive file names. Windows297 # and Mac users are advised to set this option to NO.298 299 CASE_SENSE_NAMES = YES300 301 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen302 # will show members with their full class and namespace scopes in the303 # documentation. If set to YES the scope will be hidden.304 305 HIDE_SCOPE_NAMES = NO306 307 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen308 # will put a list of the files that are included by a file in the documentation309 # of that file.310 311 SHOW_INCLUDE_FILES = YES312 313 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]314 # is inserted in the documentation for inline members.315 316 INLINE_INFO = YES317 318 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen319 # will sort the (detailed) documentation of file and class members320 # alphabetically by member name. If set to NO the members will appear in321 # declaration order.322 323 SORT_MEMBER_DOCS = YES324 325 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the326 # brief documentation of file, namespace and class members alphabetically327 # by member name. If set to NO (the default) the members will appear in328 # declaration order.329 330 SORT_BRIEF_DOCS = YES331 332 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be333 # sorted by fully-qualified names, including namespaces. If set to334 # NO (the default), the class list will be sorted only by class name,335 # not including the namespace part.336 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.337 # Note: This option applies only to the class list, not to the338 # alphabetical list.339 340 SORT_BY_SCOPE_NAME = NO341 342 # The GENERATE_TODOLIST tag can be used to enable (YES) or343 # disable (NO) the todo list. This list is created by putting \todo344 # commands in the documentation.345 346 GENERATE_TODOLIST = YES347 348 # The GENERATE_TESTLIST tag can be used to enable (YES) or349 # disable (NO) the test list. This list is created by putting \test350 # commands in the documentation.351 352 GENERATE_TESTLIST = YES353 354 # The GENERATE_BUGLIST tag can be used to enable (YES) or355 # disable (NO) the bug list. This list is created by putting \bug356 # commands in the documentation.357 358 GENERATE_BUGLIST = YES359 360 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or361 # disable (NO) the deprecated list. This list is created by putting362 # \deprecated commands in the documentation.363 364 GENERATE_DEPRECATEDLIST= YES365 366 # The ENABLED_SECTIONS tag can be used to enable conditional367 # documentation sections, marked by \if sectionname ... \endif.368 369 ENABLED_SECTIONS = YES370 371 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines372 # the initial value of a variable or define consists of for it to appear in373 # the documentation. If the initializer consists of more lines than specified374 # here it will be hidden. Use a value of 0 to hide initializers completely.375 # The appearance of the initializer of individual variables and defines in the376 # documentation can be controlled using \showinitializer or \hideinitializer377 # command in the documentation regardless of this setting.378 379 MAX_INITIALIZER_LINES = 30380 381 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated382 # at the bottom of the documentation of classes and structs. If set to YES the383 # list will mention the files that were used to generate the documentation.384 385 SHOW_USED_FILES = YES386 387 # If the sources in your project are distributed over multiple directories388 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy389 # in the documentation. The default is YES.390 391 SHOW_DIRECTORIES = YES392 393 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.394 # This will remove the Files entry from the Quick Index and from the Folder395 # Tree View (if specified). The default is YES.396 397 SHOW_FILES = YES398 399 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the400 # Namespaces page. This will remove the Namespaces entry from the Quick Index401 # and from the Folder Tree View (if specified). The default is YES.402 403 SHOW_NAMESPACES = YES404 405 # The FILE_VERSION_FILTER tag can be used to specify a program or script that406 # doxygen should invoke to get the current version for each file (typically from the407 # version control system). Doxygen will invoke the program by executing (via408 # popen()) the command <command> <input-file>, where <command> is the value of409 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file410 # provided by doxygen. Whatever the program writes to standard output411 # is used as the file version. See the manual for examples.412 413 FILE_VERSION_FILTER =414 415 #---------------------------------------------------------------------------416 # configuration options related to warning and progress messages417 #---------------------------------------------------------------------------418 419 # The QUIET tag can be used to turn on/off the messages that are generated420 # by doxygen. Possible values are YES and NO. If left blank NO is used.421 422 QUIET = NO423 424 # The WARNINGS tag can be used to turn on/off the warning messages that are425 # generated by doxygen. Possible values are YES and NO. If left blank426 # NO is used.427 428 WARNINGS = YES429 430 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings431 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will432 # automatically be disabled.433 434 WARN_IF_UNDOCUMENTED = YES435 436 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for437 # potential errors in the documentation, such as not documenting some438 # parameters in a documented function, or documenting parameters that439 # don't exist or using markup commands wrongly.440 441 WARN_IF_DOC_ERROR = YES442 443 # This WARN_NO_PARAMDOC option can be abled to get warnings for444 # functions that are documented, but have no documentation for their parameters445 # or return value. If set to NO (the default) doxygen will only warn about446 # wrong or incomplete parameter documentation, but not about the absence of447 # documentation.448 449 562 WARN_NO_PARAMDOC = NO 450 563 451 # The WARN_FORMAT tag determines the format of the warning messages that 452 # doxygen can produce. The string should contain the $file, $line, and $text 453 # tags, which will be replaced by the file and line number from which the 454 # warning originated and the warning text. Optionally the format may contain 455 # $version, which will be replaced by the version of the file (if it could 564 # The WARN_FORMAT tag determines the format of the warning messages that 565 # doxygen can produce. The string should contain the $file, $line, and $text 566 # tags, which will be replaced by the file and line number from which the 567 # warning originated and the warning text. Optionally the format may contain 568 # $version, which will be replaced by the version of the file (if it could 456 569 # be obtained via FILE_VERSION_FILTER) 457 570 458 571 WARN_FORMAT = @DOXY_WARN_FORMAT@ 459 572 460 # The WARN_LOGFILE tag can be used to specify a file to which warning 461 # and error messages should be written. If left blank the output is written 573 # The WARN_LOGFILE tag can be used to specify a file to which warning 574 # and error messages should be written. If left blank the output is written 462 575 # to stderr. 463 576 … … 468 581 #--------------------------------------------------------------------------- 469 582 470 # The INPUT tag can be used to specify the files and/or directories that contain 471 # documented source files. You may enter file names like "myfile.cpp" or 472 # directories like "/usr/src/myproject". Separate the files or directories 583 # The INPUT tag can be used to specify the files and/or directories that contain 584 # documented source files. You may enter file names like "myfile.cpp" or 585 # directories like "/usr/src/myproject". Separate the files or directories 473 586 # with spaces. 474 587 … … 476 589 @CMAKE_CURRENT_SOURCE_DIR@ \ 477 590 @CMAKE_BINARY_DIR@/src/OrxonoxConfig.h \ 478 @CMAKE_BINARY_DIR@/src/SpecialConfig.h 479 480 # If the value of the INPUT tag contains directories, you can use the 481 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 482 # and *.h) to filter out the source-files in the directories. If left 483 # blank the following patterns are tested: 484 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 485 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 591 @CMAKE_BINARY_DIR@/src/SpecialConfig.h \ 592 @INTERNAL_DOCFILE@ 593 594 # This tag can be used to specify the character encoding of the source files 595 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 596 # also the default input encoding. Doxygen uses libiconv (or the iconv built 597 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 598 # the list of possible encodings. 599 600 INPUT_ENCODING = UTF-8 601 602 # If the value of the INPUT tag contains directories, you can use the 603 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 604 # and *.h) to filter out the source-files in the directories. If left 605 # blank the following patterns are tested: 606 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 607 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 486 608 487 609 FILE_PATTERNS = *.cpp \ … … 492 614 *.dox 493 615 494 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 495 # should be searched for input files as well. Possible values are YES and NO. 616 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 617 # should be searched for input files as well. Possible values are YES and NO. 496 618 # If left blank NO is used. 497 619 498 620 RECURSIVE = YES 499 621 500 # The EXCLUDE tag can be used to specify files and/or directories that should 501 # excluded from the INPUT source files. This way you can easily exclude a 622 # The EXCLUDE tag can be used to specify files and/or directories that should 623 # excluded from the INPUT source files. This way you can easily exclude a 502 624 # subdirectory from a directory tree whose root is specified with the INPUT tag. 503 625 504 EXCLUDE = @CMAKE_SOURCE_DIR@/src/external/bullet/ 505 506 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 507 # directories that are symbolic links (a Unix filesystem feature) are excluded 626 EXCLUDE = @CMAKE_SOURCE_DIR@/src/external/bullet/ \ 627 @CMAKE_SOURCE_DIR@/src/external/cpptcl/ \ 628 @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.5.0 \ 629 @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.6.0 \ 630 @CMAKE_SOURCE_DIR@/src/external/ceguilua/ceguilua-0.6.1 \ 631 @CMAKE_SOURCE_DIR@/src/libraries/core/command/IOConsoleWindows.h \ 632 @CMAKE_SOURCE_DIR@/src/libraries/core/command/IOConsoleWindows.cc \ 633 @CMAKE_SOURCE_DIR@/src/libraries/tools/bsp \ 634 635 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 636 # directories that are symbolic links (a Unix filesystem feature) are excluded 508 637 # from the input. 509 638 510 639 EXCLUDE_SYMLINKS = NO 511 640 512 # If the value of the INPUT tag contains directories, you can use the 513 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 514 # certain files from those directories. Note that the wildcards are matched 515 # against the file with absolute path, so to exclude all test directories 641 # If the value of the INPUT tag contains directories, you can use the 642 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 643 # certain files from those directories. Note that the wildcards are matched 644 # against the file with absolute path, so to exclude all test directories 516 645 # for example use the pattern */test/* 517 646 518 647 EXCLUDE_PATTERNS = */.svn/* 519 648 520 # The EXAMPLE_PATH tag can be used to specify one or more files or 521 # directories that contain example code fragments that are included (see 649 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 650 # (namespaces, classes, functions, etc.) that should be excluded from the 651 # output. The symbol name can be a fully qualified name, a word, or if the 652 # wildcard * is used, a substring. Examples: ANamespace, AClass, 653 # AClass::ANamespace, ANamespace::*Test 654 655 EXCLUDE_SYMBOLS = orxonox::detail 656 657 # The EXAMPLE_PATH tag can be used to specify one or more files or 658 # directories that contain example code fragments that are included (see 522 659 # the \include command). 523 660 524 661 EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples/ 525 662 526 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 527 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 528 # and *.h) to filter out the source-files in the directories. If left 663 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 664 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 665 # and *.h) to filter out the source-files in the directories. If left 529 666 # blank all files are included. 530 667 … … 535 672 INSTALL DEPENDENCIES CHANGELOG LICENSE LGPL 536 673 537 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 538 # searched for input files to be used with the \include or \dontinclude 539 # commands irrespective of the value of the RECURSIVE tag. 674 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 675 # searched for input files to be used with the \include or \dontinclude 676 # commands irrespective of the value of the RECURSIVE tag. 540 677 # Possible values are YES and NO. If left blank NO is used. 541 678 542 679 EXAMPLE_RECURSIVE = YES 543 680 544 # The IMAGE_PATH tag can be used to specify one or more files or 545 # directories that contain image that are included in the documentation (see 681 # The IMAGE_PATH tag can be used to specify one or more files or 682 # directories that contain image that are included in the documentation (see 546 683 # the \image command). 547 684 548 685 IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/images/ 549 686 550 551 # The INPUT_FILTER tag can be used to specify a program that doxygen should552 # invoke to filter for each input file. Doxygen will invoke the filter program553 # by executing (via popen()) the command <filter> <input-file>, where <filter>554 # i s the value of the INPUT_FILTER tag, and <input-file> is the name of an555 # input file. Doxygen will then use the output that the filter program writes556 # to standard output. If FILTER_PATTERNS is specified, this tag will be687 # The INPUT_FILTER tag can be used to specify a program that doxygen should 688 # invoke to filter for each input file. Doxygen will invoke the filter program 689 # by executing (via popen()) the command <filter> <input-file>, where <filter> 690 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 691 # input file. Doxygen will then use the output that the filter program writes 692 # to standard output. 693 # If FILTER_PATTERNS is specified, this tag will be 557 694 # ignored. 558 695 559 INPUT_FILTER = 560 561 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 562 # basis. Doxygen will compare the file name with each pattern and apply the 563 # filter if there is a match. The filters are a list of the form: 564 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 565 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 696 INPUT_FILTER = 697 698 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 699 # basis. 700 # Doxygen will compare the file name with each pattern and apply the 701 # filter if there is a match. 702 # The filters are a list of the form: 703 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 704 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 566 705 # is applied to all files. 567 706 568 FILTER_PATTERNS = 569 570 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 571 # INPUT_FILTER) will be used to filter the input files when producing source 707 FILTER_PATTERNS = 708 709 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 710 # INPUT_FILTER) will be used to filter the input files when producing source 572 711 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 573 712 … … 578 717 #--------------------------------------------------------------------------- 579 718 580 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 581 # be generated. Documented entities will be cross-referenced with these sources. 582 # Note: To get rid of all source code in the generated output, make sure also 719 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 720 # be generated. Documented entities will be cross-referenced with these sources. 721 # Note: To get rid of all source code in the generated output, make sure also 583 722 # VERBATIM_HEADERS is set to NO. 584 723 585 724 SOURCE_BROWSER = NO 586 725 587 # Setting the INLINE_SOURCES tag to YES will include the body 726 # Setting the INLINE_SOURCES tag to YES will include the body 588 727 # of functions and classes directly in the documentation. 589 728 590 729 INLINE_SOURCES = NO 591 730 592 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 593 # doxygen to hide any special comment blocks from generated source code 731 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 732 # doxygen to hide any special comment blocks from generated source code 594 733 # fragments. Normal C and C++ comments will always remain visible. 595 734 596 735 STRIP_CODE_COMMENTS = YES 597 736 598 # If the REFERENCED_BY_RELATION tag is set to YES (the default)599 # then for each documented function all documented 737 # If the REFERENCED_BY_RELATION tag is set to YES 738 # then for each documented function all documented 600 739 # functions referencing it will be listed. 601 740 602 REFERENCED_BY_RELATION = YES603 604 # If the REFERENCES_RELATION tag is set to YES (the default)605 # then for each documented function all documented entities 741 REFERENCED_BY_RELATION = NO 742 743 # If the REFERENCES_RELATION tag is set to YES 744 # then for each documented function all documented entities 606 745 # called/used by that function will be listed. 607 746 608 REFERENCES_RELATION = YES 609 610 # If the USE_HTAGS tag is set to YES then the references to source code 611 # will point to the HTML generated by the htags(1) tool instead of doxygen 612 # built-in source browser. The htags tool is part of GNU's global source 613 # tagging system (see http://www.gnu.org/software/global/global.html). You 747 REFERENCES_RELATION = NO 748 749 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 750 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 751 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 752 # link to the source code. 753 # Otherwise they will link to the documentation. 754 755 REFERENCES_LINK_SOURCE = YES 756 757 # If the USE_HTAGS tag is set to YES then the references to source code 758 # will point to the HTML generated by the htags(1) tool instead of doxygen 759 # built-in source browser. The htags tool is part of GNU's global source 760 # tagging system (see http://www.gnu.org/software/global/global.html). You 614 761 # will need version 4.8.6 or higher. 615 762 616 763 USE_HTAGS = NO 617 764 618 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 619 # will generate a verbatim copy of the header file for each class for 765 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 766 # will generate a verbatim copy of the header file for each class for 620 767 # which an include is specified. Set to NO to disable this. 621 768 … … 626 773 #--------------------------------------------------------------------------- 627 774 628 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 629 # of all compounds will be generated. Enable this if the project 775 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 776 # of all compounds will be generated. Enable this if the project 630 777 # contains a lot of classes, structs, unions or interfaces. 631 778 632 779 ALPHABETICAL_INDEX = YES 633 780 634 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 635 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 781 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 782 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 636 783 # in which this list will be split (can be a number in the range [1..20]) 637 784 638 785 COLS_IN_ALPHA_INDEX = 2 639 786 640 # In case all classes in a project start with a common prefix, all 641 # classes will be put under the same header in the alphabetical index. 642 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 787 # In case all classes in a project start with a common prefix, all 788 # classes will be put under the same header in the alphabetical index. 789 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 643 790 # should be ignored while generating the index headers. 644 791 645 IGNORE_PREFIX = 792 IGNORE_PREFIX = 646 793 647 794 #--------------------------------------------------------------------------- … … 649 796 #--------------------------------------------------------------------------- 650 797 651 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 798 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 652 799 # generate HTML output. 653 800 654 801 GENERATE_HTML = YES 655 802 656 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 657 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 803 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 804 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 658 805 # put in front of it. If left blank `html' will be used as the default path. 659 806 660 807 HTML_OUTPUT = html 661 808 662 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 663 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 809 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 810 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 664 811 # doxygen will generate files with .html extension. 665 812 666 813 HTML_FILE_EXTENSION = .html 667 814 668 # The HTML_HEADER tag can be used to specify a personal HTML header for 669 # each generated HTML page. If it is left blank doxygen will generate a 815 # The HTML_HEADER tag can be used to specify a personal HTML header for 816 # each generated HTML page. If it is left blank doxygen will generate a 670 817 # standard header. 671 HTML_HEADER = 672 673 674 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 675 # each generated HTML page. If it is left blank doxygen will generate a 818 819 HTML_HEADER = 820 821 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 822 # each generated HTML page. If it is left blank doxygen will generate a 676 823 # standard footer. 677 824 678 HTML_FOOTER = 679 680 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 681 # style sheet that is used by each HTML page. It can be used to 682 # fine-tune the look of the HTML output. If the tag is left blank doxygen 683 # will generate a default style sheet. Note that doxygen will try to copy 684 # the style sheet file to the HTML output directory, so don't put your own 825 HTML_FOOTER = 826 827 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 828 # style sheet that is used by each HTML page. It can be used to 829 # fine-tune the look of the HTML output. If the tag is left blank doxygen 830 # will generate a default style sheet. Note that doxygen will try to copy 831 # the style sheet file to the HTML output directory, so don't put your own 685 832 # stylesheet in the HTML output directory as well, or it will be erased! 686 833 687 HTML_STYLESHEET = 688 689 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 690 # files or namespaces will be aligned in HTML using tables. If set to 834 HTML_STYLESHEET = 835 836 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 837 # page will contain the date and time when the page was generated. Setting 838 # this to NO can help when comparing the output of multiple runs. 839 840 HTML_TIMESTAMP = YES 841 842 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 843 # files or namespaces will be aligned in HTML using tables. If set to 691 844 # NO a bullet list will be used. 692 845 693 846 HTML_ALIGN_MEMBERS = YES 694 847 695 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 696 # will be generated that can be used as input for tools like the 697 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 848 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 849 # documentation will contain sections that can be hidden and shown after the 850 # page has loaded. For this to work a browser that supports 851 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 852 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 853 854 HTML_DYNAMIC_SECTIONS = NO 855 856 # If the GENERATE_DOCSET tag is set to YES, additional index files 857 # will be generated that can be used as input for Apple's Xcode 3 858 # integrated development environment, introduced with OSX 10.5 (Leopard). 859 # To create a documentation set, doxygen will generate a Makefile in the 860 # HTML output directory. Running make will produce the docset in that 861 # directory and running "make install" will install the docset in 862 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 863 # it at startup. 864 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 865 866 GENERATE_DOCSET = NO 867 868 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 869 # feed. A documentation feed provides an umbrella under which multiple 870 # documentation sets from a single provider (such as a company or product suite) 871 # can be grouped. 872 873 DOCSET_FEEDNAME = "Doxygen generated docs" 874 875 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 876 # should uniquely identify the documentation set bundle. This should be a 877 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 878 # will append .docset to the name. 879 880 DOCSET_BUNDLE_ID = org.doxygen.Project 881 882 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 883 # will be generated that can be used as input for tools like the 884 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 698 885 # of the generated HTML documentation. 699 886 700 887 GENERATE_HTMLHELP = YES 701 888 702 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 703 # be used to specify the file name of the resulting .chm file. You 704 # can add a path in front of the file if the result should not be 889 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 890 # be used to specify the file name of the resulting .chm file. You 891 # can add a path in front of the file if the result should not be 705 892 # written to the html output directory. 706 893 707 CHM_FILE = 708 709 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 710 # be used to specify the location (absolute path including file name) of 711 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 894 CHM_FILE = 895 896 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 897 # be used to specify the location (absolute path including file name) of 898 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 712 899 # the HTML help compiler on the generated index.hhp. 713 900 714 HHC_LOCATION = 715 716 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 717 # controls if a separate .chi index file is generated (YES) or that 901 HHC_LOCATION = 902 903 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 904 # controls if a separate .chi index file is generated (YES) or that 718 905 # it should be included in the master .chm file (NO). 719 906 720 907 GENERATE_CHI = NO 721 908 722 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 723 # controls whether a binary table of contents is generated (YES) or a 909 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 910 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 911 # content. 912 913 CHM_INDEX_ENCODING = 914 915 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 916 # controls whether a binary table of contents is generated (YES) or a 724 917 # normal table of contents (NO) in the .chm file. 725 918 726 919 BINARY_TOC = NO 727 920 728 # The TOC_EXPAND flag can be set to YES to add extra items for group members 921 # The TOC_EXPAND flag can be set to YES to add extra items for group members 729 922 # to the contents of the HTML help documentation and to the tree view. 730 923 731 924 TOC_EXPAND = NO 732 925 733 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 734 # top of each HTML page. The value NO (the default) enables the index and 926 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 927 # are set, an additional index file will be generated that can be used as input for 928 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 929 # HTML documentation. 930 931 GENERATE_QHP = NO 932 933 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 934 # be used to specify the file name of the resulting .qch file. 935 # The path specified is relative to the HTML output folder. 936 937 QCH_FILE = 938 939 # The QHP_NAMESPACE tag specifies the namespace to use when generating 940 # Qt Help Project output. For more information please see 941 # http://doc.trolltech.com/qthelpproject.html#namespace 942 943 QHP_NAMESPACE = org.doxygen.Project 944 945 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 946 # Qt Help Project output. For more information please see 947 # http://doc.trolltech.com/qthelpproject.html#virtual-folders 948 949 QHP_VIRTUAL_FOLDER = doc 950 951 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 952 # For more information please see 953 # http://doc.trolltech.com/qthelpproject.html#custom-filters 954 955 QHP_CUST_FILTER_NAME = 956 957 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 958 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 959 960 QHP_CUST_FILTER_ATTRS = 961 962 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 963 # filter section matches. 964 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 965 966 QHP_SECT_FILTER_ATTRS = 967 968 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 969 # be used to specify the location of Qt's qhelpgenerator. 970 # If non-empty doxygen will try to run qhelpgenerator on the generated 971 # .qhp file. 972 973 QHG_LOCATION = 974 975 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 976 # will be generated, which together with the HTML files, form an Eclipse help 977 # plugin. To install this plugin and make it available under the help contents 978 # menu in Eclipse, the contents of the directory containing the HTML and XML 979 # files needs to be copied into the plugins directory of eclipse. The name of 980 # the directory within the plugins directory should be the same as 981 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. 982 983 GENERATE_ECLIPSEHELP = NO 984 985 # A unique identifier for the eclipse help plugin. When installing the plugin 986 # the directory name containing the HTML and XML files should also have 987 # this name. 988 989 ECLIPSE_DOC_ID = org.doxygen.Project 990 991 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 992 # top of each HTML page. The value NO (the default) enables the index and 735 993 # the value YES disables it. 736 994 737 995 DISABLE_INDEX = NO 738 996 739 # This tag can be used to set the number of enum values (range [1..20]) 997 # This tag can be used to set the number of enum values (range [1..20]) 740 998 # that doxygen will group on one line in the generated HTML documentation. 741 999 742 1000 ENUM_VALUES_PER_LINE = 4 743 1001 744 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 745 # generated containing a tree-like index structure (just like the one that 746 # is generated for HTML Help). For this to work a browser that supports 747 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 748 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 749 # probably better off using the HTML help feature. 1002 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1003 # structure should be generated to display hierarchical information. 1004 # If the tag value is set to YES, a side panel will be generated 1005 # containing a tree-like index structure (just like the one that 1006 # is generated for HTML Help). For this to work a browser that supports 1007 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1008 # Windows users are probably better off using the HTML help feature. 750 1009 751 1010 GENERATE_TREEVIEW = NO 752 1011 753 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 754 # used to set the initial width (in pixels) of the frame in which the tree 1012 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 1013 # and Class Hierarchy pages using a tree view instead of an ordered list. 1014 1015 USE_INLINE_TREES = NO 1016 1017 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1018 # used to set the initial width (in pixels) of the frame in which the tree 755 1019 # is shown. 756 1020 757 1021 TREEVIEW_WIDTH = 250 758 1022 1023 # Use this tag to change the font size of Latex formulas included 1024 # as images in the HTML documentation. The default is 10. Note that 1025 # when you change the font size after a successful doxygen run you need 1026 # to manually remove any form_*.png images from the HTML output directory 1027 # to force them to be regenerated. 1028 1029 FORMULA_FONTSIZE = 10 1030 1031 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript 1032 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should 1033 # typically be disabled. For large projects the javascript based search engine 1034 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1035 1036 SEARCHENGINE = YES 1037 1038 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index 1039 # file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup 1040 # and does not have live searching capabilities. 1041 1042 SERVER_BASED_SEARCH = NO 1043 759 1044 #--------------------------------------------------------------------------- 760 1045 # configuration options related to the LaTeX output 761 1046 #--------------------------------------------------------------------------- 762 1047 763 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1048 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 764 1049 # generate Latex output. 765 1050 766 1051 GENERATE_LATEX = NO 767 1052 768 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 769 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1053 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1054 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 770 1055 # put in front of it. If left blank `latex' will be used as the default path. 771 1056 772 1057 LATEX_OUTPUT = latex 773 1058 774 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1059 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 775 1060 # invoked. If left blank `latex' will be used as the default command name. 776 777 #LATEX_CMD_NAME = latex 778 LATEX_CMD_NAME = @LATEX_COMPILER@ 779 780 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 781 # generate index for LaTeX. If left blank `makeindex' will be used as the 1061 # Note that when enabling USE_PDFLATEX this option is only used for 1062 # generating bitmaps for formulas in the HTML output, but not in the 1063 # Makefile that is written to the output directory. 1064 1065 LATEX_CMD_NAME = @LATEX_COMPILER@ 1066 1067 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1068 # generate index for LaTeX. If left blank `makeindex' will be used as the 782 1069 # default command name. 783 1070 784 #MAKEINDEX_CMD_NAME = makeindex785 1071 MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@ 786 1072 787 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 788 # LaTeX documents. This may be useful for small projects and may help to 1073 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1074 # LaTeX documents. This may be useful for small projects and may help to 789 1075 # save some trees in general. 790 1076 791 1077 COMPACT_LATEX = NO 792 1078 793 # The PAPER_TYPE tag can be used to set the paper type that is used 794 # by the printer. Possible values are: a4, a4wide, letter, legal and 1079 # The PAPER_TYPE tag can be used to set the paper type that is used 1080 # by the printer. Possible values are: a4, a4wide, letter, legal and 795 1081 # executive. If left blank a4wide will be used. 796 1082 797 1083 PAPER_TYPE = a4wide 798 1084 799 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1085 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 800 1086 # packages that should be included in the LaTeX output. 801 1087 802 EXTRA_PACKAGES = 803 804 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 805 # the generated latex document. The header should contain everything until 806 # the first chapter. If it is left blank doxygen will generate a 1088 EXTRA_PACKAGES = 1089 1090 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1091 # the generated latex document. The header should contain everything until 1092 # the first chapter. If it is left blank doxygen will generate a 807 1093 # standard header. Notice: only use this tag if you know what you are doing! 808 1094 809 LATEX_HEADER = 810 811 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 812 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 813 # contain links (just like the HTML output) instead of page references 1095 LATEX_HEADER = 1096 1097 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1098 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1099 # contain links (just like the HTML output) instead of page references 814 1100 # This makes the output suitable for online browsing using a pdf viewer. 815 1101 816 1102 PDF_HYPERLINKS = YES 817 1103 818 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 819 # plain latex in the generated Makefile. Set this option to YES to get a 1104 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1105 # plain latex in the generated Makefile. Set this option to YES to get a 820 1106 # higher quality PDF documentation. 821 1107 822 1108 USE_PDFLATEX = YES 823 1109 824 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 825 # command to the generated LaTeX files. This will instruct LaTeX to keep 826 # running if errors occur, instead of asking the user for help. 1110 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1111 # command to the generated LaTeX files. This will instruct LaTeX to keep 1112 # running if errors occur, instead of asking the user for help. 827 1113 # This option is also used when generating formulas in HTML. 828 1114 829 1115 LATEX_BATCHMODE = YES 830 1116 831 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 832 # include the index chapters (such as File Index, Compound Index, etc.) 1117 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1118 # include the index chapters (such as File Index, Compound Index, etc.) 833 1119 # in the output. 834 1120 835 1121 LATEX_HIDE_INDICES = NO 836 1122 1123 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. 1124 1125 LATEX_SOURCE_CODE = NO 1126 837 1127 #--------------------------------------------------------------------------- 838 1128 # configuration options related to the RTF output 839 1129 #--------------------------------------------------------------------------- 840 1130 841 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 842 # The RTF output is optimized for Word 97 and may not look very pretty with 1131 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1132 # The RTF output is optimized for Word 97 and may not look very pretty with 843 1133 # other RTF readers or editors. 844 1134 845 1135 GENERATE_RTF = NO 846 1136 847 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 848 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1137 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1138 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 849 1139 # put in front of it. If left blank `rtf' will be used as the default path. 850 1140 851 1141 RTF_OUTPUT = rtf 852 1142 853 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 854 # RTF documents. This may be useful for small projects and may help to 1143 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1144 # RTF documents. This may be useful for small projects and may help to 855 1145 # save some trees in general. 856 1146 857 1147 COMPACT_RTF = NO 858 1148 859 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 860 # will contain hyperlink fields. The RTF file will 861 # contain links (just like the HTML output) instead of page references. 862 # This makes the output suitable for online browsing using WORD or other 863 # programs which support those fields. 1149 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1150 # will contain hyperlink fields. The RTF file will 1151 # contain links (just like the HTML output) instead of page references. 1152 # This makes the output suitable for online browsing using WORD or other 1153 # programs which support those fields. 864 1154 # Note: wordpad (write) and others do not support links. 865 1155 866 1156 RTF_HYPERLINKS = NO 867 1157 868 # Load stylesheet definitions from file. Syntax is similar to doxygen's 869 # config file, i.e. a series of assignments. You only have to provide 1158 # Load stylesheet definitions from file. Syntax is similar to doxygen's 1159 # config file, i.e. a series of assignments. You only have to provide 870 1160 # replacements, missing definitions are set to their default value. 871 1161 872 RTF_STYLESHEET_FILE = 873 874 # Set optional variables used in the generation of an rtf document. 1162 RTF_STYLESHEET_FILE = 1163 1164 # Set optional variables used in the generation of an rtf document. 875 1165 # Syntax is similar to doxygen's config file. 876 1166 877 RTF_EXTENSIONS_FILE = 1167 RTF_EXTENSIONS_FILE = 878 1168 879 1169 #--------------------------------------------------------------------------- … … 881 1171 #--------------------------------------------------------------------------- 882 1172 883 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1173 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 884 1174 # generate man pages 885 1175 886 1176 GENERATE_MAN = NO 887 1177 888 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 889 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1178 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1179 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 890 1180 # put in front of it. If left blank `man' will be used as the default path. 891 1181 892 1182 MAN_OUTPUT = man 893 1183 894 # The MAN_EXTENSION tag determines the extension that is added to 1184 # The MAN_EXTENSION tag determines the extension that is added to 895 1185 # the generated man pages (default is the subroutine's section .3) 896 1186 897 1187 MAN_EXTENSION = .3 898 1188 899 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 900 # then it will generate one additional man file for each entity 901 # documented in the real man page(s). These additional files 902 # only source the real man page, but without them the man command 1189 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1190 # then it will generate one additional man file for each entity 1191 # documented in the real man page(s). These additional files 1192 # only source the real man page, but without them the man command 903 1193 # would be unable to find the correct page. The default is NO. 904 1194 … … 909 1199 #--------------------------------------------------------------------------- 910 1200 911 # If the GENERATE_XML tag is set to YES Doxygen will 912 # generate an XML file that captures the structure of 1201 # If the GENERATE_XML tag is set to YES Doxygen will 1202 # generate an XML file that captures the structure of 913 1203 # the code including all documentation. 914 1204 915 1205 GENERATE_XML = NO 916 1206 917 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 918 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1207 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1208 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 919 1209 # put in front of it. If left blank `xml' will be used as the default path. 920 1210 921 1211 XML_OUTPUT = xml 922 1212 923 # The XML_SCHEMA tag can be used to specify an XML schema, 924 # which can be used by a validating XML parser to check the 1213 # The XML_SCHEMA tag can be used to specify an XML schema, 1214 # which can be used by a validating XML parser to check the 925 1215 # syntax of the XML files. 926 1216 927 XML_SCHEMA = 928 929 # The XML_DTD tag can be used to specify an XML DTD, 930 # which can be used by a validating XML parser to check the 1217 XML_SCHEMA = 1218 1219 # The XML_DTD tag can be used to specify an XML DTD, 1220 # which can be used by a validating XML parser to check the 931 1221 # syntax of the XML files. 932 1222 933 XML_DTD = 934 935 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 936 # dump the program listings (including syntax highlighting 937 # and cross-referencing information) to the XML output. Note that 1223 XML_DTD = 1224 1225 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1226 # dump the program listings (including syntax highlighting 1227 # and cross-referencing information) to the XML output. Note that 938 1228 # enabling this will significantly increase the size of the XML output. 939 1229 … … 944 1234 #--------------------------------------------------------------------------- 945 1235 946 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 947 # generate an AutoGen Definitions (see autogen.sf.net) file 948 # that captures the structure of the code including all 949 # documentation. Note that this feature is still experimental 1236 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1237 # generate an AutoGen Definitions (see autogen.sf.net) file 1238 # that captures the structure of the code including all 1239 # documentation. Note that this feature is still experimental 950 1240 # and incomplete at the moment. 951 1241 … … 956 1246 #--------------------------------------------------------------------------- 957 1247 958 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 959 # generate a Perl module file that captures the structure of 960 # the code including all documentation. Note that this 961 # feature is still experimental and incomplete at the 1248 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1249 # generate a Perl module file that captures the structure of 1250 # the code including all documentation. Note that this 1251 # feature is still experimental and incomplete at the 962 1252 # moment. 963 1253 964 1254 GENERATE_PERLMOD = NO 965 1255 966 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 967 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1256 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1257 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 968 1258 # to generate PDF and DVI output from the Perl module output. 969 1259 970 1260 PERLMOD_LATEX = NO 971 1261 972 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 973 # nicely formatted so it can be parsed by a human reader. This is useful 974 # if you want to understand what is going on. On the other hand, if this 975 # tag is set to NO the size of the Perl module output will be much smaller 1262 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1263 # nicely formatted so it can be parsed by a human reader. 1264 # This is useful 1265 # if you want to understand what is going on. 1266 # On the other hand, if this 1267 # tag is set to NO the size of the Perl module output will be much smaller 976 1268 # and Perl will parse it just the same. 977 1269 978 1270 PERLMOD_PRETTY = YES 979 1271 980 # The names of the make variables in the generated doxyrules.make file 981 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 982 # This is useful so different doxyrules.make files included by the same 1272 # The names of the make variables in the generated doxyrules.make file 1273 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1274 # This is useful so different doxyrules.make files included by the same 983 1275 # Makefile don't overwrite each other's variables. 984 1276 985 PERLMOD_MAKEVAR_PREFIX = 986 987 #--------------------------------------------------------------------------- 988 # Configuration options related to the preprocessor 989 #--------------------------------------------------------------------------- 990 991 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 992 # evaluate all C-preprocessor directives found in the sources and include 1277 PERLMOD_MAKEVAR_PREFIX = 1278 1279 #--------------------------------------------------------------------------- 1280 # Configuration options related to the preprocessor 1281 #--------------------------------------------------------------------------- 1282 1283 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1284 # evaluate all C-preprocessor directives found in the sources and include 993 1285 # files. 994 1286 995 1287 ENABLE_PREPROCESSING = YES 996 1288 997 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 998 # names in the source code. If set to NO (the default) only conditional 999 # compilation will be performed. Macro expansion can be done in a controlled 1289 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1290 # names in the source code. If set to NO (the default) only conditional 1291 # compilation will be performed. Macro expansion can be done in a controlled 1000 1292 # way by setting EXPAND_ONLY_PREDEF to YES. 1001 1293 1002 MACRO_EXPANSION = YES1003 1004 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1005 # then the macro expansion is limited to the macros specified with the 1294 MACRO_EXPANSION = NO 1295 1296 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1297 # then the macro expansion is limited to the macros specified with the 1006 1298 # PREDEFINED and EXPAND_AS_DEFINED tags. 1007 1299 1008 1300 EXPAND_ONLY_PREDEF = YES 1009 1301 1010 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1302 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1011 1303 # in the INCLUDE_PATH (see below) will be search if a #include is found. 1012 1304 1013 SEARCH_INCLUDES = YES1014 1015 # The INCLUDE_PATH tag can be used to specify one or more directories that 1016 # contain include files that are not input files but should be processed by 1305 SEARCH_INCLUDES = NO 1306 1307 # The INCLUDE_PATH tag can be used to specify one or more directories that 1308 # contain include files that are not input files but should be processed by 1017 1309 # the preprocessor. 1018 1310 1019 INCLUDE_PATH = 1020 1021 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1022 # patterns (like *.h and *.hpp) to filter out the header-files in the 1023 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1311 INCLUDE_PATH = #@DOXYGEN_INCLUDE_DIRECTORIES@ 1312 1313 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1314 # patterns (like *.h and *.hpp) to filter out the header-files in the 1315 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1024 1316 # be used. 1025 1317 1026 INCLUDE_FILE_PATTERNS = 1027 1028 # The PREDEFINED tag can be used to specify one or more macro names that 1029 # are defined before the preprocessor is started (similar to the -D option of 1030 # gcc). The argument of the tag is a list of macros of the form: name 1031 # or name=definition (no spaces). If the definition and the = are 1032 # omitted =1 is assumed. To prevent a macro definition from being 1033 # undefined via #undef or recursively expanded use the := operator 1318 INCLUDE_FILE_PATTERNS = 1319 1320 # The PREDEFINED tag can be used to specify one or more macro names that 1321 # are defined before the preprocessor is started (similar to the -D option of 1322 # gcc). The argument of the tag is a list of macros of the form: name 1323 # or name=definition (no spaces). If the definition and the = are 1324 # omitted =1 is assumed. To prevent a macro definition from being 1325 # undefined via #undef or recursively expanded use the := operator 1034 1326 # instead of the = operator. 1035 1327 1036 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS 1037 1038 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1039 # this tag can be used to specify a list of macro names that should be expanded. 1040 # The macro definition that is found in the sources will be used. 1328 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \ 1329 @DOXY_PLATFORM_DEF@ \ 1330 @DOXY_COMPILER_DEF@ 1331 1332 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1333 # this tag can be used to specify a list of macro names that should be expanded. 1334 # The macro definition that is found in the sources will be used. 1041 1335 # Use the PREDEFINED tag if you want to use a different macro definition. 1042 1336 1043 EXPAND_AS_DEFINED = 1044 1045 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1046 # doxygen's preprocessor will remove all function-like macros that are alone 1047 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1048 # function macros are typically used for boiler-plate code, and will confuse 1337 EXPAND_AS_DEFINED = 1338 1339 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1340 # doxygen's preprocessor will remove all function-like macros that are alone 1341 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1342 # function macros are typically used for boiler-plate code, and will confuse 1049 1343 # the parser if not removed. 1050 1344 … … 1052 1346 1053 1347 #--------------------------------------------------------------------------- 1054 # Configuration::additions related to external references 1055 #--------------------------------------------------------------------------- 1056 1057 # The TAGFILES option can be used to specify one or more tagfiles. 1058 # Optionally an initial location of the external documentation 1059 # can be added for each tagfile. The format of a tag file without 1060 # this location is as follows: 1061 # TAGFILES = file1 file2 ... 1062 # Adding location for the tag files is done as follows: 1063 # TAGFILES = file1=loc1 "file2 = loc2" ... 1064 # where "loc1" and "loc2" can be relative or absolute paths or 1065 # URLs. If a location is present for each tag, the installdox tool 1348 # Configuration::additions related to external references 1349 #--------------------------------------------------------------------------- 1350 1351 # The TAGFILES option can be used to specify one or more tagfiles. 1352 # Optionally an initial location of the external documentation 1353 # can be added for each tagfile. The format of a tag file without 1354 # this location is as follows: 1355 # 1356 # TAGFILES = file1 file2 ... 1357 # Adding location for the tag files is done as follows: 1358 # 1359 # TAGFILES = file1=loc1 "file2 = loc2" ... 1360 # where "loc1" and "loc2" can be relative or absolute paths or 1361 # URLs. If a location is present for each tag, the installdox tool 1066 1362 # does not have to be run to correct the links. 1067 1363 # Note that each tag file must have a unique name 1068 1364 # (where the name does NOT include the path) 1069 # If a tag file is not located in the directory in which doxygen 1365 # If a tag file is not located in the directory in which doxygen 1070 1366 # is run, you must also specify the path to the tagfile here. 1071 1367 1072 TAGFILES = 1073 1074 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1368 TAGFILES = 1369 1370 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1075 1371 # a tag file that is based on the input files it reads. 1076 1372 1077 1373 GENERATE_TAGFILE = @DOXY_OUTPUT_DIR@/html/@PROJECT_NAME@.TAGFILE 1078 1374 1079 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1080 # in the class index. If set to NO only the inherited external classes 1375 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1376 # in the class index. If set to NO only the inherited external classes 1081 1377 # will be listed. 1082 1378 1083 1379 ALLEXTERNALS = NO 1084 1380 1085 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1086 # in the modules index. If set to NO, only the current project's groups will 1381 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1382 # in the modules index. If set to NO, only the current project's groups will 1087 1383 # be listed. 1088 1384 1089 1385 EXTERNAL_GROUPS = YES 1090 1386 1091 # The PERL_PATH should be the absolute path and name of the perl script 1387 # The PERL_PATH should be the absolute path and name of the perl script 1092 1388 # interpreter (i.e. the result of `which perl'). 1093 1389 … … 1095 1391 1096 1392 #--------------------------------------------------------------------------- 1097 # Configuration options related to the dot tool 1098 #--------------------------------------------------------------------------- 1099 1100 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1101 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1102 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1103 # this option is superseded by the HAVE_DOT option below. This is only a 1104 # fallback. It is recommended to install and use dot, since it yields more 1393 # Configuration options related to the dot tool 1394 #--------------------------------------------------------------------------- 1395 1396 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1397 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1398 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1399 # this option is superseded by the HAVE_DOT option below. This is only a 1400 # fallback. It is recommended to install and use dot, since it yields more 1105 1401 # powerful graphs. 1106 1402 1107 1403 CLASS_DIAGRAMS = YES 1108 1404 1109 # If set to YES, the inheritance and collaboration graphs will hide 1110 # inheritance and usage relations if the target is undocumented 1405 # You can define message sequence charts within doxygen comments using the \msc 1406 # command. Doxygen will then run the mscgen tool (see 1407 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1408 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1409 # the mscgen tool resides. If left empty the tool is assumed to be found in the 1410 # default search path. 1411 1412 MSCGEN_PATH = 1413 1414 # If set to YES, the inheritance and collaboration graphs will hide 1415 # inheritance and usage relations if the target is undocumented 1111 1416 # or is not a class. 1112 1417 1113 1418 HIDE_UNDOC_RELATIONS = YES 1114 1419 1115 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1116 # available from the path. This tool is part of Graphviz, a graph visualization 1117 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1420 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1421 # available from the path. This tool is part of Graphviz, a graph visualization 1422 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1118 1423 # have no effect if this option is set to NO (the default) 1119 1424 1120 1425 HAVE_DOT = NO 1121 1426 1122 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1123 # will generate a graph for each documented class showing the direct and 1124 # indirect inheritance relations. Setting this tag to YES will force the 1427 # By default doxygen will write a font called FreeSans.ttf to the output 1428 # directory and reference it in all dot files that doxygen generates. This 1429 # font does not include all possible unicode characters however, so when you need 1430 # these (or just want a differently looking font) you can specify the font name 1431 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1432 # which can be done by putting it in a standard location or by setting the 1433 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1434 # containing the font. 1435 1436 DOT_FONTNAME = FreeSans 1437 1438 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1439 # The default size is 10pt. 1440 1441 DOT_FONTSIZE = 10 1442 1443 # By default doxygen will tell dot to use the output directory to look for the 1444 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1445 # different font using DOT_FONTNAME you can set the path where dot 1446 # can find it using this tag. 1447 1448 DOT_FONTPATH = 1449 1450 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1451 # will generate a graph for each documented class showing the direct and 1452 # indirect inheritance relations. Setting this tag to YES will force the 1125 1453 # the CLASS_DIAGRAMS tag to NO. 1126 1454 1127 1455 CLASS_GRAPH = YES 1128 1456 1129 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1130 # will generate a graph for each documented class showing the direct and 1131 # indirect implementation dependencies (inheritance, containment, and 1457 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1458 # will generate a graph for each documented class showing the direct and 1459 # indirect implementation dependencies (inheritance, containment, and 1132 1460 # class references variables) of the class with other documented classes. 1133 1461 1134 1462 COLLABORATION_GRAPH = YES 1135 1463 1136 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1464 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1137 1465 # will generate a graph for groups, showing the direct groups dependencies 1138 1466 1139 1467 GROUP_GRAPHS = YES 1140 1468 1141 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1142 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1469 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1470 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1143 1471 # Language. 1144 1472 1145 1473 UML_LOOK = NO 1146 1474 1147 # If set to YES, the inheritance and collaboration graphs will show the 1475 # If set to YES, the inheritance and collaboration graphs will show the 1148 1476 # relations between templates and their instances. 1149 1477 1150 1478 TEMPLATE_RELATIONS = NO 1151 1479 1152 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1153 # tags are set to YES then doxygen will generate a graph for each documented 1154 # file showing the direct and indirect include dependencies of the file with 1480 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1481 # tags are set to YES then doxygen will generate a graph for each documented 1482 # file showing the direct and indirect include dependencies of the file with 1155 1483 # other documented files. 1156 1484 1157 1485 INCLUDE_GRAPH = YES 1158 1486 1159 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1160 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1161 # documented header file showing the documented files that directly or 1487 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1488 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1489 # documented header file showing the documented files that directly or 1162 1490 # indirectly include this file. 1163 1491 1164 1492 INCLUDED_BY_GRAPH = YES 1165 1493 1166 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will1167 # generate a call dependency graph for every global function or class method.1168 # Note that enabling this option will significantly increase the time of a run.1169 # So in most cases it will be better to enable call graphs for selected1170 # f unctions only using the \callgraph command.1494 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1495 # doxygen will generate a call dependency graph for every global function 1496 # or class method. Note that enabling this option will significantly increase 1497 # the time of a run. So in most cases it will be better to enable call graphs 1498 # for selected functions only using the \callgraph command. 1171 1499 1172 1500 CALL_GRAPH = NO 1173 1501 1174 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1502 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1503 # doxygen will generate a caller dependency graph for every global function 1504 # or class method. Note that enabling this option will significantly increase 1505 # the time of a run. So in most cases it will be better to enable caller 1506 # graphs for selected functions only using the \callergraph command. 1507 1508 CALLER_GRAPH = NO 1509 1510 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1175 1511 # will graphical hierarchy of all classes instead of a textual one. 1176 1512 1177 1513 GRAPHICAL_HIERARCHY = YES 1178 1514 1179 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1180 # then doxygen will show the dependencies a directory has on other directories 1515 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1516 # then doxygen will show the dependencies a directory has on other directories 1181 1517 # in a graphical way. The dependency relations are determined by the #include 1182 1518 # relations between the files in the directories. … … 1184 1520 DIRECTORY_GRAPH = YES 1185 1521 1186 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1522 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1187 1523 # generated by dot. Possible values are png, jpg, or gif 1188 1524 # If left blank png will be used. … … 1190 1526 DOT_IMAGE_FORMAT = png 1191 1527 1192 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1528 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1193 1529 # found. If left blank, it is assumed the dot tool can be found in the path. 1194 1530 1195 1531 DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@ 1196 1532 1197 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1198 # contain dot files that are included in the documentation (see the 1533 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1534 # contain dot files that are included in the documentation (see the 1199 1535 # \dotfile command). 1200 1536 1201 1537 DOTFILE_DIRS = @CMAKE_CURRENT_SOURCE_DIR@/dot 1202 1538 1203 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1204 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1205 # from the root by following a path via at most 3 edges will be shown. Nodes 1206 # that lay further from the root node will be omitted. Note that setting this 1207 # option to 1 or 2 may greatly reduce the computation time needed for large 1208 # code bases. Also note that a graph may be further truncated if the graph's 1209 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 1210 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 1211 # the graph is not depth-constrained. 1539 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1540 # nodes that will be shown in the graph. If the number of nodes in a graph 1541 # becomes larger than this value, doxygen will truncate the graph, which is 1542 # visualized by representing a node as a red box. Note that doxygen if the 1543 # number of direct children of the root node in a graph is already larger than 1544 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1545 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1546 1547 DOT_GRAPH_MAX_NODES = 50 1548 1549 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1550 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1551 # from the root by following a path via at most 3 edges will be shown. Nodes 1552 # that lay further from the root node will be omitted. Note that setting this 1553 # option to 1 or 2 may greatly reduce the computation time needed for large 1554 # code bases. Also note that the size of a graph can be further restricted by 1555 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1212 1556 1213 1557 MAX_DOT_GRAPH_DEPTH = 1000 1214 1558 1215 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1216 # background. This is disabled by default, which results in a white background.1217 # Warning: Depending on the platform used, enabling this option may lead to1218 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to1219 # read).1559 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1560 # background. This is disabled by default, because dot on Windows does not 1561 # seem to support this out of the box. Warning: Depending on the platform used, 1562 # enabling this option may lead to badly anti-aliased labels on the edges of 1563 # a graph (i.e. they become hard to read). 1220 1564 1221 1565 DOT_TRANSPARENT = NO 1222 1566 1223 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1224 # files in one run (i.e. multiple -o and -T options on the command line). This 1225 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1567 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1568 # files in one run (i.e. multiple -o and -T options on the command line). This 1569 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1226 1570 # support this, this feature is disabled by default. 1227 1571 1228 1572 DOT_MULTI_TARGETS = NO 1229 1573 1230 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1231 # generate a legend page explaining the meaning of the various boxes and 1574 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1575 # generate a legend page explaining the meaning of the various boxes and 1232 1576 # arrows in the dot generated graphs. 1233 1577 1234 1578 GENERATE_LEGEND = YES 1235 1579 1236 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1237 # remove the intermediate dot files that are used to generate 1580 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1581 # remove the intermediate dot files that are used to generate 1238 1582 # the various graphs. 1239 1583 1240 1584 DOT_CLEANUP = YES 1241 1242 #---------------------------------------------------------------------------1243 # Configuration::additions related to the search engine1244 #---------------------------------------------------------------------------1245 1246 # The SEARCHENGINE tag specifies whether or not a search engine should be1247 # used. If set to NO the values of all tags below this one will be ignored.1248 1249 SEARCHENGINE = YES -
code/trunk/doc/api/main.dox
r6417 r7401 1 1 /** 2 @mainpage 3 Orxonox Doxygen Reference 2 @mainpage 3 4 @image html orxonox.jpg 5 6 This is the documentation of Orxonox. It contains descriptions of our classes and functions and 7 explains their usage with several examples and background information. Because Orxonox is so big, 8 we can't document all of our code - sorry for that! But we do your best to document the most 9 important parts of it, namely the @ref Core "core" and @ref Util "util" libraries, as well as the 10 central classes in the @ref Orxonox "orxonox" main library and some @ref Modules "modules". 11 12 To understand the connection between different classes in Orxonox, have a look at the 13 <a href="modules.html"><b>Modules section</b></a>. It contains a list of the most important topics 14 and groups files that contribute to the same feature. 4 15 */
Note: See TracChangeset
for help on using the changeset viewer.