Better doc.
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
10 OUTPUT_LANGUAGE = English
11 USE_WINDOWS_ENCODING = NO
12 BRIEF_MEMBER_DESC = YES
14 ABBREVIATE_BRIEF = "The $name class" \
25 ALWAYS_DETAILED_SEC = NO
26 INLINE_INHERITED_MEMB = NO
31 JAVADOC_AUTOBRIEF = NO
32 MULTILINE_CPP_IS_BRIEF = NO
35 SEPARATE_MEMBER_PAGES = NO
38 OPTIMIZE_OUTPUT_FOR_C = NO
39 OPTIMIZE_OUTPUT_JAVA = NO
40 BUILTIN_STL_SUPPORT = NO
41 DISTRIBUTE_GROUP_DOC = NO
43 #---------------------------------------------------------------------------
44 # Build related configuration options
45 #---------------------------------------------------------------------------
49 EXTRACT_LOCAL_CLASSES = YES
50 EXTRACT_LOCAL_METHODS = NO
51 HIDE_UNDOC_MEMBERS = NO
52 HIDE_UNDOC_CLASSES = NO
53 HIDE_FRIEND_COMPOUNDS = NO
54 HIDE_IN_BODY_DOCS = NO
56 CASE_SENSE_NAMES = YES
58 SHOW_INCLUDE_FILES = YES
60 SORT_MEMBER_DOCS = YES
62 SORT_BY_SCOPE_NAME = NO
63 GENERATE_TODOLIST = YES
64 GENERATE_TESTLIST = YES
65 GENERATE_BUGLIST = YES
66 GENERATE_DEPRECATEDLIST= YES
68 MAX_INITIALIZER_LINES = 30
70 SHOW_DIRECTORIES = YES
72 #---------------------------------------------------------------------------
73 # configuration options related to warning and progress messages
74 #---------------------------------------------------------------------------
77 WARN_IF_UNDOCUMENTED = YES
78 WARN_IF_DOC_ERROR = YES
80 WARN_FORMAT = "$file:$line: $text"
82 #---------------------------------------------------------------------------
83 # configuration options related to the input files
84 #---------------------------------------------------------------------------
129 EXCLUDE_SYMLINKS = NO
133 EXAMPLE_RECURSIVE = NO
137 FILTER_SOURCE_FILES = NO
138 #---------------------------------------------------------------------------
139 # configuration options related to source browsing
140 #---------------------------------------------------------------------------
143 STRIP_CODE_COMMENTS = YES
144 REFERENCED_BY_RELATION = YES
145 REFERENCES_RELATION = YES
147 VERBATIM_HEADERS = YES
148 #---------------------------------------------------------------------------
149 # configuration options related to the alphabetical class index
150 #---------------------------------------------------------------------------
151 ALPHABETICAL_INDEX = NO
152 COLS_IN_ALPHA_INDEX = 5
154 #---------------------------------------------------------------------------
155 # configuration options related to the HTML output
156 #---------------------------------------------------------------------------
159 HTML_FILE_EXTENSION = .html
163 HTML_ALIGN_MEMBERS = YES
164 GENERATE_HTMLHELP = NO
171 ENUM_VALUES_PER_LINE = 4
172 GENERATE_TREEVIEW = NO
174 #---------------------------------------------------------------------------
175 # configuration options related to the LaTeX output
176 #---------------------------------------------------------------------------
179 LATEX_CMD_NAME = latex
180 MAKEINDEX_CMD_NAME = makeindex
188 LATEX_HIDE_INDICES = NO
189 #---------------------------------------------------------------------------
190 # configuration options related to the RTF output
191 #---------------------------------------------------------------------------
196 RTF_STYLESHEET_FILE =
197 RTF_EXTENSIONS_FILE =
198 #---------------------------------------------------------------------------
199 # configuration options related to the man page output
200 #---------------------------------------------------------------------------
205 #---------------------------------------------------------------------------
206 # configuration options related to the XML output
207 #---------------------------------------------------------------------------
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
223 PERLMOD_MAKEVAR_PREFIX =
224 #---------------------------------------------------------------------------
225 # Configuration options related to the preprocessor
226 #---------------------------------------------------------------------------
227 ENABLE_PREPROCESSING = YES
229 EXPAND_ONLY_PREDEF = NO
230 SEARCH_INCLUDES = YES
232 INCLUDE_FILE_PATTERNS =
235 SKIP_FUNCTION_MACROS = YES
236 #---------------------------------------------------------------------------
237 # Configuration::additions related to external references
238 #---------------------------------------------------------------------------
242 EXTERNAL_GROUPS = YES
243 PERL_PATH = /usr/bin/perl
244 #---------------------------------------------------------------------------
245 # Configuration options related to the dot tool
246 #---------------------------------------------------------------------------
248 HIDE_UNDOC_RELATIONS = YES
251 COLLABORATION_GRAPH = YES
254 TEMPLATE_RELATIONS = NO
256 INCLUDED_BY_GRAPH = YES
258 GRAPHICAL_HIERARCHY = YES
259 DIRECTORY_GRAPH = YES
260 DOT_IMAGE_FORMAT = png
263 MAX_DOT_GRAPH_WIDTH = 1024
264 MAX_DOT_GRAPH_HEIGHT = 1024
265 MAX_DOT_GRAPH_DEPTH = 1000
267 DOT_MULTI_TARGETS = NO
268 GENERATE_LEGEND = YES
270 #---------------------------------------------------------------------------
271 # Configuration::additions related to the search engine
272 #---------------------------------------------------------------------------