Changeset 974 for trunk/psLib/src/Doxyfile
- Timestamp:
- Jun 9, 2004, 3:58:06 PM (22 years ago)
- File:
-
- 1 edited
-
trunk/psLib/src/Doxyfile (modified) (9 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/psLib/src/Doxyfile
r648 r974 20 20 PROJECT_NAME = "Pan-STARRS Foundation Library" 21 21 22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 23 # This could be handy for archiving the generated documentation or 22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 23 # This could be handy for archiving the generated documentation or 24 24 # if some version control system is used. 25 25 26 26 PROJECT_NUMBER = "$Name: not supported by cvs2svn $" 27 27 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 29 # base path where the generated documentation will be put. 30 # If a relative path is entered, it will be relative to the location 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 29 # base path where the generated documentation will be put. 30 # If a relative path is entered, it will be relative to the location 31 31 # where doxygen was started. If left blank the current directory will be used. 32 32 33 33 OUTPUT_DIRECTORY = ../docs 34 34 35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 36 # documentation generated by doxygen is written. Doxygen will use this 37 # information to generate all constant output in the proper language. 38 # The default language is English, other supported languages are: 39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 36 # documentation generated by doxygen is written. Doxygen will use this 37 # information to generate all constant output in the proper language. 38 # The default language is English, other supported languages are: 39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 42 42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 43 43 44 44 OUTPUT_LANGUAGE = English 45 45 46 # This tag can be used to specify the encoding used in the generated output. 47 # The encoding is not always determined by the language that is chosen, 48 # but also whether or not the output is meant for Windows or non-Windows users. 49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 50 # forces the Windows encoding (this is the default for the Windows binary), 51 # whereas setting the tag to NO uses a Unix-style encoding (the default for 46 # This tag can be used to specify the encoding used in the generated output. 47 # The encoding is not always determined by the language that is chosen, 48 # but also whether or not the output is meant for Windows or non-Windows users. 49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 50 # forces the Windows encoding (this is the default for the Windows binary), 51 # whereas setting the tag to NO uses a Unix-style encoding (the default for 52 52 # all platforms other than Windows). 53 53 54 54 USE_WINDOWS_ENCODING = NO 55 55 56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 57 # include brief member descriptions after the members that are listed in 58 # the file and class documentation (similar to JavaDoc). 56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 57 # include brief member descriptions after the members that are listed in 58 # the file and class documentation (similar to JavaDoc). 59 59 # Set to NO to disable this. 60 60 61 61 BRIEF_MEMBER_DESC = YES 62 62 63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 64 # the brief description of a member or function before the detailed description. 65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 64 # the brief description of a member or function before the detailed description. 65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 66 66 # brief descriptions will be completely suppressed. 67 67 68 68 REPEAT_BRIEF = YES 69 69 70 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 71 # Doxygen will generate a detailed section even if there is only a brief 70 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 71 # Doxygen will generate a detailed section even if there is only a brief 72 72 # description. 73 73 74 74 ALWAYS_DETAILED_SEC = YES 75 75 76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 77 # members of a class in the documentation of that class as if those members were 78 # ordinary class members. Constructors, destructors and assignment operators of 76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 77 # members of a class in the documentation of that class as if those members were 78 # ordinary class members. Constructors, destructors and assignment operators of 79 79 # the base classes will not be shown. 80 80 81 81 INLINE_INHERITED_MEMB = NO 82 82 83 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 84 # path before files name in the file list and in the header files. If set 83 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 84 # path before files name in the file list and in the header files. If set 85 85 # to NO the shortest path that makes the file name unique will be used. 86 86 87 87 FULL_PATH_NAMES = NO 88 88 89 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 90 # can be used to strip a user-defined part of the path. Stripping is 91 # only done if one of the specified strings matches the left-hand part of 89 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 90 # can be used to strip a user-defined part of the path. Stripping is 91 # only done if one of the specified strings matches the left-hand part of 92 92 # the path. It is allowed to use relative paths in the argument list. 93 93 94 STRIP_FROM_PATH = 95 96 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 97 # (but less readable) file names. This can be useful is your file systems 94 STRIP_FROM_PATH = 95 96 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 97 # (but less readable) file names. This can be useful is your file systems 98 98 # doesn't support long names like on DOS, Mac, or CD-ROM. 99 99 100 100 SHORT_NAMES = NO 101 101 102 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 103 # will interpret the first line (until the first dot) of a JavaDoc-style 104 # comment as the brief description. If set to NO, the JavaDoc 105 # comments will behave just like the Qt-style comments (thus requiring an 102 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 103 # will interpret the first line (until the first dot) of a JavaDoc-style 104 # comment as the brief description. If set to NO, the JavaDoc 105 # comments will behave just like the Qt-style comments (thus requiring an 106 106 # explict @brief command for a brief description. 107 107 108 108 JAVADOC_AUTOBRIEF = YES 109 109 110 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 111 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 112 # comments) as a brief description. This used to be the default behaviour. 113 # The new default is to treat a multi-line C++ comment block as a detailed 110 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 111 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 112 # comments) as a brief description. This used to be the default behaviour. 113 # The new default is to treat a multi-line C++ comment block as a detailed 114 114 # description. Set this tag to YES if you prefer the old behaviour instead. 115 115 116 116 MULTILINE_CPP_IS_BRIEF = NO 117 117 118 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 118 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 119 119 # will output the detailed description near the top, like JavaDoc. 120 # If set to NO, the detailed description appears after the member 120 # If set to NO, the detailed description appears after the member 121 121 # documentation. 122 122 123 123 DETAILS_AT_TOP = YES 124 124 125 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 126 # member inherits the documentation from any documented member that it 125 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 126 # member inherits the documentation from any documented member that it 127 127 # reimplements. 128 128 129 129 INHERIT_DOCS = YES 130 130 131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 132 # tag is set to YES, then doxygen will reuse the documentation of the first 133 # member in the group (if any) for the other members of the group. By default 131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 132 # tag is set to YES, then doxygen will reuse the documentation of the first 133 # member in the group (if any) for the other members of the group. By default 134 134 # all members of a group must be documented explicitly. 135 135 136 136 DISTRIBUTE_GROUP_DOC = NO 137 137 138 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 138 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 139 139 # Doxygen uses this value to replace tabs by spaces in code fragments. 140 140 141 141 TAB_SIZE = 4 142 142 143 # This tag can be used to specify a number of aliases that acts 144 # as commands in the documentation. An alias has the form "name=value". 145 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 143 # This tag can be used to specify a number of aliases that acts 144 # as commands in the documentation. An alias has the form "name=value". 145 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 146 146 # put the command \sideeffect (or @sideeffect) in the documentation, which 147 # will result in a user-defined paragraph with heading "Side Effects:". 147 # will result in a user-defined paragraph with heading "Side Effects:". 148 148 # You can put \n's in the value part of an alias to insert newlines. 149 149 150 150 ALIASES = 151 151 152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 153 # only. Doxygen will then generate output that is more tailored for C. 154 # For instance, some of the names that are used will be different. The list 152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 153 # only. Doxygen will then generate output that is more tailored for C. 154 # For instance, some of the names that are used will be different. The list 155 155 # of all members will be omitted, etc. 156 156 157 157 OPTIMIZE_OUTPUT_FOR_C = YES 158 158 159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 160 # only. Doxygen will then generate output that is more tailored for Java. 161 # For instance, namespaces will be presented as packages, qualified scopes 159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 160 # only. Doxygen will then generate output that is more tailored for Java. 161 # For instance, namespaces will be presented as packages, qualified scopes 162 162 # will look different, etc. 163 163 … … 165 165 166 166 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 167 # the same type (for instance a group of public functions) to be put as a 168 # subgroup of that type (e.g. under the Public Functions section). Set it to 169 # NO to prevent subgrouping. Alternatively, this can be done per class using 167 # the same type (for instance a group of public functions) to be put as a 168 # subgroup of that type (e.g. under the Public Functions section). Set it to 169 # NO to prevent subgrouping. Alternatively, this can be done per class using 170 170 # the \nosubgrouping command. 171 171 … … 176 176 #--------------------------------------------------------------------------- 177 177 178 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 179 # documentation are documented, even if no documentation was available. 180 # Private class members and static file members will be hidden unless 178 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 179 # documentation are documented, even if no documentation was available. 180 # Private class members and static file members will be hidden unless 181 181 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 182 182 183 183 EXTRACT_ALL = YES 184 184 185 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 185 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 186 186 # will be included in the documentation. 187 187 188 188 EXTRACT_PRIVATE = NO 189 189 190 # If the EXTRACT_STATIC tag is set to YES all static members of a file 190 # If the EXTRACT_STATIC tag is set to YES all static members of a file 191 191 # will be included in the documentation. 192 192 193 193 EXTRACT_STATIC = NO 194 194 195 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 196 # defined locally in source files will be included in the documentation. 195 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 196 # defined locally in source files will be included in the documentation. 197 197 # If set to NO only classes defined in header files are included. 198 198 199 199 EXTRACT_LOCAL_CLASSES = NO 200 200 201 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 202 # undocumented members of documented classes, files or namespaces. 203 # If set to NO (the default) these members will be included in the 204 # various overviews, but no documentation section is generated. 201 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 202 # undocumented members of documented classes, files or namespaces. 203 # If set to NO (the default) these members will be included in the 204 # various overviews, but no documentation section is generated. 205 205 # This option has no effect if EXTRACT_ALL is enabled. 206 206 207 207 HIDE_UNDOC_MEMBERS = NO 208 208 209 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 210 # undocumented classes that are normally visible in the class hierarchy. 211 # If set to NO (the default) these classes will be included in the various 209 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 210 # undocumented classes that are normally visible in the class hierarchy. 211 # If set to NO (the default) these classes will be included in the various 212 212 # overviews. This option has no effect if EXTRACT_ALL is enabled. 213 213 214 214 HIDE_UNDOC_CLASSES = NO 215 215 216 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 217 # friend (class|struct|union) declarations. 218 # If set to NO (the default) these declarations will be included in the 216 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 217 # friend (class|struct|union) declarations. 218 # If set to NO (the default) these declarations will be included in the 219 219 # documentation. 220 220 … … 230 230 # The INTERNAL_DOCS tag determines if documentation 231 231 # that is typed after a \internal command is included. If the tag is set 232 # to NO (the default) then the documentation will be excluded. 232 # to NO (the default) then the documentation will be excluded. 233 233 # Set it to YES to include the internal documentation. 234 234 … … 298 298 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 299 299 # the initial value of a variable or define consists of for it to appear in 300 # the documentation. If the initializer consists of more lines than specified 300 # the documentation. If the initializer consists of more lines than specified 301 301 # here it will be hidden. Use a value of 0 to hide initializers completely. 302 302 # The appearance of the initializer of individual variables and defines in the … … 322 322 323 323 # The WARNINGS tag can be used to turn on/off the warning messages that are 324 # generated by doxygen. Possible values are YES and NO. If left blank 324 # generated by doxygen. Possible values are YES and NO. If left blank 325 325 # NO is used. 326 326 … … 362 362 # with spaces. 363 363 364 INPUT = mainpage.dox \ 364 INPUT = pslib.h \ 365 mainpage.dox \ 365 366 sysUtils \ 366 367 dataManip \ … … 374 375 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc 375 376 376 FILE_PATTERNS = 377 FILE_PATTERNS = 377 378 378 379 # The RECURSIVE tag can be used to turn specify whether or not subdirectories … … 382 383 RECURSIVE = YES 383 384 384 # The EXCLUDE tag can be used to specify files and/or directories that should 385 # The EXCLUDE tag can be used to specify files and/or directories that should 385 386 # excluded from the INPUT source files. This way you can easily exclude a 386 387 # subdirectory from a directory tree whose root is specified with the INPUT tag.
Note:
See TracChangeset
for help on using the changeset viewer.
