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