doc/Doxyfile
changeset 939 1559584ca634
parent 922 e816fac59f6d
child 953 d9c115e2eeaf
     1.1 --- a/doc/Doxyfile	Tue Oct 05 09:41:05 2004 +0000
     1.2 +++ b/doc/Doxyfile	Thu Oct 07 07:39:42 2004 +0000
     1.3 @@ -1,4 +1,4 @@
     1.4 -# Doxyfile 1.3.6
     1.5 +# Doxyfile 1.3.9
     1.6  
     1.7  # This file describes the settings to be used by the documentation system
     1.8  # doxygen (www.doxygen.org) for a project
     1.9 @@ -23,7 +23,7 @@
    1.10  # This could be handy for archiving the generated documentation or 
    1.11  # if some version control system is used.
    1.12  
    1.13 -PROJECT_NUMBER         = 0.2
    1.14 +PROJECT_NUMBER         = 0.3
    1.15  
    1.16  # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    1.17  # base path where the generated documentation will be put. 
    1.18 @@ -32,14 +32,24 @@
    1.19  
    1.20  OUTPUT_DIRECTORY       = 
    1.21  
    1.22 +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
    1.23 +# 4096 sub-directories (in 2 levels) under the output directory of each output 
    1.24 +# format and will distribute the generated files over these directories. 
    1.25 +# Enabling this option can be useful when feeding doxygen a huge amount of source 
    1.26 +# files, where putting all generated files in the same directory would otherwise 
    1.27 +# cause performance problems for the file system.
    1.28 +
    1.29 +CREATE_SUBDIRS         = NO
    1.30 +
    1.31  # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    1.32  # documentation generated by doxygen is written. Doxygen will use this 
    1.33  # information to generate all constant output in the proper language. 
    1.34  # The default language is English, other supported languages are: 
    1.35 -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
    1.36 -# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 
    1.37 -# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, 
    1.38 -# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
    1.39 +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 
    1.40 +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 
    1.41 +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 
    1.42 +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
    1.43 +# Swedish, and Ukrainian.
    1.44  
    1.45  OUTPUT_LANGUAGE        = English
    1.46  
    1.47 @@ -95,16 +105,25 @@
    1.48  # path before files name in the file list and in the header files. If set 
    1.49  # to NO the shortest path that makes the file name unique will be used.
    1.50  
    1.51 -FULL_PATH_NAMES        = NO
    1.52 +FULL_PATH_NAMES        = YES
    1.53  
    1.54  # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
    1.55  # can be used to strip a user-defined part of the path. Stripping is 
    1.56  # only done if one of the specified strings matches the left-hand part of 
    1.57 -# the path. It is allowed to use relative paths in the argument list. 
    1.58 +# the path. The tag can be used to show relative paths in the file list. 
    1.59  # If left blank the directory from which doxygen is run is used as the 
    1.60  # path to strip.
    1.61  
    1.62 -STRIP_FROM_PATH        = 
    1.63 +STRIP_FROM_PATH        = ../src
    1.64 +
    1.65 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
    1.66 +# the path mentioned in the documentation of a class, which tells 
    1.67 +# the reader which header file to include in order to use a class. 
    1.68 +# If left blank only the name of the header file containing the class 
    1.69 +# definition is used. Otherwise one should specify the include paths that 
    1.70 +# are normally passed to the compiler using the -I flag.
    1.71 +
    1.72 +STRIP_FROM_INC_PATH    = ../src
    1.73  
    1.74  # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
    1.75  # (but less readable) file names. This can be useful is your file systems 
    1.76 @@ -211,6 +230,13 @@
    1.77  
    1.78  EXTRACT_LOCAL_CLASSES  = YES
    1.79  
    1.80 +# This flag is only useful for Objective-C code. When set to YES local 
    1.81 +# methods, which are defined in the implementation section but not in 
    1.82 +# the interface are included in the documentation. 
    1.83 +# If set to NO (the default) only methods in the interface are included.
    1.84 +
    1.85 +EXTRACT_LOCAL_METHODS  = NO
    1.86 +
    1.87  # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
    1.88  # undocumented members of documented classes, files or namespaces. 
    1.89  # If set to NO (the default) these members will be included in the 
    1.90 @@ -251,7 +277,7 @@
    1.91  # file names in lower-case letters. If set to YES upper-case letters are also 
    1.92  # allowed. This is useful if you have classes or files whose names only differ 
    1.93  # in case and if your file system supports case sensitive file names. Windows 
    1.94 -# users are advised to set this option to NO.
    1.95 +# and Mac users are advised to set this option to NO.
    1.96  
    1.97  CASE_SENSE_NAMES       = YES
    1.98  
    1.99 @@ -341,6 +367,12 @@
   1.100  
   1.101  SHOW_USED_FILES        = YES
   1.102  
   1.103 +# If the sources in your project are distributed over multiple directories 
   1.104 +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
   1.105 +# in the documentation.
   1.106 +
   1.107 +SHOW_DIRECTORIES       = YES
   1.108 +
   1.109  #---------------------------------------------------------------------------
   1.110  # configuration options related to warning and progress messages
   1.111  #---------------------------------------------------------------------------
   1.112 @@ -392,7 +424,7 @@
   1.113  # with spaces.
   1.114  
   1.115  INPUT                  = mainpage.dox \
   1.116 -			 graphs.dox \
   1.117 +                         graphs.dox \
   1.118                           maps.dox \
   1.119                           coding_style.dox \
   1.120                           groups.dox \
   1.121 @@ -406,7 +438,7 @@
   1.122  # and *.h) to filter out the source-files in the directories. If left 
   1.123  # blank the following patterns are tested: 
   1.124  # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
   1.125 -# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
   1.126 +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
   1.127  
   1.128  FILE_PATTERNS          = 
   1.129  
   1.130 @@ -464,10 +496,20 @@
   1.131  # by executing (via popen()) the command <filter> <input-file>, where <filter> 
   1.132  # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
   1.133  # input file. Doxygen will then use the output that the filter program writes 
   1.134 -# to standard output.
   1.135 +# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
   1.136 +# ignored.
   1.137  
   1.138  INPUT_FILTER           = 
   1.139  
   1.140 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
   1.141 +# basis.  Doxygen will compare the file name with each pattern and apply the 
   1.142 +# filter if there is a match.  The filters are a list of the form: 
   1.143 +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
   1.144 +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
   1.145 +# is applied to all files.
   1.146 +
   1.147 +FILTER_PATTERNS        = 
   1.148 +
   1.149  # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
   1.150  # INPUT_FILTER) will be used to filter the input files when producing source 
   1.151  # files to browse (i.e. when SOURCE_BROWSER is set to YES).
   1.152 @@ -920,7 +962,9 @@
   1.153  # are defined before the preprocessor is started (similar to the -D option of 
   1.154  # gcc). The argument of the tag is a list of macros of the form: name 
   1.155  # or name=definition (no spaces). If the definition and the = are 
   1.156 -# omitted =1 is assumed.
   1.157 +# omitted =1 is assumed. To prevent a macro definition from being 
   1.158 +# undefined via #undef or recursively expanded use the := operator 
   1.159 +# instead of the = operator.
   1.160  
   1.161  PREDEFINED             = DOXYGEN
   1.162