|
1 # Doxyfile 1.5.3 |
|
2 |
|
3 #--------------------------------------------------------------------------- |
|
4 # Project related configuration options |
|
5 #--------------------------------------------------------------------------- |
|
6 |
|
7 #--------------------------------------------------------------------------- |
|
8 # Projects specific settings that need to be overriden in the specific project |
|
9 #--------------------------------------------------------------------------- |
|
10 # PROJECT_NAME = project |
|
11 # PROJECT_NUMBER = 1.0 |
|
12 # OUTPUT_DIRECTORY = doc |
|
13 #--------------------------------------------------------------------------- |
|
14 |
|
15 |
|
16 DOXYFILE_ENCODING = UTF-8 |
|
17 CREATE_SUBDIRS = NO |
|
18 OUTPUT_LANGUAGE = English |
|
19 BRIEF_MEMBER_DESC = YES |
|
20 REPEAT_BRIEF = YES |
|
21 ABBREVIATE_BRIEF = "The $name class" \ |
|
22 "The $name widget" \ |
|
23 "The $name file" \ |
|
24 is \ |
|
25 provides \ |
|
26 specifies \ |
|
27 contains \ |
|
28 represents \ |
|
29 a \ |
|
30 an \ |
|
31 the |
|
32 ALWAYS_DETAILED_SEC = NO |
|
33 INLINE_INHERITED_MEMB = NO |
|
34 FULL_PATH_NAMES = YES |
|
35 STRIP_FROM_PATH = |
|
36 STRIP_FROM_INC_PATH = |
|
37 SHORT_NAMES = NO |
|
38 JAVADOC_AUTOBRIEF = NO |
|
39 QT_AUTOBRIEF = NO |
|
40 MULTILINE_CPP_IS_BRIEF = NO |
|
41 DETAILS_AT_TOP = NO |
|
42 INHERIT_DOCS = YES |
|
43 SEPARATE_MEMBER_PAGES = NO |
|
44 TAB_SIZE = 4 |
|
45 ALIASES = |
|
46 OPTIMIZE_OUTPUT_FOR_C = NO |
|
47 OPTIMIZE_OUTPUT_JAVA = YES |
|
48 BUILTIN_STL_SUPPORT = NO |
|
49 CPP_CLI_SUPPORT = NO |
|
50 DISTRIBUTE_GROUP_DOC = NO |
|
51 SUBGROUPING = YES |
|
52 #--------------------------------------------------------------------------- |
|
53 # Build related configuration options |
|
54 #--------------------------------------------------------------------------- |
|
55 EXTRACT_ALL = YES |
|
56 EXTRACT_PRIVATE = NO |
|
57 EXTRACT_STATIC = NO |
|
58 EXTRACT_LOCAL_CLASSES = YES |
|
59 EXTRACT_LOCAL_METHODS = YES |
|
60 EXTRACT_ANON_NSPACES = NO |
|
61 HIDE_UNDOC_MEMBERS = YES |
|
62 HIDE_UNDOC_CLASSES = YES |
|
63 HIDE_FRIEND_COMPOUNDS = NO |
|
64 HIDE_IN_BODY_DOCS = NO |
|
65 INTERNAL_DOCS = NO |
|
66 CASE_SENSE_NAMES = NO |
|
67 HIDE_SCOPE_NAMES = NO |
|
68 SHOW_INCLUDE_FILES = YES |
|
69 INLINE_INFO = YES |
|
70 SORT_MEMBER_DOCS = YES |
|
71 SORT_BRIEF_DOCS = NO |
|
72 SORT_BY_SCOPE_NAME = NO |
|
73 GENERATE_TODOLIST = YES |
|
74 GENERATE_TESTLIST = YES |
|
75 GENERATE_BUGLIST = YES |
|
76 GENERATE_DEPRECATEDLIST= YES |
|
77 ENABLED_SECTIONS = |
|
78 MAX_INITIALIZER_LINES = 30 |
|
79 SHOW_USED_FILES = YES |
|
80 SHOW_DIRECTORIES = YES |
|
81 FILE_VERSION_FILTER = |
|
82 #--------------------------------------------------------------------------- |
|
83 # configuration options related to warning and progress messages |
|
84 #--------------------------------------------------------------------------- |
|
85 QUIET = NO |
|
86 WARNINGS = NO |
|
87 WARN_IF_UNDOCUMENTED = NO |
|
88 WARN_IF_DOC_ERROR = NO |
|
89 WARN_NO_PARAMDOC = NO |
|
90 WARN_FORMAT = "$file:$line: $text" |
|
91 WARN_LOGFILE = |
|
92 #--------------------------------------------------------------------------- |
|
93 # configuration options related to the input files |
|
94 #--------------------------------------------------------------------------- |
|
95 INPUT = . |
|
96 INPUT_ENCODING = UTF-8 |
|
97 FILE_PATTERNS = *.c \ |
|
98 *.cc \ |
|
99 *.cxx \ |
|
100 *.cpp \ |
|
101 *.c++ \ |
|
102 *.d \ |
|
103 *.java \ |
|
104 *.ii \ |
|
105 *.ixx \ |
|
106 *.ipp \ |
|
107 *.i++ \ |
|
108 *.inl \ |
|
109 *.h \ |
|
110 *.hh \ |
|
111 *.hxx \ |
|
112 *.hpp \ |
|
113 *.h++ \ |
|
114 *.idl \ |
|
115 *.odl \ |
|
116 *.cs \ |
|
117 *.php \ |
|
118 *.php3 \ |
|
119 *.inc \ |
|
120 *.m \ |
|
121 *.mm \ |
|
122 *.dox \ |
|
123 *.py |
|
124 RECURSIVE = YES |
|
125 EXCLUDE = |
|
126 EXCLUDE_SYMLINKS = NO |
|
127 EXCLUDE_PATTERNS = */preinstall/*,*/ConfigurationTool/*,*/.svn/* |
|
128 EXCLUDE_SYMBOLS = |
|
129 EXAMPLE_PATH = |
|
130 EXAMPLE_PATTERNS = * |
|
131 EXAMPLE_RECURSIVE = NO |
|
132 IMAGE_PATH = |
|
133 INPUT_FILTER = |
|
134 FILTER_PATTERNS = |
|
135 FILTER_SOURCE_FILES = NO |
|
136 #--------------------------------------------------------------------------- |
|
137 # configuration options related to source browsing |
|
138 #--------------------------------------------------------------------------- |
|
139 SOURCE_BROWSER = YES |
|
140 INLINE_SOURCES = NO |
|
141 STRIP_CODE_COMMENTS = YES |
|
142 REFERENCED_BY_RELATION = NO |
|
143 REFERENCES_RELATION = NO |
|
144 REFERENCES_LINK_SOURCE = YES |
|
145 USE_HTAGS = NO |
|
146 VERBATIM_HEADERS = NO |
|
147 #--------------------------------------------------------------------------- |
|
148 # configuration options related to the alphabetical class index |
|
149 #--------------------------------------------------------------------------- |
|
150 ALPHABETICAL_INDEX = NO |
|
151 COLS_IN_ALPHA_INDEX = 5 |
|
152 IGNORE_PREFIX = |
|
153 #--------------------------------------------------------------------------- |
|
154 # configuration options related to the HTML output |
|
155 #--------------------------------------------------------------------------- |
|
156 GENERATE_HTML = YES |
|
157 HTML_OUTPUT = html |
|
158 HTML_FILE_EXTENSION = .html |
|
159 HTML_HEADER = |
|
160 HTML_FOOTER = |
|
161 HTML_STYLESHEET = |
|
162 HTML_ALIGN_MEMBERS = YES |
|
163 GENERATE_HTMLHELP = NO |
|
164 HTML_DYNAMIC_SECTIONS = NO |
|
165 CHM_FILE = |
|
166 HHC_LOCATION = |
|
167 GENERATE_CHI = NO |
|
168 BINARY_TOC = NO |
|
169 TOC_EXPAND = NO |
|
170 DISABLE_INDEX = NO |
|
171 ENUM_VALUES_PER_LINE = 4 |
|
172 GENERATE_TREEVIEW = NO |
|
173 TREEVIEW_WIDTH = 250 |
|
174 #--------------------------------------------------------------------------- |
|
175 # configuration options related to the LaTeX output |
|
176 #--------------------------------------------------------------------------- |
|
177 GENERATE_LATEX = NO |
|
178 LATEX_OUTPUT = latex |
|
179 LATEX_CMD_NAME = latex |
|
180 MAKEINDEX_CMD_NAME = makeindex |
|
181 COMPACT_LATEX = NO |
|
182 PAPER_TYPE = a4wide |
|
183 EXTRA_PACKAGES = |
|
184 LATEX_HEADER = |
|
185 PDF_HYPERLINKS = NO |
|
186 USE_PDFLATEX = NO |
|
187 LATEX_BATCHMODE = NO |
|
188 LATEX_HIDE_INDICES = NO |
|
189 #--------------------------------------------------------------------------- |
|
190 # configuration options related to the RTF output |
|
191 #--------------------------------------------------------------------------- |
|
192 GENERATE_RTF = NO |
|
193 RTF_OUTPUT = rtf |
|
194 COMPACT_RTF = NO |
|
195 RTF_HYPERLINKS = NO |
|
196 RTF_STYLESHEET_FILE = |
|
197 RTF_EXTENSIONS_FILE = |
|
198 #--------------------------------------------------------------------------- |
|
199 # configuration options related to the man page output |
|
200 #--------------------------------------------------------------------------- |
|
201 GENERATE_MAN = NO |
|
202 MAN_OUTPUT = man |
|
203 MAN_EXTENSION = .3 |
|
204 MAN_LINKS = NO |
|
205 #--------------------------------------------------------------------------- |
|
206 # configuration options related to the XML output |
|
207 #--------------------------------------------------------------------------- |
|
208 GENERATE_XML = NO |
|
209 XML_OUTPUT = xml |
|
210 XML_SCHEMA = |
|
211 XML_DTD = |
|
212 XML_PROGRAMLISTING = YES |
|
213 #--------------------------------------------------------------------------- |
|
214 # configuration options for the AutoGen Definitions output |
|
215 #--------------------------------------------------------------------------- |
|
216 GENERATE_AUTOGEN_DEF = NO |
|
217 #--------------------------------------------------------------------------- |
|
218 # configuration options related to the Perl module output |
|
219 #--------------------------------------------------------------------------- |
|
220 GENERATE_PERLMOD = NO |
|
221 PERLMOD_LATEX = NO |
|
222 PERLMOD_PRETTY = YES |
|
223 PERLMOD_MAKEVAR_PREFIX = |
|
224 #--------------------------------------------------------------------------- |
|
225 # Configuration options related to the preprocessor |
|
226 #--------------------------------------------------------------------------- |
|
227 ENABLE_PREPROCESSING = YES |
|
228 MACRO_EXPANSION = NO |
|
229 EXPAND_ONLY_PREDEF = NO |
|
230 SEARCH_INCLUDES = YES |
|
231 INCLUDE_PATH = |
|
232 INCLUDE_FILE_PATTERNS = |
|
233 PREDEFINED = |
|
234 EXPAND_AS_DEFINED = |
|
235 SKIP_FUNCTION_MACROS = YES |
|
236 #--------------------------------------------------------------------------- |
|
237 # Configuration::additions related to external references |
|
238 #--------------------------------------------------------------------------- |
|
239 TAGFILES = |
|
240 GENERATE_TAGFILE = |
|
241 ALLEXTERNALS = NO |
|
242 EXTERNAL_GROUPS = YES |
|
243 PERL_PATH = /usr/bin/perl |
|
244 #--------------------------------------------------------------------------- |
|
245 # Configuration options related to the dot tool |
|
246 #--------------------------------------------------------------------------- |
|
247 CLASS_DIAGRAMS = NO |
|
248 MSCGEN_PATH = |
|
249 HIDE_UNDOC_RELATIONS = YES |
|
250 HAVE_DOT = YES |
|
251 CLASS_GRAPH = YES |
|
252 COLLABORATION_GRAPH = YES |
|
253 GROUP_GRAPHS = YES |
|
254 UML_LOOK = NO |
|
255 TEMPLATE_RELATIONS = NO |
|
256 INCLUDE_GRAPH = YES |
|
257 INCLUDED_BY_GRAPH = YES |
|
258 CALL_GRAPH = NO |
|
259 CALLER_GRAPH = NO |
|
260 GRAPHICAL_HIERARCHY = YES |
|
261 DIRECTORY_GRAPH = YES |
|
262 DOT_IMAGE_FORMAT = png |
|
263 DOT_PATH = |
|
264 DOTFILE_DIRS = |
|
265 DOT_GRAPH_MAX_NODES = 50 |
|
266 MAX_DOT_GRAPH_DEPTH = 1000 |
|
267 DOT_TRANSPARENT = NO |
|
268 DOT_MULTI_TARGETS = NO |
|
269 GENERATE_LEGEND = YES |
|
270 DOT_CLEANUP = YES |
|
271 #--------------------------------------------------------------------------- |
|
272 # Configuration::additions related to the search engine |
|
273 #--------------------------------------------------------------------------- |
|
274 SEARCHENGINE = NO |