Mercurial > trustbridge > trustbridge

comparison doc/apidoc/Doxyfile.in @ 1254:6d840341bc25

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(issue113) Add mainpage and improve doxyfile
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 25 Sep 2014 17:37:03 +0200
parents 69f7d302cdb9
children
comparison
equal deleted inserted replaced
1253:eb4d7337edd7 1254:6d840341bc25
191 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 191 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
192 # put the command \sideeffect (or @sideeffect) in the documentation, which 192 # put the command \sideeffect (or @sideeffect) in the documentation, which
193 # will result in a user-defined paragraph with heading "Side Effects:". 193 # will result in a user-defined paragraph with heading "Side Effects:".
194 # You can put \n's in the value part of an alias to insert newlines. 194 # You can put \n's in the value part of an alias to insert newlines.
195 195
196 ALIASES = TODO=\todo" 196 ALIASES = "TODO=\todo"
197 197
198 # This tag can be used to specify a number of word-keyword mappings (TCL only). 198 # This tag can be used to specify a number of word-keyword mappings (TCL only).
199 # A mapping has the form "name=value". For example adding 199 # A mapping has the form "name=value". For example adding
200 # "class=itcl::class" will allow you to use the command class in the 200 # "class=itcl::class" will allow you to use the command class in the
201 # itcl::class meaning. 201 # itcl::class meaning.
317 # be useful for C code in case the coding convention dictates that all compound 317 # be useful for C code in case the coding convention dictates that all compound
318 # types are typedef'ed and only the typedef is referenced, never the tag name. 318 # types are typedef'ed and only the typedef is referenced, never the tag name.
319 319
320 TYPEDEF_HIDES_STRUCT = NO 320 TYPEDEF_HIDES_STRUCT = NO
321 321
322 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
323 # determine which symbols to keep in memory and which to flush to disk.
324 # When the cache is full, less often used symbols will be written to disk.
325 # For small to medium size projects (<1000 input files) the default value is
326 # probably good enough. For larger projects a too small cache size can cause
327 # doxygen to be busy swapping symbols to and from disk most of the time
328 # causing a significant performance penalty.
329 # If the system has enough physical memory increasing the cache will improve the
330 # performance by keeping more symbols in memory. Note that the value works on
331 # a logarithmic scale so increasing the size by one will roughly double the
332 # memory usage. The cache size is given by this formula:
333 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
334 # corresponding to a cache size of 2^16 = 65536 symbols.
335
336 SYMBOL_CACHE_SIZE = 0
337 322
338 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 323 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
339 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 324 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
340 # their name and scope. Since this can be an expensive process and often the 325 # their name and scope. Since this can be an expensive process and often the
341 # same symbol appear multiple times in the code, doxygen keeps a cache of 326 # same symbol appear multiple times in the code, doxygen keeps a cache of
653 # The INPUT tag can be used to specify the files and/or directories that contain 638 # The INPUT tag can be used to specify the files and/or directories that contain
654 # documented source files. You may enter file names like "myfile.cpp" or 639 # documented source files. You may enter file names like "myfile.cpp" or
655 # directories like "/usr/src/myproject". Separate the files or directories 640 # directories like "/usr/src/myproject". Separate the files or directories
656 # with spaces. 641 # with spaces.
657 642
658 INPUT = @CMAKE_SOURCE_DIR@/ui @CMAKE_SOURCE_DIR@/common @CMAKE_SOURCE_DIR@/cinst 643 INPUT = @CMAKE_SOURCE_DIR@/ui @CMAKE_SOURCE_DIR@/common @CMAKE_SOURCE_DIR@/cinst @CMAKE_SOURCE_DIR@/doc/apidoc/mainpage.dox @CMAKE_SOURCE_DIR@/INSTALL
659 644
660 # This tag can be used to specify the character encoding of the source files 645 # This tag can be used to specify the character encoding of the source files
661 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 646 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
662 # also the default input encoding. Doxygen uses libiconv (or the iconv built 647 # also the default input encoding. Doxygen uses libiconv (or the iconv built
663 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 648 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
677 662
678 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 663 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
679 # should be searched for input files as well. Possible values are YES and NO. 664 # should be searched for input files as well. Possible values are YES and NO.
680 # If left blank NO is used. 665 # If left blank NO is used.
681 666
682 RECURSIVE = NO 667 RECURSIVE = YES
683 668
684 # The EXCLUDE tag can be used to specify files and/or directories that should be 669 # The EXCLUDE tag can be used to specify files and/or directories that should be
685 # excluded from the INPUT source files. This way you can easily exclude a 670 # excluded from the INPUT source files. This way you can easily exclude a
686 # subdirectory from a directory tree whose root is specified with the INPUT tag. 671 # subdirectory from a directory tree whose root is specified with the INPUT tag.
687 # Note that relative paths are relative to the directory from which doxygen is 672 # Note that relative paths are relative to the directory from which doxygen is
http://wald.intevation.org/projects/trustbridge/