Changeset 2739 for trunk/doc


Ignore:
Timestamp:
Jun 8, 2012, 12:22:47 AM (9 years ago)
Author:
Peter
Message:

refs #703 using a non-recursive Makefile. Old Makefile.am are kept but
rather than being source for sub-Makefiles they are included into
topdir Makefile.am. This implies Make rules must be modified to work
from topdir. A temporary code snippet will remove old Makefiles and
Makefile.ins at configure time. This code will be removed in a week or
so and is mainly there for autobuilds and prepare for future
sub-Makefiles (that will have a all: rule in sub-directories.

Location:
trunk/doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/Makefile.am

    r2631 r2739  
    2424
    2525
    26 DOXYGEN_FILES = $(srcdir)/build_tool.doxygen \
    27 $(builddir)/first_page.doxygen \
    28 $(srcdir)/deprecated.doxygen \
    29 $(srcdir)/footer.html \
    30 $(srcdir)/namespaces.doxygen \
    31 $(srcdir)/concepts.doxygen \
    32 $(srcdir)/Statistics.doxygen
     26DOXYGEN_FILES = $(srcdir)/doc/build_tool.doxygen \
     27$(builddir)/doc/first_page.doxygen \
     28$(srcdir)/doc/deprecated.doxygen \
     29$(srcdir)/doc/footer.html \
     30$(srcdir)/doc/namespaces.doxygen \
     31$(srcdir)/doc/concepts.doxygen \
     32$(srcdir)/doc/Statistics.doxygen
    3333
    34 EXTRA_DIST = $(DOXYGEN_FILES)
     34EXTRA_DIST += $(DOXYGEN_FILES)
    3535
    36 @am__include@ @am__quote@./$(top_builddir)/yat/classifier/doxygen.mk@am__quote@
    37 @am__include@ @am__quote@./$(top_builddir)/yat/normalizer/doxygen.mk@am__quote@
    38 @am__include@ @am__quote@./$(top_builddir)/yat/omic/doxygen.mk@am__quote@
    39 @am__include@ @am__quote@./$(top_builddir)/yat/random/doxygen.mk@am__quote@
    40 @am__include@ @am__quote@./$(top_builddir)/yat/regression/doxygen.mk@am__quote@
    41 @am__include@ @am__quote@./$(top_builddir)/yat/statistics/doxygen.mk@am__quote@
    42 @am__include@ @am__quote@./$(top_builddir)/yat/utility/doxygen.mk@am__quote@
     36DOXYGEN_INPUT += $(DOXYGEN_FILES)
     37DOXYGEN_INPUT += $(nobase_include_HEADERS)
     38DOXYGEN_INPUT += $(nobase_nodist_include_HEADERS)
    4339
    44 DOXYGEN_INPUT=$(yat_classifier_doxygen_input) \
    45 $(yat_normalizer_doxygen_input) \
    46 $(yat_omic_doxygen_input) \
    47 $(yat_random_doxygen_input) \
    48 $(yat_regression_doxygen_input) \
    49 $(yat_statistics_doxygen_input) \
    50 $(yat_utility_doxygen_input) \
    51 $(DOXYGEN_FILES)
    52 
    53 DOXYGEN_DEPS = $(DOXYGEN_INPUT) doxygen.config \
    54 $(top_builddir)/yat/classifier/doxygen.mk \
    55 $(top_builddir)/yat/normalizer/doxygen.mk \
    56 $(top_builddir)/yat/omic/doxygen.mk \
    57 $(top_builddir)/yat/random/doxygen.mk \
    58 $(top_builddir)/yat/regression/doxygen.mk \
    59 $(top_builddir)/yat/statistics/doxygen.mk \
    60 $(top_builddir)/yat/utility/doxygen.mk
    61 
    62 doc: html
    63 
     40DOXYGEN_DEPS = $(DOXYGEN_INPUT) doc/doxygen.config
    6441
    6542# these are supported by automake and *-local will add target to *
    6643if DX_ENABLE_HTML
    67 html-local: $(DX_HTML_OUTPUT)/index.html
     44html-local: doc/$(DX_HTML_OUTPUT)/index.html
    6845endif
    6946
     
    7249dx_dev_null_0 = > /dev/null
    7350
    74 $(DX_HTML_OUTPUT)/index.html: $(DOXYGEN_DEPS)
     51doc/$(DX_HTML_OUTPUT)/index.html: $(DOXYGEN_DEPS)
    7552  $(AM_V_GEN)
    76   $(AM_V_at){ cat doxygen.config && echo "INPUT = $(DOXYGEN_INPUT)" && \
     53  $(AM_V_at){ cat doc/doxygen.config && echo "INPUT = $(DOXYGEN_INPUT)" && \
    7754  echo GENERATE_HTML = YES; } | $(DOXYGEN) - $(dx_dev_null);
    7855
    79 install-data-hook:
    80   @$(NORMAL_INSTALL)
    81   @$(MAKE) $(AM_MAKEFLAGS) install-html
     56install-data-hook: install-html
    8257
    8358installdirs-local:
     
    9570    test -z "$(DESTDIR)$(htmldir)" || \
    9671    { $(MKDIR_P) "$(DESTDIR)$(htmldir)"; \
    97       $(INSTALL_DATA) $(DX_HTML_OUTPUT)/* $(DESTDIR)$(htmldir); \
     72      $(INSTALL_DATA) doc/$(DX_HTML_OUTPUT)/* $(DESTDIR)$(htmldir); \
    9873    } \
    9974  fi
     
    10378  rm -rf $(DESTDIR)$(htmldir)
    10479
    105 mostlyclean-local:
    106   rm -f doxygen.error *~
    107 
    108 clean-local:
    109   rm -rf $(DX_HTML_OUTPUT)
    110 
    111 FORCE:
     80MOSTLYCLEANFILES += doc/doxygen.error
  • trunk/doc/doxygen.config.in

    r2632 r2739  
    4040#---------------------------------------------------------------------------
    4141
    42 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
     42# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    4343# by quotes) that should identify the project.
    4444
    4545PROJECT_NAME           = "@PACKAGE@"
    4646
    47 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
    48 # This could be handy for archiving the generated documentation or 
     47# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     48# This could be handy for archiving the generated documentation or
    4949# if some version control system is used.
    5050
    5151PROJECT_NUMBER         = @PACKAGE_VERSION@
    5252
    53 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    54 # base path where the generated documentation will be put. 
    55 # If a relative path is entered, it will be relative to the location 
     53# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     54# base path where the generated documentation will be put.
     55# If a relative path is entered, it will be relative to the location
    5656# where doxygen was started. If left blank the current directory will be used.
    5757
    58 OUTPUT_DIRECTORY       = .
    59 
    60 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    61 # documentation generated by doxygen is written. Doxygen will use this 
    62 # information to generate all constant output in the proper language. 
    63 # The default language is English, other supported languages are: 
    64 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, 
    65 # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, 
     58OUTPUT_DIRECTORY       = doc
     59
     60# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     61# documentation generated by doxygen is written. Doxygen will use this
     62# information to generate all constant output in the proper language.
     63# The default language is English, other supported languages are:
     64# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
     65# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
    6666# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
    6767
    6868OUTPUT_LANGUAGE        = English
    6969
    70 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
    71 # documentation are documented, even if no documentation was available. 
    72 # Private class members and static file members will be hidden unless 
     70# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     71# documentation are documented, even if no documentation was available.
     72# Private class members and static file members will be hidden unless
    7373# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    7474
    7575EXTRACT_ALL            = NO
    7676
    77 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
     77# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    7878# will be included in the documentation.
    7979
    8080EXTRACT_PRIVATE        = NO
    8181
    82 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
     82# If the EXTRACT_STATIC tag is set to YES all static members of a file
    8383# will be included in the documentation.
    8484
    8585EXTRACT_STATIC         = NO
    8686
    87 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
    88 # defined locally in source files will be included in the documentation. 
     87# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
     88# defined locally in source files will be included in the documentation.
    8989# If set to NO only classes defined in header files are included.
    9090
    9191EXTRACT_LOCAL_CLASSES  = YES
    9292
    93 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
    94 # undocumented members of documented classes, files or namespaces. 
    95 # If set to NO (the default) these members will be included in the 
    96 # various overviews, but no documentation section is generated. 
     93# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     94# undocumented members of documented classes, files or namespaces.
     95# If set to NO (the default) these members will be included in the
     96# various overviews, but no documentation section is generated.
    9797# This option has no effect if EXTRACT_ALL is enabled.
    9898
    9999HIDE_UNDOC_MEMBERS     = NO
    100100
    101 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
    102 # undocumented classes that are normally visible in the class hierarchy. 
    103 # If set to NO (the default) these class will be included in the various 
     101# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
     102# undocumented classes that are normally visible in the class hierarchy.
     103# If set to NO (the default) these class will be included in the various
    104104# overviews. This option has no effect if EXTRACT_ALL is enabled.
    105105
    106106HIDE_UNDOC_CLASSES     = NO
    107107
    108 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
    109 # include brief member descriptions after the members that are listed in 
    110 # the file and class documentation (similar to JavaDoc). 
     108# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     109# include brief member descriptions after the members that are listed in
     110# the file and class documentation (similar to JavaDoc).
    111111# Set to NO to disable this.
    112112
    113113BRIEF_MEMBER_DESC      = YES
    114114
    115 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
    116 # the brief description of a member or function before the detailed description. 
    117 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
     115# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
     116# the brief description of a member or function before the detailed description.
     117# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    118118# brief descriptions will be completely suppressed.
    119119
    120120REPEAT_BRIEF           = YES
    121121
    122 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
    123 # Doxygen will generate a detailed section even if there is only a brief 
     122# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     123# Doxygen will generate a detailed section even if there is only a brief
    124124# description.
    125125
    126126ALWAYS_DETAILED_SEC    = NO
    127127
    128 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
    129 # members of a class in the documentation of that class as if those members were 
    130 # ordinary class members. Constructors, destructors and assignment operators of 
     128# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
     129# members of a class in the documentation of that class as if those members were
     130# ordinary class members. Constructors, destructors and assignment operators of
    131131# the base classes will not be shown.
    132132
    133133INLINE_INHERITED_MEMB  = YES
    134134
    135 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
    136 # path before files name in the file list and in the header files. If set 
     135# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     136# path before files name in the file list and in the header files. If set
    137137# to NO the shortest path that makes the file name unique will be used.
    138138
    139139FULL_PATH_NAMES        = YES
    140140
    141 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
    142 # can be used to strip a user defined part of the path. Stripping is 
    143 # only done if one of the specified strings matches the left-hand part of 
     141# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     142# can be used to strip a user defined part of the path. Stripping is
     143# only done if one of the specified strings matches the left-hand part of
    144144# the path. It is allowed to use relative paths in the argument list.
    145145
    146 STRIP_FROM_PATH        = @top_srcdir@
    147 
    148 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
    149 # the path mentioned in the documentation of a class, which tells 
    150 # the reader which header file to include in order to use a class. 
    151 # If left blank only the name of the header file containing the class 
    152 # definition is used. Otherwise one should specify the include paths that 
     146STRIP_FROM_PATH        = @srcdir@
     147
     148# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     149# the path mentioned in the documentation of a class, which tells
     150# the reader which header file to include in order to use a class.
     151# If left blank only the name of the header file containing the class
     152# definition is used. Otherwise one should specify the include paths that
    153153# are normally passed to the compiler using the -I flag.
    154154
    155 STRIP_FROM_INC_PATH    = @top_srcdir@
    156 
    157 # The INTERNAL_DOCS tag determines if documentation 
    158 # that is typed after a \internal command is included. If the tag is set 
    159 # to NO (the default) then the documentation will be excluded. 
     155STRIP_FROM_INC_PATH    = @srcdir@
     156
     157# The INTERNAL_DOCS tag determines if documentation
     158# that is typed after a \internal command is included. If the tag is set
     159# to NO (the default) then the documentation will be excluded.
    160160# Set it to YES to include the internal documentation.
    161161
    162162INTERNAL_DOCS          = YES
    163163
    164 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
    165 # doxygen to hide any special comment blocks from generated source code 
     164# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
     165# doxygen to hide any special comment blocks from generated source code
    166166# fragments. Normal C and C++ comments will always remain visible.
    167167
    168168STRIP_CODE_COMMENTS    = YES
    169169
    170 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
    171 # file names in lower case letters. If set to YES upper case letters are also 
    172 # allowed. This is useful if you have classes or files whose names only differ 
    173 # in case and if your file system supports case sensitive file names. Windows 
     170# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
     171# file names in lower case letters. If set to YES upper case letters are also
     172# allowed. This is useful if you have classes or files whose names only differ
     173# in case and if your file system supports case sensitive file names. Windows
    174174# users are adviced to set this option to NO.
    175175
    176176CASE_SENSE_NAMES       = YES
    177177
    178 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
    179 # (but less readable) file names. This can be useful is your file systems 
     178# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     179# (but less readable) file names. This can be useful is your file systems
    180180# doesn't support long names like on DOS, Mac, or CD-ROM.
    181181
    182182SHORT_NAMES            = NO
    183183
    184 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
    185 # will show members with their full class and namespace scopes in the 
     184# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     185# will show members with their full class and namespace scopes in the
    186186# documentation. If set to YES the scope will be hidden.
    187187
    188188HIDE_SCOPE_NAMES       = NO
    189189
    190 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
    191 # will generate a verbatim copy of the header file for each class for 
     190# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     191# will generate a verbatim copy of the header file for each class for
    192192# which an include is specified. Set to NO to disable this.
    193193
    194194VERBATIM_HEADERS       = YES
    195195
    196 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
    197 # will put list of the files that are included by a file in the documentation 
     196# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
     197# will put list of the files that are included by a file in the documentation
    198198# of that file.
    199199
    200200SHOW_INCLUDE_FILES     = YES
    201201
    202 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
    203 # will interpret the first line (until the first dot) of a JavaDoc-style 
    204 # comment as the brief description. If set to NO, the JavaDoc 
    205 # comments  will behave just like the Qt-style comments (thus requiring an 
     202# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
     203# will interpret the first line (until the first dot) of a JavaDoc-style
     204# comment as the brief description. If set to NO, the JavaDoc
     205# comments  will behave just like the Qt-style comments (thus requiring an
    206206# explict @brief command for a brief description.
    207207
    208208JAVADOC_AUTOBRIEF      = NO
    209209
    210 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
    211 # member inherits the documentation from any documented member that it 
     210# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     211# member inherits the documentation from any documented member that it
    212212# reimplements.
    213213
    214214INHERIT_DOCS           = YES
    215215
    216 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
     216# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    217217# is inserted in the documentation for inline members.
    218218
    219219INLINE_INFO            = YES
    220220
    221 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
    222 # will sort the (detailed) documentation of file and class members 
    223 # alphabetically by member name. If set to NO the members will appear in 
     221# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
     222# will sort the (detailed) documentation of file and class members
     223# alphabetically by member name. If set to NO the members will appear in
    224224# declaration order.
    225225
    226226SORT_MEMBER_DOCS       = YES
    227227
    228 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
    229 # sorted by fully-qualified names, including namespaces. If set to 
    230 # NO (the default), the class list will be sorted only by class name, 
    231 # not including the namespace part. 
     228# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     229# sorted by fully-qualified names, including namespaces. If set to
     230# NO (the default), the class list will be sorted only by class name,
     231# not including the namespace part.
    232232# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    233 # Note: This option applies only to the class list, not to the 
     233# Note: This option applies only to the class list, not to the
    234234# alphabetical list.
    235235
    236236SORT_BY_SCOPE_NAME     = YES
    237237
    238 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
    239 # tag is set to YES, then doxygen will reuse the documentation of the first 
    240 # member in the group (if any) for the other members of the group. By default 
     238# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     239# tag is set to YES, then doxygen will reuse the documentation of the first
     240# member in the group (if any) for the other members of the group. By default
    241241# all members of a group must be documented explicitly.
    242242
    243243DISTRIBUTE_GROUP_DOC   = YES
    244244
    245 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
     245# The TAB_SIZE tag can be used to set the number of spaces in a tab.
    246246# Doxygen uses this value to replace tabs by spaces in code fragments.
    247247
    248248TAB_SIZE               = 2
    249249
    250 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
    251 # disable (NO) the todo list. This list is created by putting \todo 
     250# The GENERATE_TODOLIST tag can be used to enable (YES) or
     251# disable (NO) the todo list. This list is created by putting \todo
    252252# commands in the documentation.
    253253
    254254GENERATE_TODOLIST      = NO
    255255
    256 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
    257 # disable (NO) the test list. This list is created by putting \test 
     256# The GENERATE_TESTLIST tag can be used to enable (YES) or
     257# disable (NO) the test list. This list is created by putting \test
    258258# commands in the documentation.
    259259
    260260GENERATE_TESTLIST      = NO
    261261
    262 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
    263 # disable (NO) the bug list. This list is created by putting \bug 
     262# The GENERATE_BUGLIST tag can be used to enable (YES) or
     263# disable (NO) the bug list. This list is created by putting \bug
    264264# commands in the documentation.
    265265
    266266GENERATE_BUGLIST       = NO
    267267
    268 # This tag can be used to specify a number of aliases that acts 
    269 # as commands in the documentation. An alias has the form "name=value". 
    270 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
    271 # put the command \sideeffect (or @sideeffect) in the documentation, which 
    272 # will result in a user defined paragraph with heading "Side Effects:". 
     268# This tag can be used to specify a number of aliases that acts
     269# as commands in the documentation. An alias has the form "name=value".
     270# For example adding "sideeffect=\par Side Effects:\n" will allow you to
     271# put the command \sideeffect (or @sideeffect) in the documentation, which
     272# will result in a user defined paragraph with heading "Side Effects:".
    273273# You can put \n's in the value part of an alias to insert newlines.
    274274
     
    281281ALIASES += "boost_url=http://www.boost.org/doc/libs/1_35_0/libs"
    282282
    283 # The ENABLED_SECTIONS tag can be used to enable conditional 
     283# The ENABLED_SECTIONS tag can be used to enable conditional
    284284# documentation sections, marked by \if sectionname ... \endif.
    285285
    286 ENABLED_SECTIONS       = 
    287 
    288 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
    289 # the initial value of a variable or define consist of for it to appear in 
    290 # the documentation. If the initializer consists of more lines than specified 
    291 # here it will be hidden. Use a value of 0 to hide initializers completely. 
    292 # The appearance of the initializer of individual variables and defines in the 
    293 # documentation can be controlled using \showinitializer or \hideinitializer 
     286ENABLED_SECTIONS       =
     287
     288# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
     289# the initial value of a variable or define consist of for it to appear in
     290# the documentation. If the initializer consists of more lines than specified
     291# here it will be hidden. Use a value of 0 to hide initializers completely.
     292# The appearance of the initializer of individual variables and defines in the
     293# documentation can be controlled using \showinitializer or \hideinitializer
    294294# command in the documentation regardless of this setting.
    295295
    296296MAX_INITIALIZER_LINES  = 30
    297297
    298 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
    299 # only. Doxygen will then generate output that is more tailored for C. 
    300 # For instance some of the names that are used will be different. The list 
     298# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
     299# only. Doxygen will then generate output that is more tailored for C.
     300# For instance some of the names that are used will be different. The list
    301301# of all members will be omitted, etc.
    302302
     
    307307#---------------------------------------------------------------------------
    308308
    309 # The QUIET tag can be used to turn on/off the messages that are generated 
     309# The QUIET tag can be used to turn on/off the messages that are generated
    310310# by doxygen. Possible values are YES and NO. If left blank NO is used.
    311311
    312312QUIET                  = NO
    313313
    314 # The WARNINGS tag can be used to turn on/off the warning messages that are 
    315 # generated by doxygen. Possible values are YES and NO. If left blank 
     314# The WARNINGS tag can be used to turn on/off the warning messages that are
     315# generated by doxygen. Possible values are YES and NO. If left blank
    316316# NO is used.
    317317
    318318WARNINGS               = YES
    319319
    320 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
    321 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
     320# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
     321# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    322322# automatically be disabled.
    323323
    324324WARN_IF_UNDOCUMENTED   = YES
    325325
    326 # The WARN_FORMAT tag determines the format of the warning messages that 
    327 # doxygen can produce. The string should contain the $file, $line, and $text 
    328 # tags, which will be replaced by the file and line number from which the 
     326# The WARN_FORMAT tag determines the format of the warning messages that
     327# doxygen can produce. The string should contain the $file, $line, and $text
     328# tags, which will be replaced by the file and line number from which the
    329329# warning originated and the warning text.
    330330
    331 WARN_FORMAT            = 
    332 
    333 # The WARN_LOGFILE tag can be used to specify a file to which warning 
    334 # and error messages should be written. If left blank the output is written 
     331WARN_FORMAT            =
     332
     333# The WARN_LOGFILE tag can be used to specify a file to which warning
     334# and error messages should be written. If left blank the output is written
    335335# to stderr.
    336336
    337 WARN_LOGFILE           = doxygen.error
     337WARN_LOGFILE           = doc/doxygen.error
    338338
    339339#---------------------------------------------------------------------------
     
    341341#---------------------------------------------------------------------------
    342342
    343 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
    344 # should be searched for input files as well. Possible values are YES and NO. 
     343# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     344# should be searched for input files as well. Possible values are YES and NO.
    345345# If left blank NO is used.
    346346
    347347RECURSIVE              = YES
    348348
    349 # The EXCLUDE tag can be used to specify files and/or directories that should 
    350 # excluded from the INPUT source files. This way you can easily exclude a 
     349# The EXCLUDE tag can be used to specify files and/or directories that should
     350# excluded from the INPUT source files. This way you can easily exclude a
    351351# subdirectory from a directory tree whose root is specified with the INPUT tag.
    352352
    353 EXCLUDE                = 
    354 
    355 # If the value of the INPUT tag contains directories, you can use the 
    356 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
     353EXCLUDE                =
     354
     355# If the value of the INPUT tag contains directories, you can use the
     356# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    357357# certain files from those directories.
    358358
    359359EXCLUDE_PATTERNS       = .svn .deps .libs .svndigest
    360360
    361 # The EXAMPLE_PATH tag can be used to specify one or more files or 
    362 # directories that contain example code fragments that are included (see 
     361# The EXAMPLE_PATH tag can be used to specify one or more files or
     362# directories that contain example code fragments that are included (see
    363363# the \include command).
    364364
    365 EXAMPLE_PATH           = 
    366 
    367 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    368 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    369 # and *.h) to filter out the source-files in the directories. If left 
     365EXAMPLE_PATH           =
     366
     367# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     368# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     369# and *.h) to filter out the source-files in the directories. If left
    370370# blank all files are included.
    371371
    372 EXAMPLE_PATTERNS       = 
    373 
    374 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
    375 # searched for input files to be used with the \include or \dontinclude 
    376 # commands irrespective of the value of the RECURSIVE tag. 
     372EXAMPLE_PATTERNS       =
     373
     374# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     375# searched for input files to be used with the \include or \dontinclude
     376# commands irrespective of the value of the RECURSIVE tag.
    377377# Possible values are YES and NO. If left blank NO is used.
    378378
    379379EXAMPLE_RECURSIVE      = NO
    380380
    381 # The IMAGE_PATH tag can be used to specify one or more files or 
    382 # directories that contain image that are included in the documentation (see 
     381# The IMAGE_PATH tag can be used to specify one or more files or
     382# directories that contain image that are included in the documentation (see
    383383# the \image command).
    384384
    385 IMAGE_PATH             = 
    386 
    387 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
    388 # invoke to filter for each input file. Doxygen will invoke the filter program 
    389 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
    390 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
    391 # input file. Doxygen will then use the output that the filter program writes 
     385IMAGE_PATH             =
     386
     387# The INPUT_FILTER tag can be used to specify a program that doxygen should
     388# invoke to filter for each input file. Doxygen will invoke the filter program
     389# by executing (via popen()) the command <filter> <input-file>, where <filter>
     390# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
     391# input file. Doxygen will then use the output that the filter program writes
    392392# to standard output.
    393393
    394 INPUT_FILTER           = 
    395 
    396 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
    397 # INPUT_FILTER) will be used to filter the input files when producing source 
     394INPUT_FILTER           =
     395
     396# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     397# INPUT_FILTER) will be used to filter the input files when producing source
    398398# files to browse.
    399399
     
    404404#---------------------------------------------------------------------------
    405405
    406 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
     406# If the SOURCE_BROWSER tag is set to YES then a list of source files will
    407407# be generated. Documented entities will be cross-referenced with these sources.
    408408
    409409SOURCE_BROWSER         = NO
    410410
    411 # Setting the INLINE_SOURCES tag to YES will include the body 
     411# Setting the INLINE_SOURCES tag to YES will include the body
    412412# of functions and classes directly in the documentation.
    413413
    414414INLINE_SOURCES         = NO
    415415
    416 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
    417 # then for each documented function all documented 
     416# If the REFERENCED_BY_RELATION tag is set to YES (the default)
     417# then for each documented function all documented
    418418# functions referencing it will be listed.
    419419
    420420REFERENCED_BY_RELATION = NO
    421421
    422 # If the REFERENCES_RELATION tag is set to YES (the default) 
    423 # then for each documented function all documented entities 
     422# If the REFERENCES_RELATION tag is set to YES (the default)
     423# then for each documented function all documented entities
    424424# called/used by that function will be listed.
    425425
     
    430430#---------------------------------------------------------------------------
    431431
    432 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
    433 # of all compounds will be generated. Enable this if the project 
     432# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
     433# of all compounds will be generated. Enable this if the project
    434434# contains a lot of classes, structs, unions or interfaces.
    435435
    436436ALPHABETICAL_INDEX     = YES
    437437
    438 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
    439 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
     438# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     439# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    440440# in which this list will be split (can be a number in the range [1..20])
    441441
    442442COLS_IN_ALPHA_INDEX    = 5
    443443
    444 # In case all classes in a project start with a common prefix, all 
    445 # classes will be put under the same header in the alphabetical index. 
    446 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
     444# In case all classes in a project start with a common prefix, all
     445# classes will be put under the same header in the alphabetical index.
     446# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    447447# should be ignored while generating the index headers.
    448448
    449 IGNORE_PREFIX          = 
     449IGNORE_PREFIX          =
    450450
    451451#---------------------------------------------------------------------------
     
    453453#---------------------------------------------------------------------------
    454454
    455 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
     455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    456456# generate HTML output.
    457457
    458458GENERATE_HTML          = NO
    459459
    460 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
    461 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     460# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
     461# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    462462# put in front of it. If left blank `html' will be used as the default path.
    463463
    464464HTML_OUTPUT            = @DX_HTML_OUTPUT@
    465465
    466 # The HTML_HEADER tag can be used to specify a personal HTML header for 
    467 # each generated HTML page. If it is left blank doxygen will generate a 
     466# The HTML_HEADER tag can be used to specify a personal HTML header for
     467# each generated HTML page. If it is left blank doxygen will generate a
    468468# standard header.
    469469
    470 HTML_HEADER            = 
    471 
    472 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
    473 # each generated HTML page. If it is left blank doxygen will generate a 
     470HTML_HEADER            =
     471
     472# The HTML_FOOTER tag can be used to specify a personal HTML footer for
     473# each generated HTML page. If it is left blank doxygen will generate a
    474474# standard footer.
    475475
    476 HTML_FOOTER            = @srcdir@/footer.html
    477 
    478 # The HTML_STYLESHEET tag can be used to specify a user defined cascading 
    479 # style sheet that is used by each HTML page. It can be used to 
    480 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
     476HTML_FOOTER            = @srcdir@/doc/footer.html
     477
     478# The HTML_STYLESHEET tag can be used to specify a user defined cascading
     479# style sheet that is used by each HTML page. It can be used to
     480# fine-tune the look of the HTML output. If the tag is left blank doxygen
    481481# will generate a default style sheet
    482482
    483 HTML_STYLESHEET        = 
    484 
    485 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
    486 # files or namespaces will be aligned in HTML using tables. If set to 
     483HTML_STYLESHEET        =
     484
     485# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
     486# files or namespaces will be aligned in HTML using tables. If set to
    487487# NO a bullet list will be used.
    488488
    489489HTML_ALIGN_MEMBERS     = YES
    490490
    491 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
    492 # will be generated that can be used as input for tools like the 
    493 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
     491# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     492# will be generated that can be used as input for tools like the
     493# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
    494494# of the generated HTML documentation.
    495495
    496496GENERATE_HTMLHELP      = NO
    497497
    498 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
    499 # controls if a separate .chi index file is generated (YES) or that 
     498# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
     499# controls if a separate .chi index file is generated (YES) or that
    500500# it should be included in the master .chm file (NO).
    501501
    502502GENERATE_CHI           = NO
    503503
    504 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
    505 # controls whether a binary table of contents is generated (YES) or a 
     504# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
     505# controls whether a binary table of contents is generated (YES) or a
    506506# normal table of contents (NO) in the .chm file.
    507507
    508508BINARY_TOC             = NO
    509509
    510 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
     510# The TOC_EXPAND flag can be set to YES to add extra items for group members
    511511# to the contents of the Html help documentation and to the tree view.
    512512
    513513TOC_EXPAND             = NO
    514514
    515 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
    516 # top of each HTML page. The value NO (the default) enables the index and 
     515# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
     516# top of each HTML page. The value NO (the default) enables the index and
    517517# the value YES disables it.
    518518
    519519DISABLE_INDEX          = NO
    520520
    521 # This tag can be used to set the number of enum values (range [1..20]) 
     521# This tag can be used to set the number of enum values (range [1..20])
    522522# that doxygen will group on one line in the generated HTML documentation.
    523523
     
    525525
    526526# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
    527 # generated containing a tree-like index structure (just like the one that 
    528 # is generated for HTML Help). For this to work a browser that supports 
    529 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, 
    530 # or Internet explorer 4.0+). Note that for large projects the tree generation 
    531 # can take a very long time. In such cases it is better to disable this feature. 
     527# generated containing a tree-like index structure (just like the one that
     528# is generated for HTML Help). For this to work a browser that supports
     529# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
     530# or Internet explorer 4.0+). Note that for large projects the tree generation
     531# can take a very long time. In such cases it is better to disable this feature.
    532532# Windows users are probably better off using the HTML help feature.
    533533
    534534GENERATE_TREEVIEW      = NO
    535535
    536 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
    537 # used to set the initial width (in pixels) of the frame in which the tree 
     536# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     537# used to set the initial width (in pixels) of the frame in which the tree
    538538# is shown.
    539539
     
    544544#---------------------------------------------------------------------------
    545545
    546 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
     546# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    547547# generate Latex output.
    548548
    549549GENERATE_LATEX         = NO
    550550
    551 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
    552 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     551# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     552# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    553553# put in front of it. If left blank `latex' will be used as the default path.
    554554
    555 LATEX_OUTPUT           = 
    556 
    557 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
    558 # LaTeX documents. This may be useful for small projects and may help to 
     555LATEX_OUTPUT           =
     556
     557# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
     558# LaTeX documents. This may be useful for small projects and may help to
    559559# save some trees in general.
    560560
    561561COMPACT_LATEX          = NO
    562562
    563 # The PAPER_TYPE tag can be used to set the paper type that is used 
    564 # by the printer. Possible values are: a4, a4wide, letter, legal and 
     563# The PAPER_TYPE tag can be used to set the paper type that is used
     564# by the printer. Possible values are: a4, a4wide, letter, legal and
    565565# executive. If left blank a4wide will be used.
    566566
    567567PAPER_TYPE             = a4wide
    568568
    569 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
     569# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    570570# packages that should be included in the LaTeX output.
    571571
    572 EXTRA_PACKAGES         = 
    573 
    574 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
    575 # the generated latex document. The header should contain everything until 
    576 # the first chapter. If it is left blank doxygen will generate a 
     572EXTRA_PACKAGES         =
     573
     574# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
     575# the generated latex document. The header should contain everything until
     576# the first chapter. If it is left blank doxygen will generate a
    577577# standard header. Notice: only use this tag if you know what you are doing!
    578578
    579 LATEX_HEADER           = 
    580 
    581 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
    582 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
    583 # contain links (just like the HTML output) instead of page references 
     579LATEX_HEADER           =
     580
     581# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     582# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     583# contain links (just like the HTML output) instead of page references
    584584# This makes the output suitable for online browsing using a pdf viewer.
    585585
    586586PDF_HYPERLINKS         = YES
    587587
    588 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
    589 # plain latex in the generated Makefile. Set this option to YES to get a 
     588# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     589# plain latex in the generated Makefile. Set this option to YES to get a
    590590# higher quality PDF documentation.
    591591
    592592USE_PDFLATEX           = YES
    593593
    594 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
    595 # command to the generated LaTeX files. This will instruct LaTeX to keep 
    596 # running if errors occur, instead of asking the user for help. 
     594# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     595# command to the generated LaTeX files. This will instruct LaTeX to keep
     596# running if errors occur, instead of asking the user for help.
    597597# This option is also used when generating formulas in HTML.
    598598
     
    603603#---------------------------------------------------------------------------
    604604
    605 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
    606 # The RTF output is optimised for Word 97 and may not look very pretty with 
     605# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
     606# The RTF output is optimised for Word 97 and may not look very pretty with
    607607# other RTF readers or editors.
    608608
    609609GENERATE_RTF           = NO
    610610
    611 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
    612 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     611# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
     612# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    613613# put in front of it. If left blank `rtf' will be used as the default path.
    614614
    615 RTF_OUTPUT             = 
    616 
    617 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
    618 # RTF documents. This may be useful for small projects and may help to 
     615RTF_OUTPUT             =
     616
     617# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
     618# RTF documents. This may be useful for small projects and may help to
    619619# save some trees in general.
    620620
    621621COMPACT_RTF            = NO
    622622
    623 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
    624 # will contain hyperlink fields. The RTF file will 
    625 # contain links (just like the HTML output) instead of page references. 
    626 # This makes the output suitable for online browsing using WORD or other 
    627 # programs which support those fields. 
     623# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
     624# will contain hyperlink fields. The RTF file will
     625# contain links (just like the HTML output) instead of page references.
     626# This makes the output suitable for online browsing using WORD or other
     627# programs which support those fields.
    628628# Note: wordpad (write) and others do not support links.
    629629
    630630RTF_HYPERLINKS         = NO
    631631
    632 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
    633 # config file, i.e. a series of assigments. You only have to provide 
     632# Load stylesheet definitions from file. Syntax is similar to doxygen's
     633# config file, i.e. a series of assigments. You only have to provide
    634634# replacements, missing definitions are set to their default value.
    635635
    636 RTF_STYLESHEET_FILE    = 
    637 
    638 # Set optional variables used in the generation of an rtf document. 
     636RTF_STYLESHEET_FILE    =
     637
     638# Set optional variables used in the generation of an rtf document.
    639639# Syntax is similar to doxygen's config file.
    640640
    641 RTF_EXTENSIONS_FILE    = 
     641RTF_EXTENSIONS_FILE    =
    642642
    643643#---------------------------------------------------------------------------
     
    645645#---------------------------------------------------------------------------
    646646
    647 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
     647# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    648648# generate man pages
    649649
    650650GENERATE_MAN           = NO
    651651
    652 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
    653 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     652# The MAN_OUTPUT tag is used to specify where the man pages will be put.
     653# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    654654# put in front of it. If left blank `man' will be used as the default path.
    655655
    656 MAN_OUTPUT             = 
    657 
    658 # The MAN_EXTENSION tag determines the extension that is added to 
     656MAN_OUTPUT             =
     657
     658# The MAN_EXTENSION tag determines the extension that is added to
    659659# the generated man pages (default is the subroutine's section .3)
    660660
    661 MAN_EXTENSION          = 
    662 
    663 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
    664 # then it will generate one additional man file for each entity 
    665 # documented in the real man page(s). These additional files 
    666 # only source the real man page, but without them the man command 
     661MAN_EXTENSION          =
     662
     663# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
     664# then it will generate one additional man file for each entity
     665# documented in the real man page(s). These additional files
     666# only source the real man page, but without them the man command
    667667# would be unable to find the correct page. The default is NO.
    668668
     
    673673#---------------------------------------------------------------------------
    674674
    675 # If the GENERATE_XML tag is set to YES Doxygen will 
    676 # generate an XML file that captures the structure of 
    677 # the code including all documentation. Note that this 
    678 # feature is still experimental and incomplete at the 
     675# If the GENERATE_XML tag is set to YES Doxygen will
     676# generate an XML file that captures the structure of
     677# the code including all documentation. Note that this
     678# feature is still experimental and incomplete at the
    679679# moment.
    680680
     
    685685#---------------------------------------------------------------------------
    686686
    687 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
    688 # generate an AutoGen Definitions (see autogen.sf.net) file 
    689 # that captures the structure of the code including all 
    690 # documentation. Note that this feature is still experimental 
     687# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
     688# generate an AutoGen Definitions (see autogen.sf.net) file
     689# that captures the structure of the code including all
     690# documentation. Note that this feature is still experimental
    691691# and incomplete at the moment.
    692692
     
    694694
    695695#---------------------------------------------------------------------------
    696 # Configuration options related to the preprocessor   
    697 #---------------------------------------------------------------------------
    698 
    699 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
    700 # evaluate all C-preprocessor directives found in the sources and include 
     696# Configuration options related to the preprocessor
     697#---------------------------------------------------------------------------
     698
     699# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
     700# evaluate all C-preprocessor directives found in the sources and include
    701701# files.
    702702
    703703ENABLE_PREPROCESSING   = YES
    704704
    705 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
    706 # names in the source code. If set to NO (the default) only conditional 
    707 # compilation will be performed. Macro expansion can be done in a controlled 
     705# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
     706# names in the source code. If set to NO (the default) only conditional
     707# compilation will be performed. Macro expansion can be done in a controlled
    708708# way by setting EXPAND_ONLY_PREDEF to YES.
    709709
    710710MACRO_EXPANSION        = YES
    711711
    712 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
    713 # then the macro expansion is limited to the macros specified with the 
     712# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
     713# then the macro expansion is limited to the macros specified with the
    714714# PREDEFINED and EXPAND_AS_PREDEFINED tags.
    715715
    716716EXPAND_ONLY_PREDEF     = YES
    717717
    718 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
     718# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    719719# in the INCLUDE_PATH (see below) will be search if a #include is found.
    720720
    721721SEARCH_INCLUDES        = YES
    722722
    723 # The INCLUDE_PATH tag can be used to specify one or more directories that 
    724 # contain include files that are not input files but should be processed by 
     723# The INCLUDE_PATH tag can be used to specify one or more directories that
     724# contain include files that are not input files but should be processed by
    725725# the preprocessor.
    726726
    727 INCLUDE_PATH           = 
    728 
    729 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
    730 # patterns (like *.h and *.hpp) to filter out the header-files in the 
    731 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
     727INCLUDE_PATH           =
     728
     729# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     730# patterns (like *.h and *.hpp) to filter out the header-files in the
     731# directories. If left blank, the patterns specified with FILE_PATTERNS will
    732732# be used.
    733733
    734 INCLUDE_FILE_PATTERNS  = 
    735 
    736 # The PREDEFINED tag can be used to specify one or more macro names that 
    737 # are defined before the preprocessor is started (similar to the -D option of 
    738 # gcc). The argument of the tag is a list of macros of the form: name 
    739 # or name=definition (no spaces). If the definition and the = are 
     734INCLUDE_FILE_PATTERNS  =
     735
     736# The PREDEFINED tag can be used to specify one or more macro names that
     737# are defined before the preprocessor is started (similar to the -D option of
     738# gcc). The argument of the tag is a list of macros of the form: name
     739# or name=definition (no spaces). If the definition and the = are
    740740# omitted =1 is assumed.
    741741
    742742PREDEFINED             = YAT_DEPRECATE=
    743743
    744 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
    745 # this tag can be used to specify a list of macro names that should be expanded. 
    746 # The macro definition that is found in the sources will be used. 
     744# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
     745# this tag can be used to specify a list of macro names that should be expanded.
     746# The macro definition that is found in the sources will be used.
    747747# Use the PREDEFINED tag if you want to use a different macro definition.
    748748
    749 EXPAND_AS_DEFINED      = 
    750 
    751 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
    752 # doxygen's preprocessor will remove all function-like macros that are alone 
    753 # on a line and do not end with a semicolon. Such function macros are typically 
     749EXPAND_AS_DEFINED      =
     750
     751# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
     752# doxygen's preprocessor will remove all function-like macros that are alone
     753# on a line and do not end with a semicolon. Such function macros are typically
    754754# used for boiler-plate code, and will confuse the parser if not removed.
    755755
     
    757757
    758758#---------------------------------------------------------------------------
    759 # Configuration::addtions related to external references   
     759# Configuration::addtions related to external references
    760760#---------------------------------------------------------------------------
    761761
    762762# The TAGFILES tag can be used to specify one or more tagfiles.
    763763
    764 TAGFILES               = 
    765 
    766 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
     764TAGFILES               =
     765
     766# When a file name is specified after GENERATE_TAGFILE, doxygen will create
    767767# a tag file that is based on the input files it reads.
    768768
    769 GENERATE_TAGFILE       = 
    770 
    771 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
    772 # in the class index. If set to NO only the inherited external classes 
     769GENERATE_TAGFILE       =
     770
     771# If the ALLEXTERNALS tag is set to YES all external classes will be listed
     772# in the class index. If set to NO only the inherited external classes
    773773# will be listed.
    774774
    775775ALLEXTERNALS           = NO
    776776
    777 # The PERL_PATH should be the absolute path and name of the perl script 
     777# The PERL_PATH should be the absolute path and name of the perl script
    778778# interpreter (i.e. the result of `which perl').
    779779
     
    781781
    782782#---------------------------------------------------------------------------
    783 # Configuration options related to the dot tool   
    784 #---------------------------------------------------------------------------
    785 
    786 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
    787 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 
    788 # super classes. Setting the tag to NO turns the diagrams off. Note that this 
    789 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
     783# Configuration options related to the dot tool
     784#---------------------------------------------------------------------------
     785
     786# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
     787# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
     788# super classes. Setting the tag to NO turns the diagrams off. Note that this
     789# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
    790790# recommended to install and use dot, since it yield more powerful graphs.
    791791
    792792CLASS_DIAGRAMS         = YES
    793793
    794 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
    795 # available from the path. This tool is part of Graphviz, a graph visualization 
    796 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
     794# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     795# available from the path. This tool is part of Graphviz, a graph visualization
     796# toolkit from AT&T and Lucent Bell Labs. The other options in this section
    797797# have no effect if this option is set to NO (the default)
    798798
    799799HAVE_DOT               = NO
    800800
    801 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
    802 # will generate a graph for each documented class showing the direct and 
    803 # indirect inheritance relations. Setting this tag to YES will force the 
     801# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
     802# will generate a graph for each documented class showing the direct and
     803# indirect inheritance relations. Setting this tag to YES will force the
    804804# the CLASS_DIAGRAMS tag to NO.
    805805
    806806CLASS_GRAPH            = YES
    807807
    808 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
    809 # will generate a graph for each documented class showing the direct and 
    810 # indirect implementation dependencies (inheritance, containment, and 
     808# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
     809# will generate a graph for each documented class showing the direct and
     810# indirect implementation dependencies (inheritance, containment, and
    811811# class references variables) of the class with other documented classes.
    812812
    813813COLLABORATION_GRAPH    = YES
    814814
    815 # If set to YES, the inheritance and collaboration graphs will show the 
     815# If set to YES, the inheritance and collaboration graphs will show the
    816816# relations between templates and their instances.
    817817
    818818TEMPLATE_RELATIONS     = YES
    819819
    820 # If set to YES, the inheritance and collaboration graphs will hide 
    821 # inheritance and usage relations if the target is undocumented 
     820# If set to YES, the inheritance and collaboration graphs will hide
     821# inheritance and usage relations if the target is undocumented
    822822# or is not a class.
    823823
    824824HIDE_UNDOC_RELATIONS   = YES
    825825
    826 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
    827 # tags are set to YES then doxygen will generate a graph for each documented 
    828 # file showing the direct and indirect include dependencies of the file with 
     826# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
     827# tags are set to YES then doxygen will generate a graph for each documented
     828# file showing the direct and indirect include dependencies of the file with
    829829# other documented files.
    830830
    831831INCLUDE_GRAPH          = YES
    832832
    833 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
    834 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
    835 # documented header file showing the documented files that directly or 
     833# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
     834# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
     835# documented header file showing the documented files that directly or
    836836# indirectly include this file.
    837837
    838838INCLUDED_BY_GRAPH      = YES
    839839
    840 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
     840# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    841841# will graphical hierarchy of all classes instead of a textual one.
    842842
    843843GRAPHICAL_HIERARCHY    = YES
    844844
    845 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
     845# The tag DOT_PATH can be used to specify the path where the dot tool can be
    846846# found. If left blank, it is assumed the dot tool can be found on the path.
    847847
    848 DOT_PATH               = 
    849 
    850 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
    851 # contain dot files that are included in the documentation (see the 
     848DOT_PATH               =
     849
     850# The DOTFILE_DIRS tag can be used to specify one or more directories that
     851# contain dot files that are included in the documentation (see the
    852852# \dotfile command).
    853853
    854 DOTFILE_DIRS           = 
    855 
    856 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
    857 # generate a legend page explaining the meaning of the various boxes and 
     854DOTFILE_DIRS           =
     855
     856# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     857# generate a legend page explaining the meaning of the various boxes and
    858858# arrows in the dot generated graphs.
    859859
    860860GENERATE_LEGEND        = YES
    861861
    862 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
    863 # remove the intermedate dot files that are used to generate 
     862# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
     863# remove the intermedate dot files that are used to generate
    864864# the various graphs.
    865865
     
    867867
    868868#---------------------------------------------------------------------------
    869 # Configuration::addtions related to the search engine   
    870 #---------------------------------------------------------------------------
    871 
    872 # The SEARCHENGINE tag specifies whether or not a search engine should be 
     869# Configuration::addtions related to the search engine
     870#---------------------------------------------------------------------------
     871
     872# The SEARCHENGINE tag specifies whether or not a search engine should be
    873873# used. If set to NO the values of all tags below this one will be ignored.
    874874
    875875SEARCHENGINE           = NO
    876876
    877 # The CGI_NAME tag should be the name of the CGI script that 
    878 # starts the search engine (doxysearch) with the correct parameters. 
     877# The CGI_NAME tag should be the name of the CGI script that
     878# starts the search engine (doxysearch) with the correct parameters.
    879879# A script with this name will be generated by doxygen.
    880880
    881 #CGI_NAME               = 
    882 
    883 # The CGI_URL tag should be the absolute URL to the directory where the 
    884 # cgi binaries are located. See the documentation of your http daemon for 
     881#CGI_NAME               =
     882
     883# The CGI_URL tag should be the absolute URL to the directory where the
     884# cgi binaries are located. See the documentation of your http daemon for
    885885# details.
    886886
    887 #CGI_URL                = 
    888 
    889 # The DOC_URL tag should be the absolute URL to the directory where the 
    890 # documentation is located. If left blank the absolute path to the 
     887#CGI_URL                =
     888
     889# The DOC_URL tag should be the absolute URL to the directory where the
     890# documentation is located. If left blank the absolute path to the
    891891# documentation, with file:// prepended to it, will be used.
    892892
    893 #DOC_URL                = 
    894 
    895 # The DOC_ABSPATH tag should be the absolute path to the directory where the 
    896 # documentation is located. If left blank the directory on the local machine 
     893#DOC_URL                =
     894
     895# The DOC_ABSPATH tag should be the absolute path to the directory where the
     896# documentation is located. If left blank the directory on the local machine
    897897# will be used.
    898898
    899 #DOC_ABSPATH            = 
    900 
    901 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
     899#DOC_ABSPATH            =
     900
     901# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
    902902# is installed.
    903903
    904 #BIN_ABSPATH            = 
    905 
    906 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
    907 # documentation generated for other projects. This allows doxysearch to search 
     904#BIN_ABSPATH            =
     905
     906# The EXT_DOC_PATHS tag can be used to specify one or more paths to
     907# documentation generated for other projects. This allows doxysearch to search
    908908# the documentation for these projects as well.
    909909
    910 #EXT_DOC_PATHS          = 
     910#EXT_DOC_PATHS          =
Note: See TracChangeset for help on using the changeset viewer.