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