3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING = UTF-8
9 OUTPUT_DIRECTORY = apidoc.api
11 OUTPUT_LANGUAGE = English
12 BRIEF_MEMBER_DESC = YES
14 ABBREVIATE_BRIEF = "The $name class" \
25 ALWAYS_DETAILED_SEC = NO
26 INLINE_INHERITED_MEMB = NO
31 JAVADOC_AUTOBRIEF = YES
33 MULTILINE_CPP_IS_BRIEF = NO
36 SEPARATE_MEMBER_PAGES = NO
39 OPTIMIZE_OUTPUT_FOR_C = YES
40 OPTIMIZE_OUTPUT_JAVA = NO
41 BUILTIN_STL_SUPPORT = NO
43 DISTRIBUTE_GROUP_DOC = NO
45 #---------------------------------------------------------------------------
46 # Build related configuration options
47 #---------------------------------------------------------------------------
51 EXTRACT_LOCAL_CLASSES = YES
52 EXTRACT_LOCAL_METHODS = NO
53 EXTRACT_ANON_NSPACES = NO
54 HIDE_UNDOC_MEMBERS = NO
55 HIDE_UNDOC_CLASSES = NO
56 HIDE_FRIEND_COMPOUNDS = NO
57 HIDE_IN_BODY_DOCS = NO
59 CASE_SENSE_NAMES = YES
61 SHOW_INCLUDE_FILES = YES
63 SORT_MEMBER_DOCS = YES
65 SORT_BY_SCOPE_NAME = NO
66 GENERATE_TODOLIST = YES
67 GENERATE_TESTLIST = YES
68 GENERATE_BUGLIST = YES
69 GENERATE_DEPRECATEDLIST= YES
71 MAX_INITIALIZER_LINES = 30
75 #---------------------------------------------------------------------------
76 # configuration options related to warning and progress messages
77 #---------------------------------------------------------------------------
80 WARN_IF_UNDOCUMENTED = YES
81 WARN_IF_DOC_ERROR = YES
83 WARN_FORMAT = "$file:$line: $text"
85 #---------------------------------------------------------------------------
86 # configuration options related to the input files
87 #---------------------------------------------------------------------------
88 INPUT = lustre/include \
93 INPUT_ENCODING = UTF-8
94 FILE_PATTERNS = *_object.h \
100 EXCLUDE_SYMLINKS = NO
102 EXCLUDE_SYMBOLS = EXPORT_SYMBOL*
105 EXAMPLE_RECURSIVE = NO
109 FILTER_SOURCE_FILES = NO
110 #---------------------------------------------------------------------------
111 # configuration options related to source browsing
112 #---------------------------------------------------------------------------
115 STRIP_CODE_COMMENTS = YES
116 REFERENCED_BY_RELATION = YES
117 REFERENCES_RELATION = YES
118 REFERENCES_LINK_SOURCE = YES
120 VERBATIM_HEADERS = YES
121 #---------------------------------------------------------------------------
122 # configuration options related to the alphabetical class index
123 #---------------------------------------------------------------------------
124 ALPHABETICAL_INDEX = YES
125 COLS_IN_ALPHA_INDEX = 5
127 #---------------------------------------------------------------------------
128 # configuration options related to the HTML output
129 #---------------------------------------------------------------------------
132 HTML_FILE_EXTENSION = .html
136 HTML_ALIGN_MEMBERS = YES
137 GENERATE_HTMLHELP = NO
138 HTML_DYNAMIC_SECTIONS = NO
145 ENUM_VALUES_PER_LINE = 4
146 GENERATE_TREEVIEW = YES
148 #---------------------------------------------------------------------------
149 # configuration options related to the LaTeX output
150 #---------------------------------------------------------------------------
153 LATEX_CMD_NAME = latex
154 MAKEINDEX_CMD_NAME = makeindex
162 LATEX_HIDE_INDICES = NO
163 #---------------------------------------------------------------------------
164 # configuration options related to the RTF output
165 #---------------------------------------------------------------------------
170 RTF_STYLESHEET_FILE =
171 RTF_EXTENSIONS_FILE =
172 #---------------------------------------------------------------------------
173 # configuration options related to the man page output
174 #---------------------------------------------------------------------------
179 #---------------------------------------------------------------------------
180 # configuration options related to the XML output
181 #---------------------------------------------------------------------------
186 XML_PROGRAMLISTING = YES
187 #---------------------------------------------------------------------------
188 # configuration options for the AutoGen Definitions output
189 #---------------------------------------------------------------------------
190 GENERATE_AUTOGEN_DEF = NO
191 #---------------------------------------------------------------------------
192 # configuration options related to the Perl module output
193 #---------------------------------------------------------------------------
194 GENERATE_PERLMOD = NO
197 PERLMOD_MAKEVAR_PREFIX =
198 #---------------------------------------------------------------------------
199 # Configuration options related to the preprocessor
200 #---------------------------------------------------------------------------
201 ENABLE_PREPROCESSING = YES
203 EXPAND_ONLY_PREDEF = NO
204 SEARCH_INCLUDES = YES
206 INCLUDE_FILE_PATTERNS =
209 SKIP_FUNCTION_MACROS = YES
210 #---------------------------------------------------------------------------
211 # Configuration::additions related to external references
212 #---------------------------------------------------------------------------
216 EXTERNAL_GROUPS = YES
217 PERL_PATH = /usr/bin/perl
218 #---------------------------------------------------------------------------
219 # Configuration options related to the dot tool
220 #---------------------------------------------------------------------------
223 HIDE_UNDOC_RELATIONS = YES
226 COLLABORATION_GRAPH = YES
229 TEMPLATE_RELATIONS = NO
231 INCLUDED_BY_GRAPH = YES
234 GRAPHICAL_HIERARCHY = YES
235 DIRECTORY_GRAPH = YES
236 DOT_IMAGE_FORMAT = png
239 DOT_GRAPH_MAX_NODES = 50
240 MAX_DOT_GRAPH_DEPTH = 1000
242 DOT_MULTI_TARGETS = NO
243 GENERATE_LEGEND = YES
245 #---------------------------------------------------------------------------
246 # Configuration::additions related to the search engine
247 #---------------------------------------------------------------------------