Mercurial > pidgin.yaz
comparison Doxyfile.in @ 12800:532db13558c3
[gaim-migrate @ 15147]
sf patch #1400800, from Peter Lawler
"Updated Doxyfile.in"
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Tue, 10 Jan 2006 00:51:28 +0000 |
parents | be0f164eabc6 |
children | 8ec842950d92 |
comparison
equal
deleted
inserted
replaced
12799:6234099a4b37 | 12800:532db13558c3 |
---|---|
1 # Doxyfile 1.3.4 | 1 # Doxyfile 1.4.4 |
2 | 2 |
3 # This file describes the settings to be used by the documentation system | 3 # This file describes the settings to be used by the documentation system |
4 # doxygen (www.doxygen.org) for a project | 4 # doxygen (www.doxygen.org) for a project |
5 # | 5 # |
6 # All text after a hash (#) is considered a comment and will be ignored | 6 # All text after a hash (#) is considered a comment and will be ignored |
30 # If a relative path is entered, it will be relative to the location | 30 # If a relative path is entered, it will be relative to the location |
31 # where doxygen was started. If left blank the current directory will be used. | 31 # where doxygen was started. If left blank the current directory will be used. |
32 | 32 |
33 OUTPUT_DIRECTORY = doc | 33 OUTPUT_DIRECTORY = doc |
34 | 34 |
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | |
36 # 4096 sub-directories (in 2 levels) under the output directory of each output | |
37 # format and will distribute the generated files over these directories. | |
38 # Enabling this option can be useful when feeding doxygen a huge amount of | |
39 # source files, where putting all generated files in the same directory would | |
40 # otherwise cause performance problems for the file system. | |
41 | |
42 CREATE_SUBDIRS = NO | |
43 | |
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all | 44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
36 # documentation generated by doxygen is written. Doxygen will use this | 45 # documentation generated by doxygen is written. Doxygen will use this |
37 # information to generate all constant output in the proper language. | 46 # information to generate all constant output in the proper language. |
38 # The default language is English, other supported languages are: | 47 # The default language is English, other supported languages are: |
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, | 48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, |
133 # member in the group (if any) for the other members of the group. By default | 142 # member in the group (if any) for the other members of the group. By default |
134 # all members of a group must be documented explicitly. | 143 # all members of a group must be documented explicitly. |
135 | 144 |
136 DISTRIBUTE_GROUP_DOC = NO | 145 DISTRIBUTE_GROUP_DOC = NO |
137 | 146 |
147 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce | |
148 # a new page for each member. If set to NO, the documentation of a member will | |
149 # be part of the file/class/namespace that contains it. | |
150 | |
151 SEPARATE_MEMBER_PAGES = NO | |
152 | |
138 # The TAB_SIZE tag can be used to set the number of spaces in a tab. | 153 # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
139 # Doxygen uses this value to replace tabs by spaces in code fragments. | 154 # Doxygen uses this value to replace tabs by spaces in code fragments. |
140 | 155 |
141 TAB_SIZE = 4 | 156 TAB_SIZE = 4 |
142 | 157 |
203 # defined locally in source files will be included in the documentation. | 218 # defined locally in source files will be included in the documentation. |
204 # If set to NO only classes defined in header files are included. | 219 # If set to NO only classes defined in header files are included. |
205 | 220 |
206 EXTRACT_LOCAL_CLASSES = YES | 221 EXTRACT_LOCAL_CLASSES = YES |
207 | 222 |
223 # This flag is only useful for Objective-C code. When set to YES local | |
224 # methods, which are defined in the implementation section but not in | |
225 # the interface are included in the documentation. | |
226 # If set to NO (the default) only methods in the interface are included. | |
227 | |
228 EXTRACT_LOCAL_METHODS = YES | |
229 | |
208 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | 230 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
209 # undocumented members of documented classes, files or namespaces. | 231 # undocumented members of documented classes, files or namespaces. |
210 # If set to NO (the default) these members will be included in the | 232 # If set to NO (the default) these members will be included in the |
211 # various overviews, but no documentation section is generated. | 233 # various overviews, but no documentation section is generated. |
212 # This option has no effect if EXTRACT_ALL is enabled. | 234 # This option has no effect if EXTRACT_ALL is enabled. |
270 # will sort the (detailed) documentation of file and class members | 292 # will sort the (detailed) documentation of file and class members |
271 # alphabetically by member name. If set to NO the members will appear in | 293 # alphabetically by member name. If set to NO the members will appear in |
272 # declaration order. | 294 # declaration order. |
273 | 295 |
274 SORT_MEMBER_DOCS = YES | 296 SORT_MEMBER_DOCS = YES |
297 | |
298 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the | |
299 # brief documentation of file, namespace and class members alphabetically | |
300 # by member name. If set to NO (the default) the members will appear in | |
301 # declaration order. | |
302 | |
303 SORT_BRIEF_DOCS = YES | |
304 | |
305 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | |
306 # sorted by fully-qualified names, including namespaces. If set to | |
307 # NO (the default), the class list will be sorted only by class name, | |
308 # not including the namespace part. | |
309 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | |
310 # Note: This option applies only to the class list, not to the | |
311 # alphabetical list. | |
312 | |
313 SORT_BY_SCOPE_NAME = YES | |
275 | 314 |
276 # The GENERATE_TODOLIST tag can be used to enable (YES) or | 315 # The GENERATE_TODOLIST tag can be used to enable (YES) or |
277 # disable (NO) the todo list. This list is created by putting \todo | 316 # disable (NO) the todo list. This list is created by putting \todo |
278 # commands in the documentation. | 317 # commands in the documentation. |
279 | 318 |
316 # at the bottom of the documentation of classes and structs. If set to YES the | 355 # at the bottom of the documentation of classes and structs. If set to YES the |
317 # list will mention the files that were used to generate the documentation. | 356 # list will mention the files that were used to generate the documentation. |
318 | 357 |
319 SHOW_USED_FILES = YES | 358 SHOW_USED_FILES = YES |
320 | 359 |
360 # If the sources in your project are distributed over multiple directories | |
361 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy | |
362 # in the documentation. The default is YES. | |
363 | |
364 SHOW_DIRECTORIES = YES | |
365 | |
366 # The FILE_VERSION_FILTER tag can be used to specify a program or script that | |
367 # doxygen should invoke to get the current version for each file (typically from the | |
368 # version control system). Doxygen will invoke the program by executing (via | |
369 # popen()) the command <command> <input-file>, where <command> is the value of | |
370 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | |
371 # provided by doxygen. Whatever the progam writes to standard output | |
372 # is used as the file version. See the manual for examples. | |
373 | |
374 FILE_VERSION_FILTER = | |
375 | |
321 #--------------------------------------------------------------------------- | 376 #--------------------------------------------------------------------------- |
322 # configuration options related to warning and progress messages | 377 # configuration options related to warning and progress messages |
323 #--------------------------------------------------------------------------- | 378 #--------------------------------------------------------------------------- |
324 | 379 |
325 # The QUIET tag can be used to turn on/off the messages that are generated | 380 # The QUIET tag can be used to turn on/off the messages that are generated |
343 # potential errors in the documentation, such as not documenting some | 398 # potential errors in the documentation, such as not documenting some |
344 # parameters in a documented function, or documenting parameters that | 399 # parameters in a documented function, or documenting parameters that |
345 # don't exist or using markup commands wrongly. | 400 # don't exist or using markup commands wrongly. |
346 | 401 |
347 WARN_IF_DOC_ERROR = YES | 402 WARN_IF_DOC_ERROR = YES |
403 | |
404 # This WARN_NO_PARAMDOC option can be abled to get warnings for | |
405 # functions that are documented, but have no documentation for their parameters | |
406 # or return value. If set to NO (the default) doxygen will only warn about | |
407 # wrong or incomplete parameter documentation, but not about the absence of | |
408 # documentation. | |
409 | |
410 WARN_NO_PARAMDOC = YES | |
348 | 411 |
349 # The WARN_FORMAT tag determines the format of the warning messages that | 412 # The WARN_FORMAT tag determines the format of the warning messages that |
350 # doxygen can produce. The string should contain the $file, $line, and $text | 413 # doxygen can produce. The string should contain the $file, $line, and $text |
351 # tags, which will be replaced by the file and line number from which the | 414 # tags, which will be replaced by the file and line number from which the |
352 # warning originated and the warning text. | 415 # warning originated and the warning text. |
437 # input file. Doxygen will then use the output that the filter program writes | 500 # input file. Doxygen will then use the output that the filter program writes |
438 # to standard output. | 501 # to standard output. |
439 | 502 |
440 INPUT_FILTER = | 503 INPUT_FILTER = |
441 | 504 |
505 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | |
506 # basis. Doxygen will compare the file name with each pattern and apply the | |
507 # filter if there is a match. The filters are a list of the form: | |
508 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | |
509 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | |
510 # is applied to all files. | |
511 | |
512 FILTER_PATTERNS = | |
513 | |
442 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | 514 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
443 # INPUT_FILTER) will be used to filter the input files when producing source | 515 # INPUT_FILTER) will be used to filter the input files when producing source |
444 # files to browse (i.e. when SOURCE_BROWSER is set to YES). | 516 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
445 | 517 |
446 FILTER_SOURCE_FILES = NO | 518 FILTER_SOURCE_FILES = NO |
474 # If the REFERENCES_RELATION tag is set to YES (the default) | 546 # If the REFERENCES_RELATION tag is set to YES (the default) |
475 # then for each documented function all documented entities | 547 # then for each documented function all documented entities |
476 # called/used by that function will be listed. | 548 # called/used by that function will be listed. |
477 | 549 |
478 REFERENCES_RELATION = YES | 550 REFERENCES_RELATION = YES |
551 | |
552 # If the USE_HTAGS tag is set to YES then the references to source code | |
553 # will point to the HTML generated by the htags(1) tool instead of doxygen | |
554 # built-in source browser. The htags tool is part of GNU's global source | |
555 # tagging system (see http://www.gnu.org/software/global/global.html). You | |
556 # will need version 4.8.6 or higher. | |
557 | |
558 USE_HTAGS = NO | |
479 | 559 |
480 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | 560 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
481 # will generate a verbatim copy of the header file for each class for | 561 # will generate a verbatim copy of the header file for each class for |
482 # which an include is specified. Set to NO to disable this. | 562 # which an include is specified. Set to NO to disable this. |
483 | 563 |
557 # If the GENERATE_HTMLHELP tag is set to YES, additional index files | 637 # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
558 # will be generated that can be used as input for tools like the | 638 # will be generated that can be used as input for tools like the |
559 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | 639 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
560 # of the generated HTML documentation. | 640 # of the generated HTML documentation. |
561 | 641 |
562 GENERATE_HTMLHELP = NO | 642 GENERATE_HTMLHELP = YES |
563 | 643 |
564 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | 644 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
565 # be used to specify the file name of the resulting .chm file. You | 645 # be used to specify the file name of the resulting .chm file. You |
566 # can add a path in front of the file if the result should not be | 646 # can add a path in front of the file if the result should not be |
567 # written to the html output dir. | 647 # written to the html output dir. |
588 BINARY_TOC = NO | 668 BINARY_TOC = NO |
589 | 669 |
590 # The TOC_EXPAND flag can be set to YES to add extra items for group members | 670 # The TOC_EXPAND flag can be set to YES to add extra items for group members |
591 # to the contents of the HTML help documentation and to the tree view. | 671 # to the contents of the HTML help documentation and to the tree view. |
592 | 672 |
593 TOC_EXPAND = NO | 673 TOC_EXPAND = YES |
594 | 674 |
595 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | 675 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
596 # top of each HTML page. The value NO (the default) enables the index and | 676 # top of each HTML page. The value NO (the default) enables the index and |
597 # the value YES disables it. | 677 # the value YES disables it. |
598 | 678 |
608 # is generated for HTML Help). For this to work a browser that supports | 688 # is generated for HTML Help). For this to work a browser that supports |
609 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, | 689 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
610 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are | 690 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
611 # probably better off using the HTML help feature. | 691 # probably better off using the HTML help feature. |
612 | 692 |
613 GENERATE_TREEVIEW = NO | 693 GENERATE_TREEVIEW = YES |
614 | 694 |
615 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | 695 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
616 # used to set the initial width (in pixels) of the frame in which the tree | 696 # used to set the initial width (in pixels) of the frame in which the tree |
617 # is shown. | 697 # is shown. |
618 | 698 |
983 # indirect implementation dependencies (inheritance, containment, and | 1063 # indirect implementation dependencies (inheritance, containment, and |
984 # class references variables) of the class with other documented classes. | 1064 # class references variables) of the class with other documented classes. |
985 | 1065 |
986 COLLABORATION_GRAPH = YES | 1066 COLLABORATION_GRAPH = YES |
987 | 1067 |
1068 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen | |
1069 # will generate a graph for groups, showing the direct groups dependencies | |
1070 | |
1071 GROUP_GRAPHS = YES | |
1072 | |
988 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | 1073 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
989 # collaboration diagrams in a style similiar to the OMG's Unified Modeling | 1074 # collaboration diagrams in a style similiar to the OMG's Unified Modeling |
990 # Language. | 1075 # Language. |
991 | 1076 |
992 UML_LOOK = NO | 1077 UML_LOOK = YES |
993 | 1078 |
994 # If set to YES, the inheritance and collaboration graphs will show the | 1079 # If set to YES, the inheritance and collaboration graphs will show the |
995 # relations between templates and their instances. | 1080 # relations between templates and their instances. |
996 | 1081 |
997 TEMPLATE_RELATIONS = YES | 1082 TEMPLATE_RELATIONS = YES |
1014 # generate a call dependency graph for every global function or class method. | 1099 # generate a call dependency graph for every global function or class method. |
1015 # Note that enabling this option will significantly increase the time of a run. | 1100 # Note that enabling this option will significantly increase the time of a run. |
1016 # So in most cases it will be better to enable call graphs for selected | 1101 # So in most cases it will be better to enable call graphs for selected |
1017 # functions only using the \callgraph command. | 1102 # functions only using the \callgraph command. |
1018 | 1103 |
1019 CALL_GRAPH = NO | 1104 CALL_GRAPH = YES |
1020 | 1105 |
1021 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | 1106 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1022 # will graphical hierarchy of all classes instead of a textual one. | 1107 # will graphical hierarchy of all classes instead of a textual one. |
1023 | 1108 |
1024 GRAPHICAL_HIERARCHY = YES | 1109 GRAPHICAL_HIERARCHY = YES |
1110 | |
1111 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES | |
1112 # then doxygen will show the dependencies a directory has on other directories | |
1113 # in a graphical way. The dependency relations are determined by the #include | |
1114 # relations between the files in the directories. | |
1115 | |
1116 DIRECTORY_GRAPH = YES | |
1025 | 1117 |
1026 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | 1118 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
1027 # generated by dot. Possible values are png, jpg, or gif | 1119 # generated by dot. Possible values are png, jpg, or gif |
1028 # If left blank png will be used. | 1120 # If left blank png will be used. |
1029 | 1121 |
1065 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). | 1157 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). |
1066 # If 0 is used for the depth value (the default), the graph is not depth-constrained. | 1158 # If 0 is used for the depth value (the default), the graph is not depth-constrained. |
1067 | 1159 |
1068 MAX_DOT_GRAPH_DEPTH = 0 | 1160 MAX_DOT_GRAPH_DEPTH = 0 |
1069 | 1161 |
1162 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | |
1163 # background. This is disabled by default, which results in a white background. | |
1164 # Warning: Depending on the platform used, enabling this option may lead to | |
1165 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to | |
1166 # read). | |
1167 | |
1168 DOT_TRANSPARENT = NO | |
1169 | |
1170 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | |
1171 # files in one run (i.e. multiple -o and -T options on the command line). This | |
1172 # makes dot run faster, but since only newer versions of dot (>1.8.10) | |
1173 # support this, this feature is disabled by default. | |
1174 | |
1175 DOT_MULTI_TARGETS = YES | |
1176 | |
1070 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | 1177 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
1071 # generate a legend page explaining the meaning of the various boxes and | 1178 # generate a legend page explaining the meaning of the various boxes and |
1072 # arrows in the dot generated graphs. | 1179 # arrows in the dot generated graphs. |
1073 | 1180 |
1074 GENERATE_LEGEND = YES | 1181 GENERATE_LEGEND = YES |
1084 #--------------------------------------------------------------------------- | 1191 #--------------------------------------------------------------------------- |
1085 | 1192 |
1086 # The SEARCHENGINE tag specifies whether or not a search engine should be | 1193 # The SEARCHENGINE tag specifies whether or not a search engine should be |
1087 # used. If set to NO the values of all tags below this one will be ignored. | 1194 # used. If set to NO the values of all tags below this one will be ignored. |
1088 | 1195 |
1089 SEARCHENGINE = NO | 1196 SEARCHENGINE = YES |