author | Tom Henderson <tomh@tomh.org> |
Fri, 20 Aug 2010 12:17:19 -0700 | |
changeset 6589 | 9c325569fb01 |
parent 6008 | aa1c297a0de2 |
permissions | -rw-r--r-- |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1 |
# Doxyfile 1.6.1 |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
2 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
3 |
# This file describes the settings to be used by the documentation system |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
4 |
# doxygen (www.doxygen.org) for a project |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
5 |
# |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
6 |
# All text after a hash (#) is considered a comment and will be ignored |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
7 |
# The format is: |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
8 |
# TAG = value [value, ...] |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
9 |
# For lists items can also be appended using: |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
10 |
# TAG += value [value, ...] |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
11 |
# Values that contain spaces should be placed between quotes (" ") |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
12 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
13 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
14 |
# Project related configuration options |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
15 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
16 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
17 |
# This tag specifies the encoding used for all characters in the config file |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
18 |
# that follow. The default is UTF-8 which is also the encoding used for all |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
19 |
# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
20 |
# iconv built into libc) for the transcoding. See |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
21 |
# http://www.gnu.org/software/libiconv for the list of possible encodings. |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
22 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
23 |
DOXYFILE_ENCODING = UTF-8 |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
24 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
25 |
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
26 |
# by quotes) that should identify the project. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
27 |
|
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
28 |
PROJECT_NAME = "NS-3 " |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
29 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
30 |
# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
31 |
# This could be handy for archiving the generated documentation or |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
32 |
# if some version control system is used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
33 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
34 |
PROJECT_NUMBER = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
35 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
36 |
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
37 |
# base path where the generated documentation will be put. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
38 |
# If a relative path is entered, it will be relative to the location |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
39 |
# where doxygen was started. If left blank the current directory will be used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
40 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
41 |
OUTPUT_DIRECTORY = doc |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
42 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
43 |
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
44 |
# 4096 sub-directories (in 2 levels) under the output directory of each output |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
45 |
# format and will distribute the generated files over these directories. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
46 |
# Enabling this option can be useful when feeding doxygen a huge amount of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
47 |
# source files, where putting all generated files in the same directory would |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
48 |
# otherwise cause performance problems for the file system. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
49 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
50 |
CREATE_SUBDIRS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
51 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
52 |
# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
53 |
# documentation generated by doxygen is written. Doxygen will use this |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
54 |
# information to generate all constant output in the proper language. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
55 |
# The default language is English, other supported languages are: |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
56 |
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
57 |
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
58 |
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
59 |
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
60 |
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
61 |
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
62 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
63 |
OUTPUT_LANGUAGE = English |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
64 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
65 |
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
66 |
# include brief member descriptions after the members that are listed in |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
67 |
# the file and class documentation (similar to JavaDoc). |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
68 |
# Set to NO to disable this. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
69 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
70 |
BRIEF_MEMBER_DESC = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
71 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
72 |
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
73 |
# the brief description of a member or function before the detailed description. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
74 |
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
75 |
# brief descriptions will be completely suppressed. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
76 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
77 |
REPEAT_BRIEF = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
78 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
79 |
# This tag implements a quasi-intelligent brief description abbreviator |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
80 |
# that is used to form the text in various listings. Each string |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
81 |
# in this list, if found as the leading text of the brief description, will be |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
82 |
# stripped from the text and the result after processing the whole list, is |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
83 |
# used as the annotated text. Otherwise, the brief description is used as-is. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
84 |
# If left blank, the following values are used ("$name" is automatically |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
85 |
# replaced with the name of the entity): "The $name class" "The $name widget" |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
86 |
# "The $name file" "is" "provides" "specifies" "contains" |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
87 |
# "represents" "a" "an" "the" |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
88 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
89 |
ABBREVIATE_BRIEF = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
90 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
91 |
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
92 |
# Doxygen will generate a detailed section even if there is only a brief |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
93 |
# description. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
94 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
95 |
ALWAYS_DETAILED_SEC = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
96 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
97 |
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
98 |
# inherited members of a class in the documentation of that class as if those |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
99 |
# members were ordinary class members. Constructors, destructors and assignment |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
100 |
# operators of the base classes will not be shown. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
101 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
102 |
INLINE_INHERITED_MEMB = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
103 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
104 |
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
105 |
# path before files name in the file list and in the header files. If set |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
106 |
# to NO the shortest path that makes the file name unique will be used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
107 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
108 |
FULL_PATH_NAMES = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
109 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
110 |
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
111 |
# can be used to strip a user-defined part of the path. Stripping is |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
112 |
# only done if one of the specified strings matches the left-hand part of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
113 |
# the path. The tag can be used to show relative paths in the file list. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
114 |
# If left blank the directory from which doxygen is run is used as the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
115 |
# path to strip. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
116 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
117 |
STRIP_FROM_PATH = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
118 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
119 |
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
120 |
# the path mentioned in the documentation of a class, which tells |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
121 |
# the reader which header file to include in order to use a class. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
122 |
# If left blank only the name of the header file containing the class |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
123 |
# definition is used. Otherwise one should specify the include paths that |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
124 |
# are normally passed to the compiler using the -I flag. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
125 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
126 |
STRIP_FROM_INC_PATH = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
127 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
128 |
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
129 |
# (but less readable) file names. This can be useful is your file systems |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
130 |
# doesn't support long names like on DOS, Mac, or CD-ROM. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
131 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
132 |
SHORT_NAMES = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
133 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
134 |
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
135 |
# will interpret the first line (until the first dot) of a JavaDoc-style |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
136 |
# comment as the brief description. If set to NO, the JavaDoc |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
137 |
# comments will behave just like regular Qt-style comments |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
138 |
# (thus requiring an explicit @brief command for a brief description.) |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
139 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
140 |
JAVADOC_AUTOBRIEF = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
141 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
142 |
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
143 |
# interpret the first line (until the first dot) of a Qt-style |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
144 |
# comment as the brief description. If set to NO, the comments |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
145 |
# will behave just like regular Qt-style comments (thus requiring |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
146 |
# an explicit \brief command for a brief description.) |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
147 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
148 |
QT_AUTOBRIEF = NO |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
149 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
150 |
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
151 |
# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
152 |
# comments) as a brief description. This used to be the default behaviour. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
153 |
# The new default is to treat a multi-line C++ comment block as a detailed |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
154 |
# description. Set this tag to YES if you prefer the old behaviour instead. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
155 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
156 |
MULTILINE_CPP_IS_BRIEF = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
157 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
158 |
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
159 |
# member inherits the documentation from any documented member that it |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
160 |
# re-implements. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
161 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
162 |
INHERIT_DOCS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
163 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
164 |
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
165 |
# a new page for each member. If set to NO, the documentation of a member will |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
166 |
# be part of the file/class/namespace that contains it. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
167 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
168 |
SEPARATE_MEMBER_PAGES = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
169 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
170 |
# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
171 |
# Doxygen uses this value to replace tabs by spaces in code fragments. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
172 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
173 |
TAB_SIZE = 4 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
174 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
175 |
# This tag can be used to specify a number of aliases that acts |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
176 |
# as commands in the documentation. An alias has the form "name=value". |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
177 |
# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
178 |
# put the command \sideeffect (or @sideeffect) in the documentation, which |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
179 |
# will result in a user-defined paragraph with heading "Side Effects:". |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
180 |
# You can put \n's in the value part of an alias to insert newlines. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
181 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
182 |
ALIASES = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
183 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
184 |
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
185 |
# sources only. Doxygen will then generate output that is more tailored for C. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
186 |
# For instance, some of the names that are used will be different. The list |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
187 |
# of all members will be omitted, etc. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
188 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
189 |
OPTIMIZE_OUTPUT_FOR_C = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
190 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
191 |
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
192 |
# sources only. Doxygen will then generate output that is more tailored for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
193 |
# Java. For instance, namespaces will be presented as packages, qualified |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
194 |
# scopes will look different, etc. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
195 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
196 |
OPTIMIZE_OUTPUT_JAVA = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
197 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
198 |
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
199 |
# sources only. Doxygen will then generate output that is more tailored for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
200 |
# Fortran. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
201 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
202 |
OPTIMIZE_FOR_FORTRAN = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
203 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
204 |
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
205 |
# sources. Doxygen will then generate output that is tailored for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
206 |
# VHDL. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
207 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
208 |
OPTIMIZE_OUTPUT_VHDL = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
209 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
210 |
# Doxygen selects the parser to use depending on the extension of the files it parses. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
211 |
# With this tag you can assign which parser to use for a given extension. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
212 |
# Doxygen has a built-in mapping, but you can override or extend it using this tag. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
213 |
# The format is ext=language, where ext is a file extension, and language is one of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
214 |
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
215 |
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
216 |
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
217 |
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
218 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
219 |
EXTENSION_MAPPING = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
220 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
221 |
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
222 |
# to include (a tag file for) the STL sources as input, then you should |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
223 |
# set this tag to YES in order to let doxygen match functions declarations and |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
224 |
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
225 |
# func(std::string) {}). This also make the inheritance and collaboration |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
226 |
# diagrams that involve STL classes more complete and accurate. |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
227 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
228 |
BUILTIN_STL_SUPPORT = NO |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
229 |
|
5733
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
230 |
# If you use Microsoft's C++/CLI language, you should set this option to YES to |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
231 |
# enable parsing support. |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
232 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
233 |
CPP_CLI_SUPPORT = NO |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
234 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
235 |
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
236 |
# Doxygen will parse them like normal C++ but will assume all classes use public |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
237 |
# instead of private inheritance when no explicit protection keyword is present. |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
238 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
239 |
SIP_SUPPORT = NO |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
240 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
241 |
# For Microsoft's IDL there are propget and propput attributes to indicate getter |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
242 |
# and setter methods for a property. Setting this option to YES (the default) |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
243 |
# will make doxygen to replace the get and set methods by a property in the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
244 |
# documentation. This will only work if the methods are indeed getting or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
245 |
# setting a simple type. If this is not the case, or you want to show the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
246 |
# methods anyway, you should set this option to NO. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
247 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
248 |
IDL_PROPERTY_SUPPORT = YES |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
249 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
250 |
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
251 |
# tag is set to YES, then doxygen will reuse the documentation of the first |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
252 |
# member in the group (if any) for the other members of the group. By default |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
253 |
# all members of a group must be documented explicitly. |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
254 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
255 |
DISTRIBUTE_GROUP_DOC = NO |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
256 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
257 |
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
258 |
# the same type (for instance a group of public functions) to be put as a |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
259 |
# subgroup of that type (e.g. under the Public Functions section). Set it to |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
260 |
# NO to prevent subgrouping. Alternatively, this can be done per class using |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
261 |
# the \nosubgrouping command. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
262 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
263 |
SUBGROUPING = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
264 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
265 |
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
266 |
# is documented as struct, union, or enum with the name of the typedef. So |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
267 |
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
268 |
# with name TypeT. When disabled the typedef will appear as a member of a file, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
269 |
# namespace, or class. And the struct will be named TypeS. This can typically |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
270 |
# be useful for C code in case the coding convention dictates that all compound |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
271 |
# types are typedef'ed and only the typedef is referenced, never the tag name. |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
272 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
273 |
TYPEDEF_HIDES_STRUCT = NO |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
274 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
275 |
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
276 |
# determine which symbols to keep in memory and which to flush to disk. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
277 |
# When the cache is full, less often used symbols will be written to disk. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
278 |
# For small to medium size projects (<1000 input files) the default value is |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
279 |
# probably good enough. For larger projects a too small cache size can cause |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
280 |
# doxygen to be busy swapping symbols to and from disk most of the time |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
281 |
# causing a significant performance penality. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
282 |
# If the system has enough physical memory increasing the cache will improve the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
283 |
# performance by keeping more symbols in memory. Note that the value works on |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
284 |
# a logarithmic scale so increasing the size by one will rougly double the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
285 |
# memory usage. The cache size is given by this formula: |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
286 |
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
287 |
# corresponding to a cache size of 2^16 = 65536 symbols |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
288 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
289 |
SYMBOL_CACHE_SIZE = 0 |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
290 |
|
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
291 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
292 |
# Build related configuration options |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
293 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
294 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
295 |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
296 |
# documentation are documented, even if no documentation was available. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
297 |
# Private class members and static file members will be hidden unless |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
298 |
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
299 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
300 |
EXTRACT_ALL = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
301 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
302 |
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
303 |
# will be included in the documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
304 |
|
5874 | 305 |
EXTRACT_PRIVATE = NO |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
306 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
307 |
# If the EXTRACT_STATIC tag is set to YES all static members of a file |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
308 |
# will be included in the documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
309 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
310 |
EXTRACT_STATIC = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
311 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
312 |
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
313 |
# defined locally in source files will be included in the documentation. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
314 |
# If set to NO only classes defined in header files are included. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
315 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
316 |
EXTRACT_LOCAL_CLASSES = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
317 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
318 |
# This flag is only useful for Objective-C code. When set to YES local |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
319 |
# methods, which are defined in the implementation section but not in |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
320 |
# the interface are included in the documentation. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
321 |
# If set to NO (the default) only methods in the interface are included. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
322 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
323 |
EXTRACT_LOCAL_METHODS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
324 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
325 |
# If this flag is set to YES, the members of anonymous namespaces will be |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
326 |
# extracted and appear in the documentation as a namespace called |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
327 |
# 'anonymous_namespace{file}', where file will be replaced with the base |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
328 |
# name of the file that contains the anonymous namespace. By default |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
329 |
# anonymous namespace are hidden. |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
330 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
331 |
EXTRACT_ANON_NSPACES = NO |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
332 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
333 |
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
334 |
# undocumented members of documented classes, files or namespaces. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
335 |
# If set to NO (the default) these members will be included in the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
336 |
# various overviews, but no documentation section is generated. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
337 |
# This option has no effect if EXTRACT_ALL is enabled. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
338 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
339 |
HIDE_UNDOC_MEMBERS = NO |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
340 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
341 |
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
342 |
# undocumented classes that are normally visible in the class hierarchy. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
343 |
# If set to NO (the default) these classes will be included in the various |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
344 |
# overviews. This option has no effect if EXTRACT_ALL is enabled. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
345 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
346 |
HIDE_UNDOC_CLASSES = NO |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
347 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
348 |
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
349 |
# friend (class|struct|union) declarations. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
350 |
# If set to NO (the default) these declarations will be included in the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
351 |
# documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
352 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
353 |
HIDE_FRIEND_COMPOUNDS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
354 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
355 |
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
356 |
# documentation blocks found inside the body of a function. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
357 |
# If set to NO (the default) these blocks will be appended to the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
358 |
# function's detailed documentation block. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
359 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
360 |
HIDE_IN_BODY_DOCS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
361 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
362 |
# The INTERNAL_DOCS tag determines if documentation |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
363 |
# that is typed after a \internal command is included. If the tag is set |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
364 |
# to NO (the default) then the documentation will be excluded. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
365 |
# Set it to YES to include the internal documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
366 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
367 |
INTERNAL_DOCS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
368 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
369 |
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
370 |
# file names in lower-case letters. If set to YES upper-case letters are also |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
371 |
# allowed. This is useful if you have classes or files whose names only differ |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
372 |
# in case and if your file system supports case sensitive file names. Windows |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
373 |
# and Mac users are advised to set this option to NO. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
374 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
375 |
CASE_SENSE_NAMES = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
376 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
377 |
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
378 |
# will show members with their full class and namespace scopes in the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
379 |
# documentation. If set to YES the scope will be hidden. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
380 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
381 |
HIDE_SCOPE_NAMES = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
382 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
383 |
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
384 |
# will put a list of the files that are included by a file in the documentation |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
385 |
# of that file. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
386 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
387 |
SHOW_INCLUDE_FILES = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
388 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
389 |
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
390 |
# is inserted in the documentation for inline members. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
391 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
392 |
INLINE_INFO = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
393 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
394 |
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
395 |
# will sort the (detailed) documentation of file and class members |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
396 |
# alphabetically by member name. If set to NO the members will appear in |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
397 |
# declaration order. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
398 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
399 |
SORT_MEMBER_DOCS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
400 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
401 |
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
402 |
# brief documentation of file, namespace and class members alphabetically |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
403 |
# by member name. If set to NO (the default) the members will appear in |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
404 |
# declaration order. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
405 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
406 |
SORT_BRIEF_DOCS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
407 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
408 |
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
409 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
410 |
SORT_MEMBERS_CTORS_1ST = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
411 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
412 |
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
413 |
# hierarchy of group names into alphabetical order. If set to NO (the default) |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
414 |
# the group names will appear in their defined order. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
415 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
416 |
SORT_GROUP_NAMES = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
417 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
418 |
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
419 |
# sorted by fully-qualified names, including namespaces. If set to |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
420 |
# NO (the default), the class list will be sorted only by class name, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
421 |
# not including the namespace part. |
5733
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
422 |
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
423 |
# Note: This option applies only to the class list, not to the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
424 |
# alphabetical list. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
425 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
426 |
SORT_BY_SCOPE_NAME = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
427 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
428 |
# The GENERATE_TODOLIST tag can be used to enable (YES) or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
429 |
# disable (NO) the todo list. This list is created by putting \todo |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
430 |
# commands in the documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
431 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
432 |
GENERATE_TODOLIST = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
433 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
434 |
# The GENERATE_TESTLIST tag can be used to enable (YES) or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
435 |
# disable (NO) the test list. This list is created by putting \test |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
436 |
# commands in the documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
437 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
438 |
GENERATE_TESTLIST = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
439 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
440 |
# The GENERATE_BUGLIST tag can be used to enable (YES) or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
441 |
# disable (NO) the bug list. This list is created by putting \bug |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
442 |
# commands in the documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
443 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
444 |
GENERATE_BUGLIST = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
445 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
446 |
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
447 |
# disable (NO) the deprecated list. This list is created by putting |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
448 |
# \deprecated commands in the documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
449 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
450 |
GENERATE_DEPRECATEDLIST= YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
451 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
452 |
# The ENABLED_SECTIONS tag can be used to enable conditional |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
453 |
# documentation sections, marked by \if sectionname ... \endif. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
454 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
455 |
ENABLED_SECTIONS = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
456 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
457 |
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
458 |
# the initial value of a variable or define consists of for it to appear in |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
459 |
# the documentation. If the initializer consists of more lines than specified |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
460 |
# here it will be hidden. Use a value of 0 to hide initializers completely. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
461 |
# The appearance of the initializer of individual variables and defines in the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
462 |
# documentation can be controlled using \showinitializer or \hideinitializer |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
463 |
# command in the documentation regardless of this setting. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
464 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
465 |
MAX_INITIALIZER_LINES = 30 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
466 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
467 |
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
468 |
# at the bottom of the documentation of classes and structs. If set to YES the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
469 |
# list will mention the files that were used to generate the documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
470 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
471 |
SHOW_USED_FILES = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
472 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
473 |
# If the sources in your project are distributed over multiple directories |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
474 |
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
475 |
# in the documentation. The default is NO. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
476 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
477 |
SHOW_DIRECTORIES = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
478 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
479 |
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
480 |
# This will remove the Files entry from the Quick Index and from the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
481 |
# Folder Tree View (if specified). The default is YES. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
482 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
483 |
SHOW_FILES = YES |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
484 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
485 |
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
486 |
# Namespaces page. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
487 |
# This will remove the Namespaces entry from the Quick Index |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
488 |
# and from the Folder Tree View (if specified). The default is YES. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
489 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
490 |
SHOW_NAMESPACES = YES |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
491 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
492 |
# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
493 |
# doxygen should invoke to get the current version for each file (typically from |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
494 |
# the version control system). Doxygen will invoke the program by executing (via |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
495 |
# popen()) the command <command> <input-file>, where <command> is the value of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
496 |
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
497 |
# provided by doxygen. Whatever the program writes to standard output |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
498 |
# is used as the file version. See the manual for examples. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
499 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
500 |
FILE_VERSION_FILTER = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
501 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
502 |
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
503 |
# doxygen. The layout file controls the global structure of the generated output files |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
504 |
# in an output format independent way. The create the layout file that represents |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
505 |
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
506 |
# file name after the option, if omitted DoxygenLayout.xml will be used as the name |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
507 |
# of the layout file. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
508 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
509 |
LAYOUT_FILE = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
510 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
511 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
512 |
# configuration options related to warning and progress messages |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
513 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
514 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
515 |
# The QUIET tag can be used to turn on/off the messages that are generated |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
516 |
# by doxygen. Possible values are YES and NO. If left blank NO is used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
517 |
|
1540
fd4e69513199
Now run doxygen again before the build, but the doc/trace-source-list.h is generated during waf check; make doxygen less verbose, and give a warning when doc/trace-source-list.h is missing.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
1411
diff
changeset
|
518 |
QUIET = YES |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
519 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
520 |
# The WARNINGS tag can be used to turn on/off the warning messages that are |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
521 |
# generated by doxygen. Possible values are YES and NO. If left blank |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
522 |
# NO is used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
523 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
524 |
WARNINGS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
525 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
526 |
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
527 |
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
528 |
# automatically be disabled. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
529 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
530 |
WARN_IF_UNDOCUMENTED = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
531 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
532 |
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
533 |
# potential errors in the documentation, such as not documenting some |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
534 |
# parameters in a documented function, or documenting parameters that |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
535 |
# don't exist or using markup commands wrongly. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
536 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
537 |
WARN_IF_DOC_ERROR = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
538 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
539 |
# This WARN_NO_PARAMDOC option can be abled to get warnings for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
540 |
# functions that are documented, but have no documentation for their parameters |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
541 |
# or return value. If set to NO (the default) doxygen will only warn about |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
542 |
# wrong or incomplete parameter documentation, but not about the absence of |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
543 |
# documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
544 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
545 |
WARN_NO_PARAMDOC = YES |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
546 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
547 |
# The WARN_FORMAT tag determines the format of the warning messages that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
548 |
# doxygen can produce. The string should contain the $file, $line, and $text |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
549 |
# tags, which will be replaced by the file and line number from which the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
550 |
# warning originated and the warning text. Optionally the format may contain |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
551 |
# $version, which will be replaced by the version of the file (if it could |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
552 |
# be obtained via FILE_VERSION_FILTER) |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
553 |
|
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
554 |
WARN_FORMAT = "$file:$line: $text " |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
555 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
556 |
# The WARN_LOGFILE tag can be used to specify a file to which warning |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
557 |
# and error messages should be written. If left blank the output is written |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
558 |
# to stderr. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
559 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
560 |
WARN_LOGFILE = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
561 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
562 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
563 |
# configuration options related to the input files |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
564 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
565 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
566 |
# The INPUT tag can be used to specify the files and/or directories that contain |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
567 |
# documented source files. You may enter file names like "myfile.cpp" or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
568 |
# directories like "/usr/src/myproject". Separate the files or directories |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
569 |
# with spaces. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
570 |
|
2217 | 571 |
INPUT = doc/modules \ |
572 |
doc/main.h \ |
|
1855
ee15fef0cb62
print-trace-sources.cc -> print-introspected-doxygen.cc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1852
diff
changeset
|
573 |
doc/introspected-doxygen.h \ |
5945 | 574 |
utils \ |
2217 | 575 |
src |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
576 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
577 |
# This tag can be used to specify the character encoding of the source files |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
578 |
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
579 |
# also the default input encoding. Doxygen uses libiconv (or the iconv built |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
580 |
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
581 |
# the list of possible encodings. |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
582 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
583 |
INPUT_ENCODING = UTF-8 |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
584 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
585 |
# If the value of the INPUT tag contains directories, you can use the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
586 |
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
587 |
# and *.h) to filter out the source-files in the directories. If left |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
588 |
# blank the following patterns are tested: |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
589 |
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
590 |
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
591 |
|
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
592 |
FILE_PATTERNS = *.h \ |
4644
846d7a49f4b7
add file to avoid stupid warning.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
4063
diff
changeset
|
593 |
*.tcc \ |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
594 |
node-list.cc |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
595 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
596 |
# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
597 |
# should be searched for input files as well. Possible values are YES and NO. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
598 |
# If left blank NO is used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
599 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
600 |
RECURSIVE = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
601 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
602 |
# The EXCLUDE tag can be used to specify files and/or directories that should |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
603 |
# excluded from the INPUT source files. This way you can easily exclude a |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
604 |
# subdirectory from a directory tree whose root is specified with the INPUT tag. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
605 |
|
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
606 |
EXCLUDE = src/routing/olsr/olsr-state.h \ |
5874 | 607 |
src/routing/olsr/olsr-repositories.h \ |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
608 |
src/simulator/high-precision.h \ |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
609 |
src/simulator/high-precision-128.h \ |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
610 |
src/simulator/high-precision-double.h |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
611 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
612 |
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
613 |
# directories that are symbolic links (a Unix filesystem feature) are excluded |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
614 |
# from the input. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
615 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
616 |
EXCLUDE_SYMLINKS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
617 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
618 |
# If the value of the INPUT tag contains directories, you can use the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
619 |
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
620 |
# certain files from those directories. Note that the wildcards are matched |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
621 |
# against the file with absolute path, so to exclude all test directories |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
622 |
# for example use the pattern */test/* |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
623 |
|
5874 | 624 |
EXCLUDE_PATTERNS = */test/* |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
625 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
626 |
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
627 |
# (namespaces, classes, functions, etc.) that should be excluded from the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
628 |
# output. The symbol name can be a fully qualified name, a word, or if the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
629 |
# wildcard * is used, a substring. Examples: ANamespace, AClass, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
630 |
# AClass::ANamespace, ANamespace::*Test |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
631 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
632 |
EXCLUDE_SYMBOLS = |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
633 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
634 |
# The EXAMPLE_PATH tag can be used to specify one or more files or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
635 |
# directories that contain example code fragments that are included (see |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
636 |
# the \include command). |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
637 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
638 |
EXAMPLE_PATH = samples |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
639 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
640 |
# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
641 |
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
642 |
# and *.h) to filter out the source-files in the directories. If left |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
643 |
# blank all files are included. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
644 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
645 |
EXAMPLE_PATTERNS = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
646 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
647 |
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
648 |
# searched for input files to be used with the \include or \dontinclude |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
649 |
# commands irrespective of the value of the RECURSIVE tag. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
650 |
# Possible values are YES and NO. If left blank NO is used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
651 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
652 |
EXAMPLE_RECURSIVE = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
653 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
654 |
# The IMAGE_PATH tag can be used to specify one or more files or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
655 |
# directories that contain image that are included in the documentation (see |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
656 |
# the \image command). |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
657 |
|
1359
969f9671ee09
add image path
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1252
diff
changeset
|
658 |
IMAGE_PATH = doc |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
659 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
660 |
# The INPUT_FILTER tag can be used to specify a program that doxygen should |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
661 |
# invoke to filter for each input file. Doxygen will invoke the filter program |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
662 |
# by executing (via popen()) the command <filter> <input-file>, where <filter> |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
663 |
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
664 |
# input file. Doxygen will then use the output that the filter program writes |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
665 |
# to standard output. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
666 |
# If FILTER_PATTERNS is specified, this tag will be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
667 |
# ignored. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
668 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
669 |
INPUT_FILTER = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
670 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
671 |
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
672 |
# basis. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
673 |
# Doxygen will compare the file name with each pattern and apply the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
674 |
# filter if there is a match. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
675 |
# The filters are a list of the form: |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
676 |
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
677 |
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
678 |
# is applied to all files. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
679 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
680 |
FILTER_PATTERNS = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
681 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
682 |
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
683 |
# INPUT_FILTER) will be used to filter the input files when producing source |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
684 |
# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
685 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
686 |
FILTER_SOURCE_FILES = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
687 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
688 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
689 |
# configuration options related to source browsing |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
690 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
691 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
692 |
# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
693 |
# be generated. Documented entities will be cross-referenced with these sources. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
694 |
# Note: To get rid of all source code in the generated output, make sure also |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
695 |
# VERBATIM_HEADERS is set to NO. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
696 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
697 |
SOURCE_BROWSER = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
698 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
699 |
# Setting the INLINE_SOURCES tag to YES will include the body |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
700 |
# of functions and classes directly in the documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
701 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
702 |
INLINE_SOURCES = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
703 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
704 |
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
705 |
# doxygen to hide any special comment blocks from generated source code |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
706 |
# fragments. Normal C and C++ comments will always remain visible. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
707 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
708 |
STRIP_CODE_COMMENTS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
709 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
710 |
# If the REFERENCED_BY_RELATION tag is set to YES |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
711 |
# then for each documented function all documented |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
712 |
# functions referencing it will be listed. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
713 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
714 |
REFERENCED_BY_RELATION = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
715 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
716 |
# If the REFERENCES_RELATION tag is set to YES |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
717 |
# then for each documented function all documented entities |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
718 |
# called/used by that function will be listed. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
719 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
720 |
REFERENCES_RELATION = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
721 |
|
5733
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
722 |
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
723 |
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
724 |
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
725 |
# link to the source code. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
726 |
# Otherwise they will link to the documentation. |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
727 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
728 |
REFERENCES_LINK_SOURCE = YES |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
729 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
730 |
# If the USE_HTAGS tag is set to YES then the references to source code |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
731 |
# will point to the HTML generated by the htags(1) tool instead of doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
732 |
# built-in source browser. The htags tool is part of GNU's global source |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
733 |
# tagging system (see http://www.gnu.org/software/global/global.html). You |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
734 |
# will need version 4.8.6 or higher. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
735 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
736 |
USE_HTAGS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
737 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
738 |
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
739 |
# will generate a verbatim copy of the header file for each class for |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
740 |
# which an include is specified. Set to NO to disable this. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
741 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
742 |
VERBATIM_HEADERS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
743 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
744 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
745 |
# configuration options related to the alphabetical class index |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
746 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
747 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
748 |
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
749 |
# of all compounds will be generated. Enable this if the project |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
750 |
# contains a lot of classes, structs, unions or interfaces. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
751 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
752 |
ALPHABETICAL_INDEX = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
753 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
754 |
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
755 |
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
756 |
# in which this list will be split (can be a number in the range [1..20]) |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
757 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
758 |
COLS_IN_ALPHA_INDEX = 5 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
759 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
760 |
# In case all classes in a project start with a common prefix, all |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
761 |
# classes will be put under the same header in the alphabetical index. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
762 |
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
763 |
# should be ignored while generating the index headers. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
764 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
765 |
IGNORE_PREFIX = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
766 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
767 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
768 |
# configuration options related to the HTML output |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
769 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
770 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
771 |
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
772 |
# generate HTML output. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
773 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
774 |
GENERATE_HTML = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
775 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
776 |
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
777 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
778 |
# put in front of it. If left blank `html' will be used as the default path. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
779 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
780 |
HTML_OUTPUT = html |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
781 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
782 |
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
783 |
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
784 |
# doxygen will generate files with .html extension. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
785 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
786 |
HTML_FILE_EXTENSION = .html |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
787 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
788 |
# The HTML_HEADER tag can be used to specify a personal HTML header for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
789 |
# each generated HTML page. If it is left blank doxygen will generate a |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
790 |
# standard header. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
791 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
792 |
HTML_HEADER = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
793 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
794 |
# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
795 |
# each generated HTML page. If it is left blank doxygen will generate a |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
796 |
# standard footer. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
797 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
798 |
HTML_FOOTER = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
799 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
800 |
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
801 |
# style sheet that is used by each HTML page. It can be used to |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
802 |
# fine-tune the look of the HTML output. If the tag is left blank doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
803 |
# will generate a default style sheet. Note that doxygen will try to copy |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
804 |
# the style sheet file to the HTML output directory, so don't put your own |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
805 |
# stylesheet in the HTML output directory as well, or it will be erased! |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
806 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
807 |
HTML_STYLESHEET = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
808 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
809 |
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
810 |
# files or namespaces will be aligned in HTML using tables. If set to |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
811 |
# NO a bullet list will be used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
812 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
813 |
HTML_ALIGN_MEMBERS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
814 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
815 |
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
816 |
# documentation will contain sections that can be hidden and shown after the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
817 |
# page has loaded. For this to work a browser that supports |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
818 |
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
819 |
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
820 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
821 |
HTML_DYNAMIC_SECTIONS = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
822 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
823 |
# If the GENERATE_DOCSET tag is set to YES, additional index files |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
824 |
# will be generated that can be used as input for Apple's Xcode 3 |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
825 |
# integrated development environment, introduced with OSX 10.5 (Leopard). |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
826 |
# To create a documentation set, doxygen will generate a Makefile in the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
827 |
# HTML output directory. Running make will produce the docset in that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
828 |
# directory and running "make install" will install the docset in |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
829 |
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
830 |
# it at startup. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
831 |
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
832 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
833 |
GENERATE_DOCSET = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
834 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
835 |
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
836 |
# feed. A documentation feed provides an umbrella under which multiple |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
837 |
# documentation sets from a single provider (such as a company or product suite) |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
838 |
# can be grouped. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
839 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
840 |
DOCSET_FEEDNAME = "Doxygen generated docs" |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
841 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
842 |
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
843 |
# should uniquely identify the documentation set bundle. This should be a |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
844 |
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
845 |
# will append .docset to the name. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
846 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
847 |
DOCSET_BUNDLE_ID = org.doxygen.Project |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
848 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
849 |
# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
850 |
# will be generated that can be used as input for tools like the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
851 |
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
5733
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
852 |
# of the generated HTML documentation. |
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
853 |
|
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
854 |
GENERATE_HTMLHELP = NO |
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
855 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
856 |
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
857 |
# be used to specify the file name of the resulting .chm file. You |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
858 |
# can add a path in front of the file if the result should not be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
859 |
# written to the html output directory. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
860 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
861 |
CHM_FILE = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
862 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
863 |
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
864 |
# be used to specify the location (absolute path including file name) of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
865 |
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
866 |
# the HTML help compiler on the generated index.hhp. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
867 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
868 |
HHC_LOCATION = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
869 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
870 |
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
871 |
# controls if a separate .chi index file is generated (YES) or that |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
872 |
# it should be included in the master .chm file (NO). |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
873 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
874 |
GENERATE_CHI = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
875 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
876 |
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
877 |
# is used to encode HtmlHelp index (hhk), content (hhc) and project file |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
878 |
# content. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
879 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
880 |
CHM_INDEX_ENCODING = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
881 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
882 |
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
883 |
# controls whether a binary table of contents is generated (YES) or a |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
884 |
# normal table of contents (NO) in the .chm file. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
885 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
886 |
BINARY_TOC = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
887 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
888 |
# The TOC_EXPAND flag can be set to YES to add extra items for group members |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
889 |
# to the contents of the HTML help documentation and to the tree view. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
890 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
891 |
TOC_EXPAND = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
892 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
893 |
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
894 |
# are set, an additional index file will be generated that can be used as input for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
895 |
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
896 |
# HTML documentation. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
897 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
898 |
GENERATE_QHP = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
899 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
900 |
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
901 |
# be used to specify the file name of the resulting .qch file. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
902 |
# The path specified is relative to the HTML output folder. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
903 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
904 |
QCH_FILE = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
905 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
906 |
# The QHP_NAMESPACE tag specifies the namespace to use when generating |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
907 |
# Qt Help Project output. For more information please see |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
908 |
# http://doc.trolltech.com/qthelpproject.html#namespace |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
909 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
910 |
QHP_NAMESPACE = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
911 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
912 |
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
913 |
# Qt Help Project output. For more information please see |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
914 |
# http://doc.trolltech.com/qthelpproject.html#virtual-folders |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
915 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
916 |
QHP_VIRTUAL_FOLDER = doc |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
917 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
918 |
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
919 |
# For more information please see |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
920 |
# http://doc.trolltech.com/qthelpproject.html#custom-filters |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
921 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
922 |
QHP_CUST_FILTER_NAME = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
923 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
924 |
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
925 |
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
926 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
927 |
QHP_CUST_FILTER_ATTRS = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
928 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
929 |
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
930 |
# filter section matches. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
931 |
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
932 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
933 |
QHP_SECT_FILTER_ATTRS = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
934 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
935 |
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
936 |
# be used to specify the location of Qt's qhelpgenerator. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
937 |
# If non-empty doxygen will try to run qhelpgenerator on the generated |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
938 |
# .qhp file. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
939 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
940 |
QHG_LOCATION = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
941 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
942 |
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
943 |
# top of each HTML page. The value NO (the default) enables the index and |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
944 |
# the value YES disables it. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
945 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
946 |
DISABLE_INDEX = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
947 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
948 |
# This tag can be used to set the number of enum values (range [1..20]) |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
949 |
# that doxygen will group on one line in the generated HTML documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
950 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
951 |
ENUM_VALUES_PER_LINE = 4 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
952 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
953 |
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
954 |
# structure should be generated to display hierarchical information. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
955 |
# If the tag value is set to YES, a side panel will be generated |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
956 |
# containing a tree-like index structure (just like the one that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
957 |
# is generated for HTML Help). For this to work a browser that supports |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
958 |
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
959 |
# Windows users are probably better off using the HTML help feature. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
960 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
961 |
GENERATE_TREEVIEW = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
962 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
963 |
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
964 |
# and Class Hierarchy pages using a tree view instead of an ordered list. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
965 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
966 |
USE_INLINE_TREES = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
967 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
968 |
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
969 |
# used to set the initial width (in pixels) of the frame in which the tree |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
970 |
# is shown. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
971 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
972 |
TREEVIEW_WIDTH = 250 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
973 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
974 |
# Use this tag to change the font size of Latex formulas included |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
975 |
# as images in the HTML documentation. The default is 10. Note that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
976 |
# when you change the font size after a successful doxygen run you need |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
977 |
# to manually remove any form_*.png images from the HTML output directory |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
978 |
# to force them to be regenerated. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
979 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
980 |
FORMULA_FONTSIZE = 10 |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
981 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
982 |
# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
983 |
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
984 |
# there is already a search function so this one should typically |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
985 |
# be disabled. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
986 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
987 |
SEARCHENGINE = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
988 |
|
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
989 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
990 |
# configuration options related to the LaTeX output |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
991 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
992 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
993 |
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
994 |
# generate Latex output. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
995 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
996 |
GENERATE_LATEX = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
997 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
998 |
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
999 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1000 |
# put in front of it. If left blank `latex' will be used as the default path. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1001 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1002 |
LATEX_OUTPUT = latex |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1003 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1004 |
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1005 |
# invoked. If left blank `latex' will be used as the default command name. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1006 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1007 |
LATEX_CMD_NAME = latex |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1008 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1009 |
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1010 |
# generate index for LaTeX. If left blank `makeindex' will be used as the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1011 |
# default command name. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1012 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1013 |
MAKEINDEX_CMD_NAME = makeindex |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1014 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1015 |
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1016 |
# LaTeX documents. This may be useful for small projects and may help to |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1017 |
# save some trees in general. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1018 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1019 |
COMPACT_LATEX = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1020 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1021 |
# The PAPER_TYPE tag can be used to set the paper type that is used |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1022 |
# by the printer. Possible values are: a4, a4wide, letter, legal and |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1023 |
# executive. If left blank a4wide will be used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1024 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1025 |
PAPER_TYPE = a4wide |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1026 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1027 |
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1028 |
# packages that should be included in the LaTeX output. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1029 |
|
4063
803720fc9f31
add tex package for nakagami doc formula
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2969
diff
changeset
|
1030 |
EXTRA_PACKAGES = amsmath |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1031 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1032 |
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1033 |
# the generated latex document. The header should contain everything until |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1034 |
# the first chapter. If it is left blank doxygen will generate a |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1035 |
# standard header. Notice: only use this tag if you know what you are doing! |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1036 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1037 |
LATEX_HEADER = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1038 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1039 |
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1040 |
# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1041 |
# contain links (just like the HTML output) instead of page references |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1042 |
# This makes the output suitable for online browsing using a pdf viewer. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1043 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1044 |
PDF_HYPERLINKS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1045 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1046 |
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1047 |
# plain latex in the generated Makefile. Set this option to YES to get a |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1048 |
# higher quality PDF documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1049 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1050 |
USE_PDFLATEX = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1051 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1052 |
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1053 |
# command to the generated LaTeX files. This will instruct LaTeX to keep |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1054 |
# running if errors occur, instead of asking the user for help. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1055 |
# This option is also used when generating formulas in HTML. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1056 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1057 |
LATEX_BATCHMODE = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1058 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1059 |
# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1060 |
# include the index chapters (such as File Index, Compound Index, etc.) |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1061 |
# in the output. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1062 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1063 |
LATEX_HIDE_INDICES = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1064 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1065 |
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1066 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1067 |
LATEX_SOURCE_CODE = NO |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1068 |
|
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1069 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1070 |
# configuration options related to the RTF output |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1071 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1072 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1073 |
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1074 |
# The RTF output is optimized for Word 97 and may not look very pretty with |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1075 |
# other RTF readers or editors. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1076 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1077 |
GENERATE_RTF = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1078 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1079 |
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1080 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1081 |
# put in front of it. If left blank `rtf' will be used as the default path. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1082 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1083 |
RTF_OUTPUT = rtf |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1084 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1085 |
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1086 |
# RTF documents. This may be useful for small projects and may help to |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1087 |
# save some trees in general. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1088 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1089 |
COMPACT_RTF = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1090 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1091 |
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1092 |
# will contain hyperlink fields. The RTF file will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1093 |
# contain links (just like the HTML output) instead of page references. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1094 |
# This makes the output suitable for online browsing using WORD or other |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1095 |
# programs which support those fields. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1096 |
# Note: wordpad (write) and others do not support links. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1097 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1098 |
RTF_HYPERLINKS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1099 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1100 |
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1101 |
# config file, i.e. a series of assignments. You only have to provide |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1102 |
# replacements, missing definitions are set to their default value. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1103 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1104 |
RTF_STYLESHEET_FILE = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1105 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1106 |
# Set optional variables used in the generation of an rtf document. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1107 |
# Syntax is similar to doxygen's config file. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1108 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1109 |
RTF_EXTENSIONS_FILE = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1110 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1111 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1112 |
# configuration options related to the man page output |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1113 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1114 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1115 |
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1116 |
# generate man pages |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1117 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1118 |
GENERATE_MAN = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1119 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1120 |
# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1121 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1122 |
# put in front of it. If left blank `man' will be used as the default path. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1123 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1124 |
MAN_OUTPUT = man |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1125 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1126 |
# The MAN_EXTENSION tag determines the extension that is added to |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1127 |
# the generated man pages (default is the subroutine's section .3) |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1128 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1129 |
MAN_EXTENSION = .3 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1130 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1131 |
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1132 |
# then it will generate one additional man file for each entity |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1133 |
# documented in the real man page(s). These additional files |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1134 |
# only source the real man page, but without them the man command |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1135 |
# would be unable to find the correct page. The default is NO. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1136 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1137 |
MAN_LINKS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1138 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1139 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1140 |
# configuration options related to the XML output |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1141 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1142 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1143 |
# If the GENERATE_XML tag is set to YES Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1144 |
# generate an XML file that captures the structure of |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1145 |
# the code including all documentation. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1146 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1147 |
GENERATE_XML = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1148 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1149 |
# The XML_OUTPUT tag is used to specify where the XML pages will be put. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1150 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1151 |
# put in front of it. If left blank `xml' will be used as the default path. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1152 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1153 |
XML_OUTPUT = xml |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1154 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1155 |
# The XML_SCHEMA tag can be used to specify an XML schema, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1156 |
# which can be used by a validating XML parser to check the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1157 |
# syntax of the XML files. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1158 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1159 |
XML_SCHEMA = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1160 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1161 |
# The XML_DTD tag can be used to specify an XML DTD, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1162 |
# which can be used by a validating XML parser to check the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1163 |
# syntax of the XML files. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1164 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1165 |
XML_DTD = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1166 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1167 |
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1168 |
# dump the program listings (including syntax highlighting |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1169 |
# and cross-referencing information) to the XML output. Note that |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1170 |
# enabling this will significantly increase the size of the XML output. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1171 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1172 |
XML_PROGRAMLISTING = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1173 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1174 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1175 |
# configuration options for the AutoGen Definitions output |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1176 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1177 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1178 |
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1179 |
# generate an AutoGen Definitions (see autogen.sf.net) file |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1180 |
# that captures the structure of the code including all |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1181 |
# documentation. Note that this feature is still experimental |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1182 |
# and incomplete at the moment. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1183 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1184 |
GENERATE_AUTOGEN_DEF = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1185 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1186 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1187 |
# configuration options related to the Perl module output |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1188 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1189 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1190 |
# If the GENERATE_PERLMOD tag is set to YES Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1191 |
# generate a Perl module file that captures the structure of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1192 |
# the code including all documentation. Note that this |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1193 |
# feature is still experimental and incomplete at the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1194 |
# moment. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1195 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1196 |
GENERATE_PERLMOD = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1197 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1198 |
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1199 |
# the necessary Makefile rules, Perl scripts and LaTeX code to be able |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1200 |
# to generate PDF and DVI output from the Perl module output. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1201 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1202 |
PERLMOD_LATEX = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1203 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1204 |
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1205 |
# nicely formatted so it can be parsed by a human reader. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1206 |
# This is useful |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1207 |
# if you want to understand what is going on. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1208 |
# On the other hand, if this |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1209 |
# tag is set to NO the size of the Perl module output will be much smaller |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1210 |
# and Perl will parse it just the same. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1211 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1212 |
PERLMOD_PRETTY = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1213 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1214 |
# The names of the make variables in the generated doxyrules.make file |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1215 |
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1216 |
# This is useful so different doxyrules.make files included by the same |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1217 |
# Makefile don't overwrite each other's variables. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1218 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1219 |
PERLMOD_MAKEVAR_PREFIX = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1220 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1221 |
#--------------------------------------------------------------------------- |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1222 |
# Configuration options related to the preprocessor |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1223 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1224 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1225 |
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1226 |
# evaluate all C-preprocessor directives found in the sources and include |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1227 |
# files. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1228 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1229 |
ENABLE_PREPROCESSING = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1230 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1231 |
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1232 |
# names in the source code. If set to NO (the default) only conditional |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1233 |
# compilation will be performed. Macro expansion can be done in a controlled |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1234 |
# way by setting EXPAND_ONLY_PREDEF to YES. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1235 |
|
2969
9d05d2a95dfa
improve the auto-generated doxygen output.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2960
diff
changeset
|
1236 |
MACRO_EXPANSION = YES |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1237 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1238 |
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1239 |
# then the macro expansion is limited to the macros specified with the |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1240 |
# PREDEFINED and EXPAND_AS_DEFINED tags. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1241 |
|
2969
9d05d2a95dfa
improve the auto-generated doxygen output.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2960
diff
changeset
|
1242 |
EXPAND_ONLY_PREDEF = YES |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1243 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1244 |
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1245 |
# in the INCLUDE_PATH (see below) will be search if a #include is found. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1246 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1247 |
SEARCH_INCLUDES = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1248 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1249 |
# The INCLUDE_PATH tag can be used to specify one or more directories that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1250 |
# contain include files that are not input files but should be processed by |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1251 |
# the preprocessor. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1252 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1253 |
INCLUDE_PATH = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1254 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1255 |
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1256 |
# patterns (like *.h and *.hpp) to filter out the header-files in the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1257 |
# directories. If left blank, the patterns specified with FILE_PATTERNS will |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1258 |
# be used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1259 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1260 |
INCLUDE_FILE_PATTERNS = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1261 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1262 |
# The PREDEFINED tag can be used to specify one or more macro names that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1263 |
# are defined before the preprocessor is started (similar to the -D option of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1264 |
# gcc). The argument of the tag is a list of macros of the form: name |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1265 |
# or name=definition (no spaces). If the definition and the = are |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1266 |
# omitted =1 is assumed. To prevent a macro definition from being |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1267 |
# undefined via #undef or recursively expanded use the := operator |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1268 |
# instead of the = operator. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1269 |
|
6001
d563aaa88bc0
remove remaining mentions of RUN_SELF_TESTS
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
5945
diff
changeset
|
1270 |
PREDEFINED = NS3_ASSERT_ENABLE \ |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1271 |
NS3_LOG_ENABLE |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1272 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1273 |
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1274 |
# this tag can be used to specify a list of macro names that should be expanded. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1275 |
# The macro definition that is found in the sources will be used. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1276 |
# Use the PREDEFINED tag if you want to use a different macro definition. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1277 |
|
2969
9d05d2a95dfa
improve the auto-generated doxygen output.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2960
diff
changeset
|
1278 |
EXPAND_AS_DEFINED = ATTRIBUTE_VALUE_DEFINE \ |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1279 |
ATTRIBUTE_VALUE_DEFINE_WITH_NAME \ |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1280 |
ATTRIBUTE_HELPER_HEADER_2 |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1281 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1282 |
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1283 |
# doxygen's preprocessor will remove all function-like macros that are alone |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1284 |
# on a line, have an all uppercase name, and do not end with a semicolon. Such |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1285 |
# function macros are typically used for boiler-plate code, and will confuse |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1286 |
# the parser if not removed. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1287 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1288 |
SKIP_FUNCTION_MACROS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1289 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1290 |
#--------------------------------------------------------------------------- |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1291 |
# Configuration::additions related to external references |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1292 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1293 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1294 |
# The TAGFILES option can be used to specify one or more tagfiles. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1295 |
# Optionally an initial location of the external documentation |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1296 |
# can be added for each tagfile. The format of a tag file without |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1297 |
# this location is as follows: |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1298 |
# |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1299 |
# TAGFILES = file1 file2 ... |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1300 |
# Adding location for the tag files is done as follows: |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1301 |
# |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1302 |
# TAGFILES = file1=loc1 "file2 = loc2" ... |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1303 |
# where "loc1" and "loc2" can be relative or absolute paths or |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1304 |
# URLs. If a location is present for each tag, the installdox tool |
5733
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
1305 |
# does not have to be run to correct the links. |
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
1306 |
# Note that each tag file must have a unique name |
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
1307 |
# (where the name does NOT include the path) |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1308 |
# If a tag file is not located in the directory in which doxygen |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1309 |
# is run, you must also specify the path to the tagfile here. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1310 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1311 |
TAGFILES = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1312 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1313 |
# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1314 |
# a tag file that is based on the input files it reads. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1315 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1316 |
GENERATE_TAGFILE = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1317 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1318 |
# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1319 |
# in the class index. If set to NO only the inherited external classes |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1320 |
# will be listed. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1321 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1322 |
ALLEXTERNALS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1323 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1324 |
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1325 |
# in the modules index. If set to NO, only the current project's groups will |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1326 |
# be listed. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1327 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1328 |
EXTERNAL_GROUPS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1329 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1330 |
# The PERL_PATH should be the absolute path and name of the perl script |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1331 |
# interpreter (i.e. the result of `which perl'). |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1332 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1333 |
PERL_PATH = /usr/bin/perl |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1334 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1335 |
#--------------------------------------------------------------------------- |
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1336 |
# Configuration options related to the dot tool |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1337 |
#--------------------------------------------------------------------------- |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1338 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1339 |
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1340 |
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1341 |
# or super classes. Setting the tag to NO turns the diagrams off. Note that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1342 |
# this option is superseded by the HAVE_DOT option below. This is only a |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1343 |
# fallback. It is recommended to install and use dot, since it yields more |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1344 |
# powerful graphs. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1345 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1346 |
CLASS_DIAGRAMS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1347 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1348 |
# You can define message sequence charts within doxygen comments using the \msc |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1349 |
# command. Doxygen will then run the mscgen tool (see |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1350 |
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1351 |
# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1352 |
# the mscgen tool resides. If left empty the tool is assumed to be found in the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1353 |
# default search path. |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1354 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1355 |
MSCGEN_PATH = |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1356 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1357 |
# If set to YES, the inheritance and collaboration graphs will hide |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1358 |
# inheritance and usage relations if the target is undocumented |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1359 |
# or is not a class. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1360 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1361 |
HIDE_UNDOC_RELATIONS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1362 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1363 |
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1364 |
# available from the path. This tool is part of Graphviz, a graph visualization |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1365 |
# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1366 |
# have no effect if this option is set to NO (the default) |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1367 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1368 |
HAVE_DOT = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1369 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1370 |
# By default doxygen will write a font called FreeSans.ttf to the output |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1371 |
# directory and reference it in all dot files that doxygen generates. This |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1372 |
# font does not include all possible unicode characters however, so when you need |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1373 |
# these (or just want a differently looking font) you can specify the font name |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1374 |
# using DOT_FONTNAME. You need need to make sure dot is able to find the font, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1375 |
# which can be done by putting it in a standard location or by setting the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1376 |
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1377 |
# containing the font. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1378 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1379 |
DOT_FONTNAME = FreeSans |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1380 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1381 |
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1382 |
# The default size is 10pt. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1383 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1384 |
DOT_FONTSIZE = 10 |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1385 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1386 |
# By default doxygen will tell dot to use the output directory to look for the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1387 |
# FreeSans.ttf font (which doxygen will put there itself). If you specify a |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1388 |
# different font using DOT_FONTNAME you can set the path where dot |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1389 |
# can find it using this tag. |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1390 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1391 |
DOT_FONTPATH = |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1392 |
|
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1393 |
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1394 |
# will generate a graph for each documented class showing the direct and |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1395 |
# indirect inheritance relations. Setting this tag to YES will force the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1396 |
# the CLASS_DIAGRAMS tag to NO. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1397 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1398 |
CLASS_GRAPH = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1399 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1400 |
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1401 |
# will generate a graph for each documented class showing the direct and |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1402 |
# indirect implementation dependencies (inheritance, containment, and |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1403 |
# class references variables) of the class with other documented classes. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1404 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1405 |
COLLABORATION_GRAPH = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1406 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1407 |
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1408 |
# will generate a graph for groups, showing the direct groups dependencies |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1409 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1410 |
GROUP_GRAPHS = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1411 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1412 |
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1413 |
# collaboration diagrams in a style similar to the OMG's Unified Modeling |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1414 |
# Language. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1415 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1416 |
UML_LOOK = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1417 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1418 |
# If set to YES, the inheritance and collaboration graphs will show the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1419 |
# relations between templates and their instances. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1420 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1421 |
TEMPLATE_RELATIONS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1422 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1423 |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1424 |
# tags are set to YES then doxygen will generate a graph for each documented |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1425 |
# file showing the direct and indirect include dependencies of the file with |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1426 |
# other documented files. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1427 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1428 |
INCLUDE_GRAPH = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1429 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1430 |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1431 |
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1432 |
# documented header file showing the documented files that directly or |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1433 |
# indirectly include this file. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1434 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1435 |
INCLUDED_BY_GRAPH = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1436 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1437 |
# If the CALL_GRAPH and HAVE_DOT options are set to YES then |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1438 |
# doxygen will generate a call dependency graph for every global function |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1439 |
# or class method. Note that enabling this option will significantly increase |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1440 |
# the time of a run. So in most cases it will be better to enable call graphs |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1441 |
# for selected functions only using the \callgraph command. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1442 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1443 |
CALL_GRAPH = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1444 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1445 |
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1446 |
# doxygen will generate a caller dependency graph for every global function |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1447 |
# or class method. Note that enabling this option will significantly increase |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1448 |
# the time of a run. So in most cases it will be better to enable caller |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1449 |
# graphs for selected functions only using the \callergraph command. |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1450 |
|
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1451 |
CALLER_GRAPH = NO |
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1452 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1453 |
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1454 |
# will graphical hierarchy of all classes instead of a textual one. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1455 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1456 |
GRAPHICAL_HIERARCHY = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1457 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1458 |
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1459 |
# then doxygen will show the dependencies a directory has on other directories |
5733
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
1460 |
# in a graphical way. The dependency relations are determined by the #include |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1461 |
# relations between the files in the directories. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1462 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1463 |
DIRECTORY_GRAPH = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1464 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1465 |
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
5733
2cd393f8a407
[aodv] doxygen.conf reverted to ns-3-dev state
Pavel Boyko <boyko@iitp.ru>
parents:
5731
diff
changeset
|
1466 |
# generated by dot. Possible values are png, jpg, or gif |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1467 |
# If left blank png will be used. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1468 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1469 |
DOT_IMAGE_FORMAT = png |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1470 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1471 |
# The tag DOT_PATH can be used to specify the path where the dot tool can be |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1472 |
# found. If left blank, it is assumed the dot tool can be found in the path. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1473 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1474 |
DOT_PATH = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1475 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1476 |
# The DOTFILE_DIRS tag can be used to specify one or more directories that |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1477 |
# contain dot files that are included in the documentation (see the |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1478 |
# \dotfile command). |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1479 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1480 |
DOTFILE_DIRS = |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1481 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1482 |
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1483 |
# nodes that will be shown in the graph. If the number of nodes in a graph |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1484 |
# becomes larger than this value, doxygen will truncate the graph, which is |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1485 |
# visualized by representing a node as a red box. Note that doxygen if the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1486 |
# number of direct children of the root node in a graph is already larger than |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1487 |
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1488 |
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1489 |
|
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1490 |
DOT_GRAPH_MAX_NODES = 50 |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1491 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1492 |
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1493 |
# graphs generated by dot. A depth value of 3 means that only nodes reachable |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1494 |
# from the root by following a path via at most 3 edges will be shown. Nodes |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1495 |
# that lay further from the root node will be omitted. Note that setting this |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1496 |
# option to 1 or 2 may greatly reduce the computation time needed for large |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1497 |
# code bases. Also note that the size of a graph can be further restricted by |
1812
750fce457d29
update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents:
1804
diff
changeset
|
1498 |
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1499 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1500 |
MAX_DOT_GRAPH_DEPTH = 0 |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1501 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1502 |
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1503 |
# background. This is disabled by default, because dot on Windows does not |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1504 |
# seem to support this out of the box. Warning: Depending on the platform used, |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1505 |
# enabling this option may lead to badly anti-aliased labels on the edges of |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1506 |
# a graph (i.e. they become hard to read). |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1507 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1508 |
DOT_TRANSPARENT = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1509 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1510 |
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1511 |
# files in one run (i.e. multiple -o and -T options on the command line). This |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1512 |
# makes dot run faster, but since only newer versions of dot (>1.8.10) |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1513 |
# support this, this feature is disabled by default. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1514 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1515 |
DOT_MULTI_TARGETS = NO |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1516 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1517 |
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1518 |
# generate a legend page explaining the meaning of the various boxes and |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1519 |
# arrows in the dot generated graphs. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1520 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1521 |
GENERATE_LEGEND = YES |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1522 |
|
6008
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1523 |
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
aa1c297a0de2
Fix non-undocumented warnings in doxygen, also update doxygen.conf
Josh Pelkey <jpelkey@gatech.edu>
parents:
6001
diff
changeset
|
1524 |
# remove the intermediate dot files that are used to generate |
55
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1525 |
# the various graphs. |
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1526 |
|
b811c06c6317
add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1527 |
DOT_CLEANUP = YES |