am7xxx: make a comment clearer about SCAN_OP_OPEN_DEVICE
[libam7xxx.git] / doc / Doxyfile.in
1 # Doxyfile 1.8.8
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           = @PROJECT_NAME@
8 PROJECT_NUMBER         = @PROJECT_APIVER@
9 PROJECT_BRIEF          = "@PROJECT_DESCRIPTION@"
10 PROJECT_LOGO           =
11 OUTPUT_DIRECTORY       = @DOC_OUTPUT_PATH@
12 CREATE_SUBDIRS         = NO
13 ALLOW_UNICODE_NAMES    = NO
14 OUTPUT_LANGUAGE        = English
15 BRIEF_MEMBER_DESC      = YES
16 REPEAT_BRIEF           = YES
17 ABBREVIATE_BRIEF       =
18 ALWAYS_DETAILED_SEC    = NO
19 INLINE_INHERITED_MEMB  = NO
20 FULL_PATH_NAMES        = YES
21 STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@
22 STRIP_FROM_INC_PATH    =
23 SHORT_NAMES            = NO
24 JAVADOC_AUTOBRIEF      = YES
25 QT_AUTOBRIEF           = NO
26 MULTILINE_CPP_IS_BRIEF = NO
27 INHERIT_DOCS           = YES
28 SEPARATE_MEMBER_PAGES  = NO
29 TAB_SIZE               = 8
30 ALIASES                =
31 TCL_SUBST              =
32 OPTIMIZE_OUTPUT_FOR_C  = YES
33 OPTIMIZE_OUTPUT_JAVA   = NO
34 OPTIMIZE_FOR_FORTRAN   = NO
35 OPTIMIZE_OUTPUT_VHDL   = NO
36 EXTENSION_MAPPING      =
37 MARKDOWN_SUPPORT       = YES
38 AUTOLINK_SUPPORT       = YES
39 BUILTIN_STL_SUPPORT    = NO
40 CPP_CLI_SUPPORT        = NO
41 SIP_SUPPORT            = NO
42 IDL_PROPERTY_SUPPORT   = YES
43 DISTRIBUTE_GROUP_DOC   = NO
44 SUBGROUPING            = YES
45 INLINE_GROUPED_CLASSES = NO
46 INLINE_SIMPLE_STRUCTS  = NO
47 TYPEDEF_HIDES_STRUCT   = NO
48 LOOKUP_CACHE_SIZE      = 0
49 #---------------------------------------------------------------------------
50 # Build related configuration options
51 #---------------------------------------------------------------------------
52 EXTRACT_ALL            = NO
53 EXTRACT_PRIVATE        = NO
54 EXTRACT_PACKAGE        = NO
55 EXTRACT_STATIC         = NO
56 EXTRACT_LOCAL_CLASSES  = NO
57 EXTRACT_LOCAL_METHODS  = NO
58 EXTRACT_ANON_NSPACES   = NO
59 HIDE_UNDOC_MEMBERS     = NO
60 HIDE_UNDOC_CLASSES     = NO
61 HIDE_FRIEND_COMPOUNDS  = NO
62 HIDE_IN_BODY_DOCS      = NO
63 INTERNAL_DOCS          = NO
64 CASE_SENSE_NAMES       = YES
65 HIDE_SCOPE_NAMES       = NO
66 SHOW_INCLUDE_FILES     = YES
67 SHOW_GROUPED_MEMB_INC  = NO
68 FORCE_LOCAL_INCLUDES   = NO
69 INLINE_INFO            = YES
70 SORT_MEMBER_DOCS       = YES
71 SORT_BRIEF_DOCS        = NO
72 SORT_MEMBERS_CTORS_1ST = NO
73 SORT_GROUP_NAMES       = NO
74 SORT_BY_SCOPE_NAME     = NO
75 STRICT_PROTO_MATCHING  = NO
76 GENERATE_TODOLIST      = YES
77 GENERATE_TESTLIST      = YES
78 GENERATE_BUGLIST       = YES
79 GENERATE_DEPRECATEDLIST= YES
80 ENABLED_SECTIONS       =
81 MAX_INITIALIZER_LINES  = 30
82 SHOW_USED_FILES        = YES
83 SHOW_FILES             = YES
84 SHOW_NAMESPACES        = YES
85 FILE_VERSION_FILTER    =
86 LAYOUT_FILE            =
87 CITE_BIB_FILES         =
88 #---------------------------------------------------------------------------
89 # Configuration options related to warning and progress messages
90 #---------------------------------------------------------------------------
91 QUIET                  = NO
92 WARNINGS               = YES
93 WARN_IF_UNDOCUMENTED   = YES
94 WARN_IF_DOC_ERROR      = YES
95 WARN_NO_PARAMDOC       = NO
96 WARN_FORMAT            = "$file:$line: $text"
97 WARN_LOGFILE           =
98 #---------------------------------------------------------------------------
99 # Configuration options related to the input files
100 #---------------------------------------------------------------------------
101 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/ \
102                          @CMAKE_SOURCE_DIR@/src/ \
103                          @CMAKE_SOURCE_DIR@/examples/
104 INPUT_ENCODING         = UTF-8
105 FILE_PATTERNS          = *.dox \
106                          *.h \
107                          *.c
108 RECURSIVE              = NO
109 EXCLUDE                =
110 EXCLUDE_SYMLINKS       = NO
111 EXCLUDE_PATTERNS       =
112 EXCLUDE_SYMBOLS        =
113 EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@/examples/
114 EXAMPLE_PATTERNS       = *.c
115 EXAMPLE_RECURSIVE      = NO
116 IMAGE_PATH             =
117 INPUT_FILTER           =
118 FILTER_PATTERNS        =
119 FILTER_SOURCE_FILES    = NO
120 FILTER_SOURCE_PATTERNS =
121 USE_MDFILE_AS_MAINPAGE =
122 #---------------------------------------------------------------------------
123 # Configuration options related to source browsing
124 #---------------------------------------------------------------------------
125 SOURCE_BROWSER         = YES
126 INLINE_SOURCES         = YES
127 STRIP_CODE_COMMENTS    = YES
128 REFERENCED_BY_RELATION = NO
129 REFERENCES_RELATION    = NO
130 REFERENCES_LINK_SOURCE = YES
131 SOURCE_TOOLTIPS        = YES
132 USE_HTAGS              = NO
133 VERBATIM_HEADERS       = YES
134 CLANG_ASSISTED_PARSING = NO
135 CLANG_OPTIONS          =
136 #---------------------------------------------------------------------------
137 # Configuration options related to the alphabetical class index
138 #---------------------------------------------------------------------------
139 ALPHABETICAL_INDEX     = YES
140 COLS_IN_ALPHA_INDEX    = 5
141 IGNORE_PREFIX          =
142 #---------------------------------------------------------------------------
143 # Configuration options related to the HTML output
144 #---------------------------------------------------------------------------
145 GENERATE_HTML          = YES
146 HTML_OUTPUT            = html
147 HTML_FILE_EXTENSION    = .html
148 HTML_HEADER            =
149 HTML_FOOTER            =
150 HTML_STYLESHEET        =
151 HTML_EXTRA_STYLESHEET  =
152 HTML_EXTRA_FILES       =
153 HTML_COLORSTYLE_HUE    = 220
154 HTML_COLORSTYLE_SAT    = 100
155 HTML_COLORSTYLE_GAMMA  = 80
156 HTML_TIMESTAMP         = YES
157 HTML_DYNAMIC_SECTIONS  = NO
158 HTML_INDEX_NUM_ENTRIES = 100
159 GENERATE_DOCSET        = NO
160 DOCSET_FEEDNAME        = "Doxygen generated docs"
161 DOCSET_BUNDLE_ID       = org.doxygen.Project
162 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
163 DOCSET_PUBLISHER_NAME  = Publisher
164 GENERATE_HTMLHELP      = NO
165 CHM_FILE               =
166 HHC_LOCATION           =
167 GENERATE_CHI           = NO
168 CHM_INDEX_ENCODING     =
169 BINARY_TOC             = NO
170 TOC_EXPAND             = NO
171 GENERATE_QHP           = NO
172 QCH_FILE               =
173 QHP_NAMESPACE          = org.doxygen.Project
174 QHP_VIRTUAL_FOLDER     = doc
175 QHP_CUST_FILTER_NAME   =
176 QHP_CUST_FILTER_ATTRS  =
177 QHP_SECT_FILTER_ATTRS  =
178 QHG_LOCATION           =
179 GENERATE_ECLIPSEHELP   = NO
180 ECLIPSE_DOC_ID         = org.doxygen.Project
181 DISABLE_INDEX          = NO
182 GENERATE_TREEVIEW      = NO
183 ENUM_VALUES_PER_LINE   = 4
184 TREEVIEW_WIDTH         = 250
185 EXT_LINKS_IN_WINDOW    = NO
186 FORMULA_FONTSIZE       = 10
187 FORMULA_TRANSPARENT    = YES
188 USE_MATHJAX            = NO
189 MATHJAX_FORMAT         = HTML-CSS
190 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
191 MATHJAX_EXTENSIONS     =
192 MATHJAX_CODEFILE       =
193 SEARCHENGINE           = YES
194 SERVER_BASED_SEARCH    = NO
195 EXTERNAL_SEARCH        = NO
196 SEARCHENGINE_URL       =
197 SEARCHDATA_FILE        = searchdata.xml
198 EXTERNAL_SEARCH_ID     =
199 EXTRA_SEARCH_MAPPINGS  =
200 #---------------------------------------------------------------------------
201 # Configuration options related to the LaTeX output
202 #---------------------------------------------------------------------------
203 GENERATE_LATEX         = NO
204 LATEX_OUTPUT           = latex
205 LATEX_CMD_NAME         = latex
206 MAKEINDEX_CMD_NAME     = makeindex
207 COMPACT_LATEX          = NO
208 PAPER_TYPE             = a4
209 EXTRA_PACKAGES         =
210 LATEX_HEADER           =
211 LATEX_FOOTER           =
212 LATEX_EXTRA_FILES      =
213 PDF_HYPERLINKS         = YES
214 USE_PDFLATEX           = YES
215 LATEX_BATCHMODE        = NO
216 LATEX_HIDE_INDICES     = NO
217 LATEX_SOURCE_CODE      = NO
218 LATEX_BIB_STYLE        = plain
219 #---------------------------------------------------------------------------
220 # Configuration options related to the RTF output
221 #---------------------------------------------------------------------------
222 GENERATE_RTF           = NO
223 RTF_OUTPUT             = rtf
224 COMPACT_RTF            = NO
225 RTF_HYPERLINKS         = NO
226 RTF_STYLESHEET_FILE    =
227 RTF_EXTENSIONS_FILE    =
228 #---------------------------------------------------------------------------
229 # Configuration options related to the man page output
230 #---------------------------------------------------------------------------
231 GENERATE_MAN           = NO
232 MAN_OUTPUT             = man
233 MAN_EXTENSION          = .3
234 MAN_SUBDIR             =
235 MAN_LINKS              = NO
236 #---------------------------------------------------------------------------
237 # Configuration options related to the XML output
238 #---------------------------------------------------------------------------
239 GENERATE_XML           = NO
240 XML_OUTPUT             = xml
241 XML_PROGRAMLISTING     = YES
242 #---------------------------------------------------------------------------
243 # Configuration options related to the DOCBOOK output
244 #---------------------------------------------------------------------------
245 GENERATE_DOCBOOK       = NO
246 DOCBOOK_OUTPUT         = docbook
247 DOCBOOK_PROGRAMLISTING = NO
248 #---------------------------------------------------------------------------
249 # Configuration options for the AutoGen Definitions output
250 #---------------------------------------------------------------------------
251 GENERATE_AUTOGEN_DEF   = NO
252 #---------------------------------------------------------------------------
253 # Configuration options related to the Perl module output
254 #---------------------------------------------------------------------------
255 GENERATE_PERLMOD       = NO
256 PERLMOD_LATEX          = NO
257 PERLMOD_PRETTY         = YES
258 PERLMOD_MAKEVAR_PREFIX =
259 #---------------------------------------------------------------------------
260 # Configuration options related to the preprocessor
261 #---------------------------------------------------------------------------
262 ENABLE_PREPROCESSING   = YES
263 MACRO_EXPANSION        = NO
264 EXPAND_ONLY_PREDEF     = NO
265 SEARCH_INCLUDES        = YES
266 INCLUDE_PATH           =
267 INCLUDE_FILE_PATTERNS  =
268 PREDEFINED             =
269 EXPAND_AS_DEFINED      =
270 SKIP_FUNCTION_MACROS   = YES
271 #---------------------------------------------------------------------------
272 # Configuration options related to external references
273 #---------------------------------------------------------------------------
274 TAGFILES               =
275 GENERATE_TAGFILE       =
276 ALLEXTERNALS           = NO
277 EXTERNAL_GROUPS        = YES
278 EXTERNAL_PAGES         = YES
279 PERL_PATH              = /usr/bin/perl
280 #---------------------------------------------------------------------------
281 # Configuration options related to the dot tool
282 #---------------------------------------------------------------------------
283 CLASS_DIAGRAMS         = NO
284 MSCGEN_PATH            =
285 DIA_PATH               =
286 HIDE_UNDOC_RELATIONS   = YES
287 HAVE_DOT               = NO
288 DOT_NUM_THREADS        = 0
289 DOT_FONTNAME           = Helvetica
290 DOT_FONTSIZE           = 10
291 DOT_FONTPATH           =
292 CLASS_GRAPH            = YES
293 COLLABORATION_GRAPH    = YES
294 GROUP_GRAPHS           = YES
295 UML_LOOK               = NO
296 UML_LIMIT_NUM_FIELDS   = 10
297 TEMPLATE_RELATIONS     = NO
298 INCLUDE_GRAPH          = YES
299 INCLUDED_BY_GRAPH      = YES
300 CALL_GRAPH             = NO
301 CALLER_GRAPH           = NO
302 GRAPHICAL_HIERARCHY    = YES
303 DIRECTORY_GRAPH        = YES
304 DOT_IMAGE_FORMAT       = png
305 INTERACTIVE_SVG        = NO
306 DOT_PATH               =
307 DOTFILE_DIRS           =
308 MSCFILE_DIRS           =
309 DIAFILE_DIRS           =
310 PLANTUML_JAR_PATH      =
311 DOT_GRAPH_MAX_NODES    = 50
312 MAX_DOT_GRAPH_DEPTH    = 0
313 DOT_TRANSPARENT        = NO
314 DOT_MULTI_TARGETS      = YES
315 GENERATE_LEGEND        = YES
316 DOT_CLEANUP            = YES