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