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