Changeset 880:44bc29442fc0


Ignore:
Timestamp:
06/25/08 23:07:27 (4 years ago)
Author:
niam
Branch:
libdodo
Message:

fixed docs

Files:
5 edited

Legend:

Unmodified
Added
Removed
  • docs/Doxyfile

    r812 r880  
    1 # Doxyfile 1.5.1 
     1# Doxyfile 1.5.5 
     2 
     3# This file describes the settings to be used by the documentation system 
     4# doxygen (www.doxygen.org) for a project 
     5# 
     6# All text after a hash (#) is considered a comment and will be ignored 
     7# The format is: 
     8#       TAG = value [value, ...] 
     9# For lists items can also be appended using: 
     10#       TAG += value [value, ...] 
     11# Values that contain spaces should be placed between quotes (" ") 
    212 
    313#--------------------------------------------------------------------------- 
    414# Project related configuration options 
    515#--------------------------------------------------------------------------- 
     16 
     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 
     23DOXYFILE_ENCODING      = UTF-8 
     24 
     25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded  
     26# by quotes) that should identify the project. 
     27 
    628PROJECT_NAME           = libdodo 
    7 PROJECT_NUMBER         = 0.9.0 
     29 
     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  
     32# if some version control system is used. 
     33 
     34PROJECT_NUMBER         = 0.9.1 
     35 
     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  
     39# where doxygen was started. If left blank the current directory will be used. 
     40 
    841OUTPUT_DIRECTORY       = /mnt/media/projects/workspace/libdodo/docs/ 
    9 CREATE_SUBDIRS         = NO 
     42 
     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  
     48# otherwise cause performance problems for the file system. 
     49 
     50CREATE_SUBDIRS         = YES 
     51 
     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, Farsi, Finnish, French, German, Greek,  
     58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),  
     59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,  
     60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,  
     61# and Ukrainian. 
     62 
    1063OUTPUT_LANGUAGE        = English 
    11 USE_WINDOWS_ENCODING   = NO 
     64 
     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).  
     68# Set to NO to disable this. 
     69 
    1270BRIEF_MEMBER_DESC      = YES 
     71 
     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  
     75# brief descriptions will be completely suppressed. 
     76 
    1377REPEAT_BRIEF           = YES 
     78 
     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"  
     87# "represents" "a" "an" "the" 
     88 
    1489ABBREVIATE_BRIEF       = "The $name class" \ 
    1590                         "The $name widget" \ 
     
    2398                         an \ 
    2499                         the 
     100 
     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  
     103# description. 
     104 
    25105ALWAYS_DETAILED_SEC    = NO 
     106 
     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  
     110# operators of the base classes will not be shown. 
     111 
    26112INLINE_INHERITED_MEMB  = NO 
     113 
     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  
     116# to NO the shortest path that makes the file name unique will be used. 
     117 
    27118FULL_PATH_NAMES        = YES 
     119 
     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  
     125# path to strip. 
     126 
    28127STRIP_FROM_PATH        = /mnt/media/projects/workspace/libdodo/trunk 
     128 
     129# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of  
     130# the path mentioned in the documentation of a class, which tells  
     131# the reader which header file to include in order to use a class.  
     132# If left blank only the name of the header file containing the class  
     133# definition is used. Otherwise one should specify the include paths that  
     134# are normally passed to the compiler using the -I flag. 
     135 
    29136STRIP_FROM_INC_PATH    =  
     137 
     138# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter  
     139# (but less readable) file names. This can be useful is your file systems  
     140# doesn't support long names like on DOS, Mac, or CD-ROM. 
     141 
    30142SHORT_NAMES            = NO 
     143 
     144# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen  
     145# will interpret the first line (until the first dot) of a JavaDoc-style  
     146# comment as the brief description. If set to NO, the JavaDoc  
     147# comments will behave just like regular Qt-style comments  
     148# (thus requiring an explicit @brief command for a brief description.) 
     149 
    31150JAVADOC_AUTOBRIEF      = YES 
     151 
     152# If the QT_AUTOBRIEF tag is set to YES then Doxygen will  
     153# interpret the first line (until the first dot) of a Qt-style  
     154# comment as the brief description. If set to NO, the comments  
     155# will behave just like regular Qt-style comments (thus requiring  
     156# an explicit \brief command for a brief description.) 
     157 
     158QT_AUTOBRIEF           = NO 
     159 
     160# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen  
     161# treat a multi-line C++ special comment block (i.e. a block of //! or ///  
     162# comments) as a brief description. This used to be the default behaviour.  
     163# The new default is to treat a multi-line C++ comment block as a detailed  
     164# description. Set this tag to YES if you prefer the old behaviour instead. 
     165 
    32166MULTILINE_CPP_IS_BRIEF = YES 
     167 
     168# If the DETAILS_AT_TOP tag is set to YES then Doxygen  
     169# will output the detailed description near the top, like JavaDoc. 
     170# If set to NO, the detailed description appears after the member  
     171# documentation. 
     172 
    33173DETAILS_AT_TOP         = YES 
     174 
     175# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented  
     176# member inherits the documentation from any documented member that it  
     177# re-implements. 
     178 
    34179INHERIT_DOCS           = YES 
     180 
     181# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce  
     182# a new page for each member. If set to NO, the documentation of a member will  
     183# be part of the file/class/namespace that contains it. 
     184 
    35185SEPARATE_MEMBER_PAGES  = NO 
    36 TAB_SIZE               = 6 
     186 
     187# The TAB_SIZE tag can be used to set the number of spaces in a tab.  
     188# Doxygen uses this value to replace tabs by spaces in code fragments. 
     189 
     190TAB_SIZE               = 4 
     191 
     192# This tag can be used to specify a number of aliases that acts  
     193# as commands in the documentation. An alias has the form "name=value".  
     194# For example adding "sideeffect=\par Side Effects:\n" will allow you to  
     195# put the command \sideeffect (or @sideeffect) in the documentation, which  
     196# will result in a user-defined paragraph with heading "Side Effects:".  
     197# You can put \n's in the value part of an alias to insert newlines. 
     198 
    37199ALIASES                =  
     200 
     201# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C  
     202# sources only. Doxygen will then generate output that is more tailored for C.  
     203# For instance, some of the names that are used will be different. The list  
     204# of all members will be omitted, etc. 
     205 
    38206OPTIMIZE_OUTPUT_FOR_C  = NO 
     207 
     208# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java  
     209# sources only. Doxygen will then generate output that is more tailored for  
     210# Java. For instance, namespaces will be presented as packages, qualified  
     211# scopes will look different, etc. 
     212 
    39213OPTIMIZE_OUTPUT_JAVA   = NO 
    40 BUILTIN_STL_SUPPORT    = NO 
     214 
     215# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran  
     216# sources only. Doxygen will then generate output that is more tailored for  
     217# Fortran. 
     218 
     219OPTIMIZE_FOR_FORTRAN   = NO 
     220 
     221# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL  
     222# sources. Doxygen will then generate output that is tailored for  
     223# VHDL. 
     224 
     225OPTIMIZE_OUTPUT_VHDL   = NO 
     226 
     227# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want  
     228# to include (a tag file for) the STL sources as input, then you should  
     229# set this tag to YES in order to let doxygen match functions declarations and  
     230# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.  
     231# func(std::string) {}). This also make the inheritance and collaboration  
     232# diagrams that involve STL classes more complete and accurate. 
     233 
     234BUILTIN_STL_SUPPORT    = YES 
     235 
     236# If you use Microsoft's C++/CLI language, you should set this option to YES to 
     237# enable parsing support. 
     238 
     239CPP_CLI_SUPPORT        = NO 
     240 
     241# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.  
     242# Doxygen will parse them like normal C++ but will assume all classes use public  
     243# instead of private inheritance when no explicit protection keyword is present. 
     244 
     245SIP_SUPPORT            = NO 
     246 
     247# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC  
     248# tag is set to YES, then doxygen will reuse the documentation of the first  
     249# member in the group (if any) for the other members of the group. By default  
     250# all members of a group must be documented explicitly. 
     251 
    41252DISTRIBUTE_GROUP_DOC   = NO 
     253 
     254# Set the SUBGROUPING tag to YES (the default) to allow class member groups of  
     255# the same type (for instance a group of public functions) to be put as a  
     256# subgroup of that type (e.g. under the Public Functions section). Set it to  
     257# NO to prevent subgrouping. Alternatively, this can be done per class using  
     258# the \nosubgrouping command. 
     259 
    42260SUBGROUPING            = YES 
     261 
     262# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum  
     263# is documented as struct, union, or enum with the name of the typedef. So  
     264# typedef struct TypeS {} TypeT, will appear in the documentation as a struct  
     265# with name TypeT. When disabled the typedef will appear as a member of a file,  
     266# namespace, or class. And the struct will be named TypeS. This can typically  
     267# be useful for C code in case the coding convention dictates that all compound  
     268# types are typedef'ed and only the typedef is referenced, never the tag name. 
     269 
     270TYPEDEF_HIDES_STRUCT   = NO 
     271 
    43272#--------------------------------------------------------------------------- 
    44273# Build related configuration options 
    45274#--------------------------------------------------------------------------- 
     275 
     276# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in  
     277# documentation are documented, even if no documentation was available.  
     278# Private class members and static file members will be hidden unless  
     279# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 
     280 
    46281EXTRACT_ALL            = YES 
    47 EXTRACT_PRIVATE        = YES 
     282 
     283# If the EXTRACT_PRIVATE tag is set to YES all private members of a class  
     284# will be included in the documentation. 
     285 
     286EXTRACT_PRIVATE        = NO 
     287 
     288# If the EXTRACT_STATIC tag is set to YES all static members of a file  
     289# will be included in the documentation. 
     290 
    48291EXTRACT_STATIC         = YES 
     292 
     293# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)  
     294# defined locally in source files will be included in the documentation.  
     295# If set to NO only classes defined in header files are included. 
     296 
    49297EXTRACT_LOCAL_CLASSES  = YES 
     298 
     299# This flag is only useful for Objective-C code. When set to YES local  
     300# methods, which are defined in the implementation section but not in  
     301# the interface are included in the documentation.  
     302# If set to NO (the default) only methods in the interface are included. 
     303 
    50304EXTRACT_LOCAL_METHODS  = YES 
     305 
     306# If this flag is set to YES, the members of anonymous namespaces will be  
     307# extracted and appear in the documentation as a namespace called  
     308# 'anonymous_namespace{file}', where file will be replaced with the base  
     309# name of the file that contains the anonymous namespace. By default  
     310# anonymous namespace are hidden. 
     311 
     312EXTRACT_ANON_NSPACES   = NO 
     313 
     314# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  
     315# undocumented members of documented classes, files or namespaces.  
     316# If set to NO (the default) these members will be included in the  
     317# various overviews, but no documentation section is generated.  
     318# This option has no effect if EXTRACT_ALL is enabled. 
     319 
    51320HIDE_UNDOC_MEMBERS     = NO 
     321 
     322# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all  
     323# undocumented classes that are normally visible in the class hierarchy.  
     324# If set to NO (the default) these classes will be included in the various  
     325# overviews. This option has no effect if EXTRACT_ALL is enabled. 
     326 
    52327HIDE_UNDOC_CLASSES     = NO 
     328 
     329# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all  
     330# friend (class|struct|union) declarations.  
     331# If set to NO (the default) these declarations will be included in the  
     332# documentation. 
     333 
    53334HIDE_FRIEND_COMPOUNDS  = YES 
     335 
     336# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any  
     337# documentation blocks found inside the body of a function.  
     338# If set to NO (the default) these blocks will be appended to the  
     339# function's detailed documentation block. 
     340 
    54341HIDE_IN_BODY_DOCS      = YES 
     342 
     343# The INTERNAL_DOCS tag determines if documentation  
     344# that is typed after a \internal command is included. If the tag is set  
     345# to NO (the default) then the documentation will be excluded.  
     346# Set it to YES to include the internal documentation. 
     347 
    55348INTERNAL_DOCS          = NO 
     349 
     350# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate  
     351# file names in lower-case letters. If set to YES upper-case letters are also  
     352# allowed. This is useful if you have classes or files whose names only differ  
     353# in case and if your file system supports case sensitive file names. Windows  
     354# and Mac users are advised to set this option to NO. 
     355 
    56356CASE_SENSE_NAMES       = YES 
    57 HIDE_SCOPE_NAMES       = YES 
     357 
     358# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen  
     359# will show members with their full class and namespace scopes in the  
     360# documentation. If set to YES the scope will be hidden. 
     361 
     362HIDE_SCOPE_NAMES       = NO 
     363 
     364# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen  
     365# will put a list of the files that are included by a file in the documentation  
     366# of that file. 
     367 
    58368SHOW_INCLUDE_FILES     = YES 
     369 
     370# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]  
     371# is inserted in the documentation for inline members. 
     372 
    59373INLINE_INFO            = YES 
     374 
     375# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen  
     376# will sort the (detailed) documentation of file and class members  
     377# alphabetically by member name. If set to NO the members will appear in  
     378# declaration order. 
     379 
    60380SORT_MEMBER_DOCS       = YES 
     381 
     382# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the  
     383# brief documentation of file, namespace and class members alphabetically  
     384# by member name. If set to NO (the default) the members will appear in  
     385# declaration order. 
     386 
    61387SORT_BRIEF_DOCS        = NO 
    62 SORT_BY_SCOPE_NAME     = NO 
     388 
     389# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the  
     390# hierarchy of group names into alphabetical order. If set to NO (the default)  
     391# the group names will appear in their defined order. 
     392 
     393SORT_GROUP_NAMES       = NO 
     394 
     395# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be  
     396# sorted by fully-qualified names, including namespaces. If set to  
     397# NO (the default), the class list will be sorted only by class name,  
     398# not including the namespace part.  
     399# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
     400# Note: This option applies only to the class list, not to the  
     401# alphabetical list. 
     402 
     403SORT_BY_SCOPE_NAME     = YES 
     404 
     405# The GENERATE_TODOLIST tag can be used to enable (YES) or  
     406# disable (NO) the todo list. This list is created by putting \todo  
     407# commands in the documentation. 
     408 
    63409GENERATE_TODOLIST      = YES 
     410 
     411# The GENERATE_TESTLIST tag can be used to enable (YES) or  
     412# disable (NO) the test list. This list is created by putting \test  
     413# commands in the documentation. 
     414 
    64415GENERATE_TESTLIST      = YES 
     416 
     417# The GENERATE_BUGLIST tag can be used to enable (YES) or  
     418# disable (NO) the bug list. This list is created by putting \bug  
     419# commands in the documentation. 
     420 
    65421GENERATE_BUGLIST       = YES 
     422 
     423# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or  
     424# disable (NO) the deprecated list. This list is created by putting  
     425# \deprecated commands in the documentation. 
     426 
    66427GENERATE_DEPRECATEDLIST= YES 
     428 
     429# The ENABLED_SECTIONS tag can be used to enable conditional  
     430# documentation sections, marked by \if sectionname ... \endif. 
     431 
    67432ENABLED_SECTIONS       =  
     433 
     434# The MAX_INITIALIZER_LINES tag determines the maximum number of lines  
     435# the initial value of a variable or define consists of for it to appear in  
     436# the documentation. If the initializer consists of more lines than specified  
     437# here it will be hidden. Use a value of 0 to hide initializers completely.  
     438# The appearance of the initializer of individual variables and defines in the  
     439# documentation can be controlled using \showinitializer or \hideinitializer  
     440# command in the documentation regardless of this setting. 
     441 
    68442MAX_INITIALIZER_LINES  = 30 
     443 
     444# Set the SHOW_USED_FILES tag to NO to disable the list of files generated  
     445# at the bottom of the documentation of classes and structs. If set to YES the  
     446# list will mention the files that were used to generate the documentation. 
     447 
    69448SHOW_USED_FILES        = YES 
     449 
     450# If the sources in your project are distributed over multiple directories  
     451# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy  
     452# in the documentation. The default is NO. 
     453 
    70454SHOW_DIRECTORIES       = YES 
     455 
     456# The FILE_VERSION_FILTER tag can be used to specify a program or script that  
     457# doxygen should invoke to get the current version for each file (typically from  
     458# the version control system). Doxygen will invoke the program by executing (via  
     459# popen()) the command <command> <input-file>, where <command> is the value of  
     460# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file  
     461# provided by doxygen. Whatever the program writes to standard output  
     462# is used as the file version. See the manual for examples. 
     463 
    71464FILE_VERSION_FILTER    =  
     465 
    72466#--------------------------------------------------------------------------- 
    73467# configuration options related to warning and progress messages 
    74468#--------------------------------------------------------------------------- 
     469 
     470# The QUIET tag can be used to turn on/off the messages that are generated  
     471# by doxygen. Possible values are YES and NO. If left blank NO is used. 
     472 
    75473QUIET                  = NO 
     474 
     475# The WARNINGS tag can be used to turn on/off the warning messages that are  
     476# generated by doxygen. Possible values are YES and NO. If left blank  
     477# NO is used. 
     478 
    76479WARNINGS               = YES 
     480 
     481# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings  
     482# for undocumented members. If EXTRACT_ALL is set to YES then this flag will  
     483# automatically be disabled. 
     484 
    77485WARN_IF_UNDOCUMENTED   = YES 
     486 
     487# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for  
     488# potential errors in the documentation, such as not documenting some  
     489# parameters in a documented function, or documenting parameters that  
     490# don't exist or using markup commands wrongly. 
     491 
    78492WARN_IF_DOC_ERROR      = YES 
    79 WARN_NO_PARAMDOC       = NO 
     493 
     494# This WARN_NO_PARAMDOC option can be abled to get warnings for  
     495# functions that are documented, but have no documentation for their parameters  
     496# or return value. If set to NO (the default) doxygen will only warn about  
     497# wrong or incomplete parameter documentation, but not about the absence of  
     498# documentation. 
     499 
     500WARN_NO_PARAMDOC       = YES 
     501 
     502# The WARN_FORMAT tag determines the format of the warning messages that  
     503# doxygen can produce. The string should contain the $file, $line, and $text  
     504# tags, which will be replaced by the file and line number from which the  
     505# warning originated and the warning text. Optionally the format may contain  
     506# $version, which will be replaced by the version of the file (if it could  
     507# be obtained via FILE_VERSION_FILTER) 
     508 
    80509WARN_FORMAT            = "$file:$line: $text" 
     510 
     511# The WARN_LOGFILE tag can be used to specify a file to which warning  
     512# and error messages should be written. If left blank the output is written  
     513# to stderr. 
     514 
    81515WARN_LOGFILE           =  
     516 
    82517#--------------------------------------------------------------------------- 
    83518# configuration options related to the input files 
    84519#--------------------------------------------------------------------------- 
    85 INPUT                  = /mnt/media/projects/workspace/libdodo/trunk/include/libdodo/  
     520 
     521# The INPUT tag can be used to specify the files and/or directories that contain  
     522# documented source files. You may enter file names like "myfile.cpp" or  
     523# directories like "/usr/src/myproject". Separate the files or directories  
     524# with spaces. 
     525 
     526INPUT                  = /mnt/media/projects/workspace/libdodo/trunk/include/libdodo/ 
     527 
     528# This tag can be used to specify the character encoding of the source files  
     529# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is  
     530# also the default input encoding. Doxygen uses libiconv (or the iconv built  
     531# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for  
     532# the list of possible encodings. 
     533 
     534INPUT_ENCODING         = UTF-8 
     535 
     536# If the value of the INPUT tag contains directories, you can use the  
     537# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  
     538# and *.h) to filter out the source-files in the directories. If left  
     539# blank the following patterns are tested:  
     540# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx  
     541# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 
     542 
    86543FILE_PATTERNS          = *.c \ 
    87544                         *.cc \ 
     
    123580                         *.M \ 
    124581                         *.MM 
     582 
     583# The RECURSIVE tag can be used to turn specify whether or not subdirectories  
     584# should be searched for input files as well. Possible values are YES and NO.  
     585# If left blank NO is used. 
     586 
    125587RECURSIVE              = YES 
     588 
     589# The EXCLUDE tag can be used to specify files and/or directories that should  
     590# excluded from the INPUT source files. This way you can easily exclude a  
     591# subdirectory from a directory tree whose root is specified with the INPUT tag. 
     592 
    126593EXCLUDE                =  
     594 
     595# The EXCLUDE_SYMLINKS tag can be used select whether or not files or  
     596# directories that are symbolic links (a Unix filesystem feature) are excluded  
     597# from the input. 
     598 
    127599EXCLUDE_SYMLINKS       = NO 
     600 
     601# If the value of the INPUT tag contains directories, you can use the  
     602# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude  
     603# certain files from those directories. Note that the wildcards are matched  
     604# against the file with absolute path, so to exclude all test directories  
     605# for example use the pattern */test/* 
     606 
    128607EXCLUDE_PATTERNS       =  
     608 
     609# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names  
     610# (namespaces, classes, functions, etc.) that should be excluded from the  
     611# output. The symbol name can be a fully qualified name, a word, or if the  
     612# wildcard * is used, a substring. Examples: ANamespace, AClass,  
     613# AClass::ANamespace, ANamespace::*Test 
     614 
     615EXCLUDE_SYMBOLS        =  
     616 
     617# The EXAMPLE_PATH tag can be used to specify one or more files or  
     618# directories that contain example code fragments that are included (see  
     619# the \include command). 
     620 
    129621EXAMPLE_PATH           =  
     622 
     623# If the value of the EXAMPLE_PATH tag contains directories, you can use the  
     624# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp  
     625# and *.h) to filter out the source-files in the directories. If left  
     626# blank all files are included. 
     627 
    130628EXAMPLE_PATTERNS       = * 
     629 
     630# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be  
     631# searched for input files to be used with the \include or \dontinclude  
     632# commands irrespective of the value of the RECURSIVE tag.  
     633# Possible values are YES and NO. If left blank NO is used. 
     634 
    131635EXAMPLE_RECURSIVE      = NO 
     636 
     637# The IMAGE_PATH tag can be used to specify one or more files or  
     638# directories that contain image that are included in the documentation (see  
     639# the \image command). 
     640 
    132641IMAGE_PATH             =  
     642 
     643# The INPUT_FILTER tag can be used to specify a program that doxygen should  
     644# invoke to filter for each input file. Doxygen will invoke the filter program  
     645# by executing (via popen()) the command <filter> <input-file>, where <filter>  
     646# is the value of the INPUT_FILTER tag, and <input-file> is the name of an  
     647# input file. Doxygen will then use the output that the filter program writes  
     648# to standard output.  If FILTER_PATTERNS is specified, this tag will be  
     649# ignored. 
     650 
    133651INPUT_FILTER           =  
     652 
     653# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern  
     654# basis.  Doxygen will compare the file name with each pattern and apply the  
     655# filter if there is a match.  The filters are a list of the form:  
     656# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further  
     657# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER  
     658# is applied to all files. 
     659 
    134660FILTER_PATTERNS        =  
     661 
     662# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using  
     663# INPUT_FILTER) will be used to filter the input files when producing source  
     664# files to browse (i.e. when SOURCE_BROWSER is set to YES). 
     665 
    135666FILTER_SOURCE_FILES    = NO 
     667 
    136668#--------------------------------------------------------------------------- 
    137669# configuration options related to source browsing 
    138670#--------------------------------------------------------------------------- 
     671 
     672# If the SOURCE_BROWSER tag is set to YES then a list of source files will  
     673# be generated. Documented entities will be cross-referenced with these sources.  
     674# Note: To get rid of all source code in the generated output, make sure also  
     675# VERBATIM_HEADERS is set to NO. 
     676 
    139677SOURCE_BROWSER         = YES 
     678 
     679# Setting the INLINE_SOURCES tag to YES will include the body  
     680# of functions and classes directly in the documentation. 
     681 
    140682INLINE_SOURCES         = YES 
     683 
     684# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct  
     685# doxygen to hide any special comment blocks from generated source code  
     686# fragments. Normal C and C++ comments will always remain visible. 
     687 
    141688STRIP_CODE_COMMENTS    = YES 
     689 
     690# If the REFERENCED_BY_RELATION tag is set to YES (the default)  
     691# then for each documented function all documented  
     692# functions referencing it will be listed. 
     693 
    142694REFERENCED_BY_RELATION = YES 
     695 
     696# If the REFERENCES_RELATION tag is set to YES (the default)  
     697# then for each documented function all documented entities  
     698# called/used by that function will be listed. 
     699 
    143700REFERENCES_RELATION    = YES 
     701 
     702# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
     703# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
     704# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
     705# link to the source code.  Otherwise they will link to the documentstion. 
     706 
    144707REFERENCES_LINK_SOURCE = YES 
     708 
     709# If the USE_HTAGS tag is set to YES then the references to source code  
     710# will point to the HTML generated by the htags(1) tool instead of doxygen  
     711# built-in source browser. The htags tool is part of GNU's global source  
     712# tagging system (see http://www.gnu.org/software/global/global.html). You  
     713# will need version 4.8.6 or higher. 
     714 
    145715USE_HTAGS              = NO 
     716 
     717# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen  
     718# will generate a verbatim copy of the header file for each class for  
     719# which an include is specified. Set to NO to disable this. 
     720 
    146721VERBATIM_HEADERS       = YES 
     722 
    147723#--------------------------------------------------------------------------- 
    148724# configuration options related to the alphabetical class index 
    149725#--------------------------------------------------------------------------- 
     726 
     727# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index  
     728# of all compounds will be generated. Enable this if the project  
     729# contains a lot of classes, structs, unions or interfaces. 
     730 
    150731ALPHABETICAL_INDEX     = YES 
     732 
     733# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then  
     734# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns  
     735# in which this list will be split (can be a number in the range [1..20]) 
     736 
    151737COLS_IN_ALPHA_INDEX    = 5 
     738 
     739# In case all classes in a project start with a common prefix, all  
     740# classes will be put under the same header in the alphabetical index.  
     741# The IGNORE_PREFIX tag can be used to specify one or more prefixes that  
     742# should be ignored while generating the index headers. 
     743 
    152744IGNORE_PREFIX          =  
     745 
    153746#--------------------------------------------------------------------------- 
    154747# configuration options related to the HTML output 
    155748#--------------------------------------------------------------------------- 
     749 
     750# If the GENERATE_HTML tag is set to YES (the default) Doxygen will  
     751# generate HTML output. 
     752 
    156753GENERATE_HTML          = YES 
     754 
     755# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.  
     756# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     757# put in front of it. If left blank `html' will be used as the default path. 
     758 
    157759HTML_OUTPUT            = html 
     760 
     761# The HTML_FILE_EXTENSION tag can be used to specify the file extension for  
     762# each generated HTML page (for example: .htm,.php,.asp). If it is left blank  
     763# doxygen will generate files with .html extension. 
     764 
    158765HTML_FILE_EXTENSION    = .html 
     766 
     767# The HTML_HEADER tag can be used to specify a personal HTML header for  
     768# each generated HTML page. If it is left blank doxygen will generate a  
     769# standard header. 
     770 
    159771HTML_HEADER            =  
     772 
     773# The HTML_FOOTER tag can be used to specify a personal HTML footer for  
     774# each generated HTML page. If it is left blank doxygen will generate a  
     775# standard footer. 
     776 
    160777HTML_FOOTER            =  
     778 
     779# The HTML_STYLESHEET tag can be used to specify a user-defined cascading  
     780# style sheet that is used by each HTML page. It can be used to  
     781# fine-tune the look of the HTML output. If the tag is left blank doxygen  
     782# will generate a default style sheet. Note that doxygen will try to copy  
     783# the style sheet file to the HTML output directory, so don't put your own  
     784# stylesheet in the HTML output directory as well, or it will be erased! 
     785 
    161786HTML_STYLESHEET        =  
     787 
     788# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,  
     789# files or namespaces will be aligned in HTML using tables. If set to  
     790# NO a bullet list will be used. 
     791 
    162792HTML_ALIGN_MEMBERS     = YES 
     793 
     794# If the GENERATE_HTMLHELP tag is set to YES, additional index files  
     795# will be generated that can be used as input for tools like the  
     796# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)  
     797# of the generated HTML documentation. 
     798 
    163799GENERATE_HTMLHELP      = NO 
     800 
     801# If the GENERATE_DOCSET tag is set to YES, additional index files  
     802# will be generated that can be used as input for Apple's Xcode 3  
     803# integrated development environment, introduced with OSX 10.5 (Leopard).  
     804# To create a documentation set, doxygen will generate a Makefile in the  
     805# HTML output directory. Running make will produce the docset in that  
     806# directory and running "make install" will install the docset in  
     807# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find  
     808# it at startup. 
     809 
     810GENERATE_DOCSET        = NO 
     811 
     812# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the  
     813# feed. A documentation feed provides an umbrella under which multiple  
     814# documentation sets from a single provider (such as a company or product suite)  
     815# can be grouped. 
     816 
     817DOCSET_FEEDNAME        = "Doxygen generated docs" 
     818 
     819# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that  
     820# should uniquely identify the documentation set bundle. This should be a  
     821# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen  
     822# will append .docset to the name. 
     823 
     824DOCSET_BUNDLE_ID       = org.doxygen.Project 
     825 
     826# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML  
     827# documentation will contain sections that can be hidden and shown after the  
     828# page has loaded. For this to work a browser that supports  
     829# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox  
     830# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 
     831 
     832HTML_DYNAMIC_SECTIONS  = YES 
     833 
     834# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  
     835# be used to specify the file name of the resulting .chm file. You  
     836# can add a path in front of the file if the result should not be  
     837# written to the html output directory. 
     838 
    164839CHM_FILE               =  
     840 
     841# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can  
     842# be used to specify the location (absolute path including file name) of  
     843# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run  
     844# the HTML help compiler on the generated index.hhp. 
     845 
    165846HHC_LOCATION           =  
     847 
     848# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag  
     849# controls if a separate .chi index file is generated (YES) or that  
     850# it should be included in the master .chm file (NO). 
     851 
    166852GENERATE_CHI           = NO 
     853 
     854# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag  
     855# controls whether a binary table of contents is generated (YES) or a  
     856# normal table of contents (NO) in the .chm file. 
     857 
    167858BINARY_TOC             = NO 
     859 
     860# The TOC_EXPAND flag can be set to YES to add extra items for group members  
     861# to the contents of the HTML help documentation and to the tree view. 
     862 
    168863TOC_EXPAND             = NO 
     864 
     865# The DISABLE_INDEX tag can be used to turn on/off the condensed index at  
     866# top of each HTML page. The value NO (the default) enables the index and  
     867# the value YES disables it. 
     868 
    169869DISABLE_INDEX          = NO 
     870 
     871# This tag can be used to set the number of enum values (range [1..20])  
     872# that doxygen will group on one line in the generated HTML documentation. 
     873 
    170874ENUM_VALUES_PER_LINE   = 4 
     875 
     876# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 
     877# generated containing a tree-like index structure (just like the one that  
     878# is generated for HTML Help). For this to work a browser that supports  
     879# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,  
     880# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are  
     881# probably better off using the HTML help feature. 
     882 
    171883GENERATE_TREEVIEW      = YES 
     884 
     885# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be  
     886# used to set the initial width (in pixels) of the frame in which the tree  
     887# is shown. 
     888 
    172889TREEVIEW_WIDTH         = 250 
     890 
    173891#--------------------------------------------------------------------------- 
    174892# configuration options related to the LaTeX output 
    175893#--------------------------------------------------------------------------- 
     894 
     895# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will  
     896# generate Latex output. 
     897 
    176898GENERATE_LATEX         = NO 
     899 
     900# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.  
     901# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     902# put in front of it. If left blank `latex' will be used as the default path. 
     903 
    177904LATEX_OUTPUT           = latex 
     905 
     906# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be  
     907# invoked. If left blank `latex' will be used as the default command name. 
     908 
    178909LATEX_CMD_NAME         = latex 
     910 
     911# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to  
     912# generate index for LaTeX. If left blank `makeindex' will be used as the  
     913# default command name. 
     914 
    179915MAKEINDEX_CMD_NAME     = makeindex 
     916 
     917# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact  
     918# LaTeX documents. This may be useful for small projects and may help to  
     919# save some trees in general. 
     920 
    180921COMPACT_LATEX          = NO 
     922 
     923# The PAPER_TYPE tag can be used to set the paper type that is used  
     924# by the printer. Possible values are: a4, a4wide, letter, legal and  
     925# executive. If left blank a4wide will be used. 
     926 
    181927PAPER_TYPE             = a4wide 
     928 
     929# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX  
     930# packages that should be included in the LaTeX output. 
     931 
    182932EXTRA_PACKAGES         =  
     933 
     934# The LATEX_HEADER tag can be used to specify a personal LaTeX header for  
     935# the generated latex document. The header should contain everything until  
     936# the first chapter. If it is left blank doxygen will generate a  
     937# standard header. Notice: only use this tag if you know what you are doing! 
     938 
    183939LATEX_HEADER           =  
     940 
     941# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated  
     942# is prepared for conversion to pdf (using ps2pdf). The pdf file will  
     943# contain links (just like the HTML output) instead of page references  
     944# This makes the output suitable for online browsing using a pdf viewer. 
     945 
    184946PDF_HYPERLINKS         = NO 
     947 
     948# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of  
     949# plain latex in the generated Makefile. Set this option to YES to get a  
     950# higher quality PDF documentation. 
     951 
    185952USE_PDFLATEX           = NO 
     953 
     954# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.  
     955# command to the generated LaTeX files. This will instruct LaTeX to keep  
     956# running if errors occur, instead of asking the user for help.  
     957# This option is also used when generating formulas in HTML. 
     958 
    186959LATEX_BATCHMODE        = NO 
     960 
     961# If LATEX_HIDE_INDICES is set to YES then doxygen will not  
     962# include the index chapters (such as File Index, Compound Index, etc.)  
     963# in the output. 
     964 
    187965LATEX_HIDE_INDICES     = NO 
     966 
    188967#--------------------------------------------------------------------------- 
    189968# configuration options related to the RTF output 
    190969#--------------------------------------------------------------------------- 
     970 
     971# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output  
     972# The RTF output is optimized for Word 97 and may not look very pretty with  
     973# other RTF readers or editors. 
     974 
    191975GENERATE_RTF           = NO 
     976 
     977# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.  
     978# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     979# put in front of it. If left blank `rtf' will be used as the default path. 
     980 
    192981RTF_OUTPUT             = rtf 
     982 
     983# If the COMPACT_RTF tag is set to YES Doxygen generates more compact  
     984# RTF documents. This may be useful for small projects and may help to  
     985# save some trees in general. 
     986 
    193987COMPACT_RTF            = NO 
     988 
     989# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated  
     990# will contain hyperlink fields. The RTF file will  
     991# contain links (just like the HTML output) instead of page references.  
     992# This makes the output suitable for online browsing using WORD or other  
     993# programs which support those fields.  
     994# Note: wordpad (write) and others do not support links. 
     995 
    194996RTF_HYPERLINKS         = NO 
     997 
     998# Load stylesheet definitions from file. Syntax is similar to doxygen's  
     999# config file, i.e. a series of assignments. You only have to provide  
     1000# replacements, missing definitions are set to their default value. 
     1001 
    1951002RTF_STYLESHEET_FILE    =  
     1003 
     1004# Set optional variables used in the generation of an rtf document.  
     1005# Syntax is similar to doxygen's config file. 
     1006 
    1961007RTF_EXTENSIONS_FILE    =  
     1008 
    1971009#--------------------------------------------------------------------------- 
    1981010# configuration options related to the man page output 
    1991011#--------------------------------------------------------------------------- 
     1012 
     1013# If the GENERATE_MAN tag is set to YES (the default) Doxygen will  
     1014# generate man pages 
     1015 
    2001016GENERATE_MAN           = NO 
     1017 
     1018# The MAN_OUTPUT tag is used to specify where the man pages will be put.  
     1019# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     1020# put in front of it. If left blank `man' will be used as the default path. 
     1021 
    2011022MAN_OUTPUT             = man 
     1023 
     1024# The MAN_EXTENSION tag determines the extension that is added to  
     1025# the generated man pages (default is the subroutine's section .3) 
     1026 
    2021027MAN_EXTENSION          = .3 
     1028 
     1029# If the MAN_LINKS tag is set to YES and Doxygen generates man output,  
     1030# then it will generate one additional man file for each entity  
     1031# documented in the real man page(s). These additional files  
     1032# only source the real man page, but without them the man command  
     1033# would be unable to find the correct page. The default is NO. 
     1034 
    2031035MAN_LINKS              = NO 
     1036 
    2041037#--------------------------------------------------------------------------- 
    2051038# configuration options related to the XML output 
    2061039#--------------------------------------------------------------------------- 
     1040 
     1041# If the GENERATE_XML tag is set to YES Doxygen will  
     1042# generate an XML file that captures the structure of  
     1043# the code including all documentation. 
     1044 
    2071045GENERATE_XML           = NO 
     1046 
     1047# The XML_OUTPUT tag is used to specify where the XML pages will be put.  
     1048# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
     1049# put in front of it. If left blank `xml' will be used as the default path. 
     1050 
    2081051XML_OUTPUT             = xml 
     1052 
     1053# The XML_SCHEMA tag can be used to specify an XML schema,  
     1054# which can be used by a validating XML parser to check the  
     1055# syntax of the XML files. 
     1056 
    2091057XML_SCHEMA             =  
     1058 
     1059# The XML_DTD tag can be used to specify an XML DTD,  
     1060# which can be used by a validating XML parser to check the  
     1061# syntax of the XML files. 
     1062 
    2101063XML_DTD                =  
     1064 
     1065# If the XML_PROGRAMLISTING tag is set to YES Doxygen will  
     1066# dump the program listings (including syntax highlighting  
     1067# and cross-referencing information) to the XML output. Note that  
     1068# enabling this will significantly increase the size of the XML output. 
     1069 
    2111070XML_PROGRAMLISTING     = YES 
     1071 
    2121072#--------------------------------------------------------------------------- 
    2131073# configuration options for the AutoGen Definitions output 
    2141074#--------------------------------------------------------------------------- 
     1075 
     1076# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will  
     1077# generate an AutoGen Definitions (see autogen.sf.net) file  
     1078# that captures the structure of the code including all  
     1079# documentation. Note that this feature is still experimental  
     1080# and incomplete at the moment. 
     1081 
    2151082GENERATE_AUTOGEN_DEF   = NO 
     1083 
    2161084#--------------------------------------------------------------------------- 
    2171085# configuration options related to the Perl module output 
    2181086#--------------------------------------------------------------------------- 
     1087 
     1088# If the GENERATE_PERLMOD tag is set to YES Doxygen will  
     1089# generate a Perl module file that captures the structure of  
     1090# the code including all documentation. Note that this  
     1091# feature is still experimental and incomplete at the  
     1092# moment. 
     1093 
    2191094GENERATE_PERLMOD       = NO 
     1095 
     1096# If the PERLMOD_LATEX tag is set to YES Doxygen will generate  
     1097# the necessary Makefile rules, Perl scripts and LaTeX code to be able  
     1098# to generate PDF and DVI output from the Perl module output. 
     1099 
    2201100PERLMOD_LATEX          = NO 
     1101 
     1102# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be  
     1103# nicely formatted so it can be parsed by a human reader.  This is useful  
     1104# if you want to understand what is going on.  On the other hand, if this  
     1105# tag is set to NO the size of the Perl module output will be much smaller  
     1106# and Perl will parse it just the same. 
     1107 
    2211108PERLMOD_PRETTY         = YES 
     1109 
     1110# The names of the make variables in the generated doxyrules.make file  
     1111# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.  
     1112# This is useful so different doxyrules.make files included by the same  
     1113# Makefile don't overwrite each other's variables. 
     1114 
    2221115PERLMOD_MAKEVAR_PREFIX =  
     1116 
    2231117#--------------------------------------------------------------------------- 
    2241118# Configuration options related to the preprocessor    
    2251119#--------------------------------------------------------------------------- 
     1120 
     1121# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will  
     1122# evaluate all C-preprocessor directives found in the sources and include  
     1123# files. 
     1124 
    2261125ENABLE_PREPROCESSING   = YES 
     1126 
     1127# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro  
     1128# names in the source code. If set to NO (the default) only conditional  
     1129# compilation will be performed. Macro expansion can be done in a controlled  
     1130# way by setting EXPAND_ONLY_PREDEF to YES. 
     1131 
    2271132MACRO_EXPANSION        = YES 
     1133 
     1134# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES  
     1135# then the macro expansion is limited to the macros specified with the  
     1136# PREDEFINED and EXPAND_AS_DEFINED tags. 
     1137 
    2281138EXPAND_ONLY_PREDEF     = NO 
     1139 
     1140# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  
     1141# in the INCLUDE_PATH (see below) will be search if a #include is found. 
     1142 
    2291143SEARCH_INCLUDES        = YES 
     1144 
     1145# The INCLUDE_PATH tag can be used to specify one or more directories that  
     1146# contain include files that are not input files but should be processed by  
     1147# the preprocessor. 
     1148 
    2301149INCLUDE_PATH           = /mnt/media/projects/workspace/libdodo/trunk/include/libdodo/ 
     1150 
     1151# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard  
     1152# patterns (like *.h and *.hpp) to filter out the header-files in the  
     1153# directories. If left blank, the patterns specified with FILE_PATTERNS will  
     1154# be used. 
     1155 
    2311156INCLUDE_FILE_PATTERNS  =  
     1157 
     1158# The PREDEFINED tag can be used to specify one or more macro names that  
     1159# are defined before the preprocessor is started (similar to the -D option of  
     1160# gcc). The argument of the tag is a list of macros of the form: name  
     1161# or name=definition (no spaces). If the definition and the = are  
     1162# omitted =1 is assumed. To prevent a macro definition from being  
     1163# undefined via #undef or recursively expanded use the := operator  
     1164# instead of the = operator. 
     1165 
    2321166PREDEFINED             = USE_DEQUE \ 
    2331167                         SQLITE_EXT \ 
     
    2421176                         ZLIB_EXT \ 
    2431177                         ICONV_EXT 
     1178 
     1179# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  
     1180# this tag can be used to specify a list of macro names that should be expanded.  
     1181# The macro definition that is found in the sources will be used.  
     1182# Use the PREDEFINED tag if you want to use a different macro definition. 
     1183 
    2441184EXPAND_AS_DEFINED      =  
     1185 
     1186# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then  
     1187# doxygen's preprocessor will remove all function-like macros that are alone  
     1188# on a line, have an all uppercase name, and do not end with a semicolon. Such  
     1189# function macros are typically used for boiler-plate code, and will confuse  
     1190# the parser if not removed. 
     1191 
    2451192SKIP_FUNCTION_MACROS   = YES 
     1193 
    2461194#--------------------------------------------------------------------------- 
    2471195# Configuration::additions related to external references    
    2481196#--------------------------------------------------------------------------- 
     1197 
     1198# The TAGFILES option can be used to specify one or more tagfiles.  
     1199# Optionally an initial location of the external documentation  
     1200# can be added for each tagfile. The format of a tag file without  
     1201# this location is as follows:  
     1202#   TAGFILES = file1 file2 ...  
     1203# Adding location for the tag files is done as follows:  
     1204#   TAGFILES = file1=loc1 "file2 = loc2" ...  
     1205# where "loc1" and "loc2" can be relative or absolute paths or  
     1206# URLs. If a location is present for each tag, the installdox tool  
     1207# does not have to be run to correct the links. 
     1208# Note that each tag file must have a unique name 
     1209# (where the name does NOT include the path) 
     1210# If a tag file is not located in the directory in which doxygen  
     1211# is run, you must also specify the path to the tagfile here. 
     1212 
    2491213TAGFILES               =  
     1214 
     1215# When a file name is specified after GENERATE_TAGFILE, doxygen will create  
     1216# a tag file that is based on the input files it reads. 
     1217 
    2501218GENERATE_TAGFILE       =  
     1219 
     1220# If the ALLEXTERNALS tag is set to YES all external classes will be listed  
     1221# in the class index. If set to NO only the inherited external classes  
     1222# will be listed. 
     1223 
    2511224ALLEXTERNALS           = NO 
     1225 
     1226# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed  
     1227# in the modules index. If set to NO, only the current project's groups will  
     1228# be listed. 
     1229 
    2521230EXTERNAL_GROUPS        = YES 
     1231 
     1232# The PERL_PATH should be the absolute path and name of the perl script  
     1233# interpreter (i.e. the result of `which perl'). 
     1234 
    2531235PERL_PATH              = /usr/bin/perl 
     1236 
    2541237#--------------------------------------------------------------------------- 
    2551238# Configuration options related to the dot tool    
    2561239#--------------------------------------------------------------------------- 
     1240 
     1241# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will  
     1242# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base  
     1243# or super classes. Setting the tag to NO turns the diagrams off. Note that  
     1244# this option is superseded by the HAVE_DOT option below. This is only a  
     1245# fallback. It is recommended to install and use dot, since it yields more  
     1246# powerful graphs. 
     1247 
    2571248CLASS_DIAGRAMS         = NO 
     1249 
     1250# You can define message sequence charts within doxygen comments using the \msc  
     1251# command. Doxygen will then run the mscgen tool (see  
     1252# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the  
     1253# documentation. The MSCGEN_PATH tag allows you to specify the directory where  
     1254# the mscgen tool resides. If left empty the tool is assumed to be found in the  
     1255# default search path. 
     1256 
     1257MSCGEN_PATH            =  
     1258 
     1259# If set to YES, the inheritance and collaboration graphs will hide  
     1260# inheritance and usage relations if the target is undocumented  
     1261# or is not a class. 
     1262 
    2581263HIDE_UNDOC_RELATIONS   = YES 
     1264 
     1265# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is  
     1266# available from the path. This tool is part of Graphviz, a graph visualization  
     1267# toolkit from AT&T and Lucent Bell Labs. The other options in this section  
     1268# have no effect if this option is set to NO (the default) 
     1269 
    2591270HAVE_DOT               = YES 
     1271 
     1272# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen  
     1273# will generate a graph for each documented class showing the direct and  
     1274# indirect inheritance relations. Setting this tag to YES will force the  
     1275# the CLASS_DIAGRAMS tag to NO. 
     1276 
    2601277CLASS_GRAPH            = YES 
     1278 
     1279# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen  
     1280# will generate a graph for each documented class showing the direct and  
     1281# indirect implementation dependencies (inheritance, containment, and  
     1282# class references variables) of the class with other documented classes. 
     1283 
    2611284COLLABORATION_GRAPH    = YES 
     1285 
     1286# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen  
     1287# will generate a graph for groups, showing the direct groups dependencies 
     1288 
    2621289GROUP_GRAPHS           = YES 
     1290 
     1291# If the UML_LOOK tag is set to YES doxygen will generate inheritance and  
     1292# collaboration diagrams in a style similar to the OMG's Unified Modeling  
     1293# Language. 
     1294 
    2631295UML_LOOK               = NO 
     1296 
     1297# If set to YES, the inheritance and collaboration graphs will show the  
     1298# relations between templates and their instances. 
     1299 
    2641300TEMPLATE_RELATIONS     = NO 
     1301 
     1302# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT  
     1303# tags are set to YES then doxygen will generate a graph for each documented  
     1304# file showing the direct and indirect include dependencies of the file with  
     1305# other documented files. 
     1306 
    2651307INCLUDE_GRAPH          = YES 
     1308 
     1309# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and  
     1310# HAVE_DOT tags are set to YES then doxygen will generate a graph for each  
     1311# documented header file showing the documented files that directly or  
     1312# indirectly include this file. 
     1313 
    2661314INCLUDED_BY_GRAPH      = YES 
     1315 
     1316# If the CALL_GRAPH and HAVE_DOT options are set to YES then  
     1317# doxygen will generate a call dependency graph for every global function  
     1318# or class method. Note that enabling this option will significantly increase  
     1319# the time of a run. So in most cases it will be better to enable call graphs  
     1320# for selected functions only using the \callgraph command. 
     1321 
    2671322CALL_GRAPH             = NO 
     1323 
     1324# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then  
     1325# doxygen will generate a caller dependency graph for every global function  
     1326# or class method. Note that enabling this option will significantly increase  
     1327# the time of a run. So in most cases it will be better to enable caller  
     1328# graphs for selected functions only using the \callergraph command. 
     1329 
    2681330CALLER_GRAPH           = NO 
     1331 
     1332# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen  
     1333# will graphical hierarchy of all classes instead of a textual one. 
     1334 
    2691335GRAPHICAL_HIERARCHY    = YES 
     1336 
     1337# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES  
     1338# then doxygen will show the dependencies a directory has on other directories  
     1339# in a graphical way. The dependency relations are determined by the #include 
     1340# relations between the files in the directories. 
     1341 
    2701342DIRECTORY_GRAPH        = YES 
     1343 
     1344# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images  
     1345# generated by dot. Possible values are png, jpg, or gif 
     1346# If left blank png will be used. 
     1347 
    2711348DOT_IMAGE_FORMAT       = png 
     1349 
     1350# The tag DOT_PATH can be used to specify the path where the dot tool can be  
     1351# found. If left blank, it is assumed the dot tool can be found in the path. 
     1352 
    2721353DOT_PATH               =  
     1354 
     1355# The DOTFILE_DIRS tag can be used to specify one or more directories that  
     1356# contain dot files that are included in the documentation (see the  
     1357# \dotfile command). 
     1358 
    2731359DOTFILE_DIRS           =  
    274 MAX_DOT_GRAPH_WIDTH    = 1024 
    275 MAX_DOT_GRAPH_HEIGHT   = 1024 
     1360 
     1361# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of  
     1362# nodes that will be shown in the graph. If the number of nodes in a graph  
     1363# becomes larger than this value, doxygen will truncate the graph, which is  
     1364# visualized by representing a node as a red box. Note that doxygen if the  
     1365# number of direct children of the root node in a graph is already larger than  
     1366# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note  
     1367# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 
     1368 
     1369DOT_GRAPH_MAX_NODES    = 50 
     1370 
     1371# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the  
     1372# graphs generated by dot. A depth value of 3 means that only nodes reachable  
     1373# from the root by following a path via at most 3 edges will be shown. Nodes  
     1374# that lay further from the root node will be omitted. Note that setting this  
     1375# option to 1 or 2 may greatly reduce the computation time needed for large  
     1376# code bases. Also note that the size of a graph can be further restricted by  
     1377# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 
     1378 
    2761379MAX_DOT_GRAPH_DEPTH    = 1000 
     1380 
     1381# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent  
     1382# background. This is enabled by default, which results in a transparent  
     1383# background. Warning: Depending on the platform used, enabling this option  
     1384# may lead to badly anti-aliased labels on the edges of a graph (i.e. they  
     1385# become hard to read). 
     1386 
    2771387DOT_TRANSPARENT        = NO 
     1388 
     1389# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output  
     1390# files in one run (i.e. multiple -o and -T options on the command line). This  
     1391# makes dot run faster, but since only newer versions of dot (>1.8.10)  
     1392# support this, this feature is disabled by default. 
     1393 
    2781394DOT_MULTI_TARGETS      = NO 
     1395 
     1396# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will  
     1397# generate a legend page explaining the meaning of the various boxes and  
     1398# arrows in the dot generated graphs. 
     1399 
    2791400GENERATE_LEGEND        = YES 
     1401 
     1402# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will  
     1403# remove the intermediate dot files that are used to generate  
     1404# the various graphs. 
     1405 
    2801406DOT_CLEANUP            = YES 
     1407 
    2811408#--------------------------------------------------------------------------- 
    2821409# Configuration::additions related to the search engine    
    2831410#--------------------------------------------------------------------------- 
     1411 
     1412# The SEARCHENGINE tag specifies whether or not a search engine should be  
     1413# used. If set to NO the values of all tags below this one will be ignored. 
     1414 
    2841415SEARCHENGINE           = NO 
  • trunk/include/libdodo/dbConnector.h

    r860 r880  
    9191 
    9292                /** 
    93                  * @enum accumulatorReferenceEnum defines reference type assigned to the field 
     93                 * @enum connectorReferenceEnum defines reference type assigned to the field 
    9494                 */ 
    9595                enum connectorReferenceEnum 
     
    237237                        unsigned int port;                  ///< port 
    238238                }; 
    239                  
     239 
    240240                /** 
    241241                 * @enum dbOperationTypeEnum defines type of operation for hook 
    242242                 */ 
    243                 enum mysqlOperationTypeEnum 
     243                enum dbOperationTypeEnum 
    244244                { 
    245245                        DB_OPERATION_CONNECT, 
  • trunk/include/libdodo/ioNetworkHttp.h

    r874 r880  
    273273 
    274274                                        /** 
    275                                          * @enum getContentStatus defines status of getContent routine 
     275                                         * @enum getContentStatusEnum defines status of getContent routine 
    276276                                         */ 
    277277                                        enum getContentStatusEnum 
     
    375375                                         * @enum proxyAuthTypeEnum defines proxy authentification type 
    376376                                         */ 
    377                                         enum proxyAuthEnum 
     377                                        enum proxyAuthTypeEnum 
    378378                                        { 
    379379                                                PROXYAUTHTYPE_NONE, 
  • trunk/include/libdodo/ioNetworkServer.h

    r870 r880  
    6464 
    6565                        /** 
    66                          * @enum ServerOperationTypeEnum defines type of operation for hook 
     66                         * @enum serverOperationTypeEnum defines type of operation for hook 
    6767                         */ 
    6868                        enum serverOperationTypeEnum 
  • trunk/include/libdodo/xexec.h

    r870 r880  
    174174        { 
    175175                private: 
    176                          
     176 
    177177                        /* 
    178178                         * copy constructor 
     
    235235                         * @return pre/postExec identificators 
    236236                         * @param path defines path to the library[if not in ldconfig db] or library name 
    237                          * @param obj defines object that called the hook 
     237                         * @param data defines hook data 
    238238                         * @param toInit defines data that will be passed to the init function 
    239239                         * @note type of hook[pre/post] is defined in module 
     
    384384                         * @param list defines list of hooks 
    385385                         * @param func defines function that will be called 
    386                          * @param obj defines object that called the hook 
    387                          * @param type defines hook type[see xexecObjectTypeEnum] 
    388386                         * @param data defines hook data 
    389387                         */ 
     
    421419                         * @param list defines list of hooks 
    422420                         * @param path defines path to the library[if not in ldconfig db] or library name 
    423                          * @param obj defines object that called the hook 
    424                          * @param type defines hook type[see xexecObjectTypeEnum] 
    425421                         * @param data defines hook data 
    426422                         * @param toInit defines data that will be passed to the init function 
Note: See TracChangeset for help on using the changeset viewer.