Update DSPLIB benchmarking results based on C6000 8.3.2 compiler.
[ep-processor-libraries/dsplib.git] / ti / dsplib / docs / bundle / doxygen / doxyfile.xdt
1 %%{
2 /*!
3  *  This template implements the Doxyfile
4  */  
5   /* Versioning */
6   var ver = this.version;
7   var packageVersion = "\"Release  "+ver[0]+"."+ver[1]+"."+ver[2]+"."+ver[3];
8   switch (ver[4]) {
9     case 0: quality = "Pre-alpha";
10             break;
11     case 1: quality = "Alpha";
12             break; 
13     case 2: quality = "Beta";
14             break; 
15     case 3: quality = "";
16             break; 
17   }  
18   if (quality.length != 0) {
19     packageVersion = packageVersion.concat (" "+quality + "\"");
20   }
21   else {
22     packageVersion = packageVersion.concat ("\"");
23   }
25   var target_x   = this.ext;
26   var target     = target_x.slice(0,target_x.length-1);
27   
28   var target_tru = new String(target_x);
29   if (target_x.match("c64Px")) {
30     target_tru = "c64x+";
31   }
33   var ver_string = ver[0] + "_" + ver[1] + "_" + ver[2] + "_" + ver[3];
34   if (quality.length != 0) {
35    ver_string = ver_string.concat("_" + quality);
36   }
38   /* Get capitalized bundle name */
39   var bundleName       = this.bundlename.toUpperCase();
40   var quotedBundleName = "\"" + bundleName + "\"";
42   /* Get test report link */
43   switch(target) {
44     case "c66":
45       var testReport = "DSPLIB_C66x_TestReport.html";
46    break;
47     case "c64P":
48       var testReport = "DSPLIB_C64Px_TestReport.html";
49    break; 
50     case "c674":
51       var testReport = "DSPLIB_C674x_TestReport.html";
52    break; 
53   }
55 %%}
57 # Doxyfile 1.5.1-p1
59 #---------------------------------------------------------------------------
60 # Project related configuration options
61 #---------------------------------------------------------------------------
62 PROJECT_NAME           = `quotedBundleName`
63 PROJECT_NUMBER         = `packageVersion`
64 OUTPUT_DIRECTORY       = ./docs/doxygen
65 CREATE_SUBDIRS         = NO
66 OUTPUT_LANGUAGE        = English
67 USE_WINDOWS_ENCODING   = YES
68 BRIEF_MEMBER_DESC      = YES
69 REPEAT_BRIEF           = YES
70 ABBREVIATE_BRIEF       = "The $name class" \
71                          "The $name widget" \
72                          "The $name file" \
73                          is \
74                          provides \
75                          specifies \
76                          contains \
77                          represents \
78                          a \
79                          an \
80                          the
81 ALWAYS_DETAILED_SEC    = NO
82 INLINE_INHERITED_MEMB  = NO
83 FULL_PATH_NAMES        = NO
84 STRIP_FROM_PATH        =
85 STRIP_FROM_INC_PATH    = 
86 SHORT_NAMES            = NO
87 JAVADOC_AUTOBRIEF      = NO
88 MULTILINE_CPP_IS_BRIEF = NO
89 DETAILS_AT_TOP         = YES
90 INHERIT_DOCS           = YES
91 SEPARATE_MEMBER_PAGES  = NO
92 TAB_SIZE               = 2
93 ALIASES                = "PACKAGE       =`bundleName`" \
94                          "package       =`this.bundlename`" \
95                          "TARGET        =`target`" \
96                          "TARGETX       =`target_x`" \
97                          "TARGETN       =`target_tru`" \
98                          "PKGTESTREP    =`testReport`" \
99                          "PKGRELNOTES   =`this.bundlename`_`ver_string`_release_notes.html" \
100                          "PKGMANHTML    =`bundleName`_Users_Manual.html" \
101                          "PKGMANCHM     =`bundleName`_Users_Manual.chm" \
102                          "PKGSWMFEST    =`bundleName`_Software_Manifest.html" \
103                          "PKGDIR        =`this.bundlename`_`target_x`_`ver_string`" \
104                          "PKGINSTDIR    =`bundleName`_INSTALL_DIR" \
105                          "PKGMANLINK    =./`this.bundlename`_html/index.html" \
106                                                  "PKGMODLINK    =./`this.bundlename`_html/modules.html" \
107                          "PKGHEADER     =`this.bundlename`.h" \
108                          "KERNELEX      =DSP_fft16x16" \
109                          "TSTYLE        =rules=\"none\" frame=\"box\" cellspacing=\"4\" cellpadding=\"4\" width=\"650px\" style=\"background-color: #ffff99; border: 2px #000000 solid;\"" \
110                          "NSTYLE        =rules=\"none\" frame=\"box\" cellspacing=\"1\" cellpadding=\"1\" style=\"background-color: #ffff99; border: 1px #000000 solid;\"" \
111                          "ASTYLE        =style=\"color: #ff0000; background-color: #ffff99\"" \
112                          "CSTYLE        =width=\"150px\"" \
113                          "BLANK         =target=\"_blank\"" \
114                          "SECSTART      =<div><table rules=\"none\" frame=\"box\" cellspacing=\"4\" cellpadding=\"4\" width=\"100%\" style=\"border: 1px #000000 solid;\"><tr><td>" \
115                          "SECEND        =</td></tr></table><p>&nbsp;</p></div>" \
116                          "SPACER        =<div><p>&nbsp;</p></div>" \
117                          "HLINE         =<hr size=\"2\" width=\"50%\" align=\"left\">"
118 OPTIMIZE_OUTPUT_FOR_C  = YES
119 OPTIMIZE_OUTPUT_JAVA   = NO
120 BUILTIN_STL_SUPPORT    = NO
121 DISTRIBUTE_GROUP_DOC   = NO
122 SUBGROUPING            = YES
123 #---------------------------------------------------------------------------
124 # Build related configuration options
125 #---------------------------------------------------------------------------
126 EXTRACT_ALL            = YES
127 EXTRACT_PRIVATE        = YES
128 EXTRACT_STATIC         = YES
129 EXTRACT_LOCAL_CLASSES  = YES
130 EXTRACT_LOCAL_METHODS  = NO
131 HIDE_UNDOC_MEMBERS     = NO
132 HIDE_UNDOC_CLASSES     = NO
133 HIDE_FRIEND_COMPOUNDS  = NO
134 HIDE_IN_BODY_DOCS      = NO
135 INTERNAL_DOCS          = NO
136 CASE_SENSE_NAMES       = NO
137 HIDE_SCOPE_NAMES       = NO
138 SHOW_INCLUDE_FILES     = YES
139 INLINE_INFO            = YES
140 SORT_MEMBER_DOCS       = NO
141 SORT_BRIEF_DOCS        = NO
142 SORT_BY_SCOPE_NAME     = NO
143 GENERATE_TODOLIST      = YES
144 GENERATE_TESTLIST      = YES
145 GENERATE_BUGLIST       = YES
146 GENERATE_DEPRECATEDLIST= YES
147 ENABLED_SECTIONS       = `target.toUpperCase()` 
148 MAX_INITIALIZER_LINES  = 30
149 SHOW_USED_FILES        = YES
150 SHOW_DIRECTORIES       = NO
151 FILE_VERSION_FILTER    = 
152 #---------------------------------------------------------------------------
153 # configuration options related to warning and progress messages
154 #---------------------------------------------------------------------------
155 QUIET                  = NO
156 WARNINGS               = YES
157 WARN_IF_UNDOCUMENTED   = YES
158 WARN_IF_DOC_ERROR      = YES
159 WARN_NO_PARAMDOC       = NO
160 WARN_FORMAT            = "$file:$line: $text"
161 WARN_LOGFILE           = 
162 #---------------------------------------------------------------------------
163 # configuration options related to the input files
164 #---------------------------------------------------------------------------
165 INPUT                  = ./docs/doxygen 
166 FILE_PATTERNS          = *.h
167 RECURSIVE              = NO
168 EXCLUDE                = ./package ./version.h ./docs/doxygen/release.h
169 EXCLUDE_SYMLINKS       = NO
170 EXCLUDE_PATTERNS       = 
171 EXAMPLE_PATH           = 
172 EXAMPLE_PATTERNS       = *
173 EXAMPLE_RECURSIVE      = YES
174 IMAGE_PATH             = ./docs/doxygen/images
175 INPUT_FILTER           = 
176 FILTER_PATTERNS        = 
177 FILTER_SOURCE_FILES    = NO
178 #---------------------------------------------------------------------------
179 # configuration options related to source browsing
180 #---------------------------------------------------------------------------
181 SOURCE_BROWSER         = YES
182 INLINE_SOURCES         = NO
183 STRIP_CODE_COMMENTS    = YES
184 REFERENCED_BY_RELATION = YES
185 REFERENCES_RELATION    = YES
186 REFERENCES_LINK_SOURCE = YES
187 USE_HTAGS              = NO
188 VERBATIM_HEADERS       = YES
189 #---------------------------------------------------------------------------
190 # configuration options related to the alphabetical class index
191 #---------------------------------------------------------------------------
192 ALPHABETICAL_INDEX     = NO
193 COLS_IN_ALPHA_INDEX    = 5
194 IGNORE_PREFIX          = 
195 #---------------------------------------------------------------------------
196 # configuration options related to the HTML output
197 #---------------------------------------------------------------------------
198 GENERATE_HTML          = YES
199 HTML_OUTPUT            = html
200 HTML_FILE_EXTENSION    = .html
201 HTML_HEADER            = ./docs/doxygen/html/tiheader.htm
202 HTML_FOOTER            = ./docs/doxygen/html/tifooter.htm
203 HTML_STYLESHEET        = 
204 HTML_ALIGN_MEMBERS     = YES
205 GENERATE_HTMLHELP      = YES
206 CHM_FILE               = ../../`bundleName`_Users_Manual.chm
207 HHC_LOCATION           = hhc.exe
208 GENERATE_CHI           = NO
209 BINARY_TOC             = NO
210 TOC_EXPAND             = NO
211 DISABLE_INDEX          = NO
212 ENUM_VALUES_PER_LINE   = 4
213 GENERATE_TREEVIEW      = NO
214 TREEVIEW_WIDTH         = 250
215 #---------------------------------------------------------------------------
216 # configuration options related to the LaTeX output
217 #---------------------------------------------------------------------------
218 GENERATE_LATEX         = NO
219 LATEX_OUTPUT           = latex
220 LATEX_CMD_NAME         = latex
221 MAKEINDEX_CMD_NAME     = makeindex
222 COMPACT_LATEX          = NO
223 PAPER_TYPE             = a4wide
224 EXTRA_PACKAGES         = 
225 LATEX_HEADER           = 
226 PDF_HYPERLINKS         = NO
227 USE_PDFLATEX           = YES
228 LATEX_BATCHMODE        = NO
229 LATEX_HIDE_INDICES     = NO
230 #---------------------------------------------------------------------------
231 # configuration options related to the RTF output
232 #---------------------------------------------------------------------------
233 GENERATE_RTF           = NO
234 RTF_OUTPUT             = rtf
235 COMPACT_RTF            = NO
236 RTF_HYPERLINKS         = NO
237 RTF_STYLESHEET_FILE    = 
238 RTF_EXTENSIONS_FILE    = 
239 #---------------------------------------------------------------------------
240 # configuration options related to the man page output
241 #---------------------------------------------------------------------------
242 GENERATE_MAN           = NO
243 MAN_OUTPUT             = man
244 MAN_EXTENSION          = .3
245 MAN_LINKS              = NO
246 #---------------------------------------------------------------------------
247 # configuration options related to the XML output
248 #---------------------------------------------------------------------------
249 GENERATE_XML           = NO
250 XML_OUTPUT             = xml
251 XML_SCHEMA             = 
252 XML_DTD                = 
253 XML_PROGRAMLISTING     = YES
254 #---------------------------------------------------------------------------
255 # configuration options for the AutoGen Definitions output
256 #---------------------------------------------------------------------------
257 GENERATE_AUTOGEN_DEF   = NO
258 #---------------------------------------------------------------------------
259 # configuration options related to the Perl module output
260 #---------------------------------------------------------------------------
261 GENERATE_PERLMOD       = NO
262 PERLMOD_LATEX          = NO
263 PERLMOD_PRETTY         = YES
264 PERLMOD_MAKEVAR_PREFIX = 
265 #---------------------------------------------------------------------------
266 # Configuration options related to the preprocessor   
267 #---------------------------------------------------------------------------
268 ENABLE_PREPROCESSING   = YES
269 MACRO_EXPANSION        = NO
270 EXPAND_ONLY_PREDEF     = NO
271 SEARCH_INCLUDES        = YES
272 INCLUDE_PATH           = 
273 INCLUDE_FILE_PATTERNS  = 
274 PREDEFINED             = 
275 EXPAND_AS_DEFINED      = 
276 SKIP_FUNCTION_MACROS   = YES
277 #---------------------------------------------------------------------------
278 # Configuration::additions related to external references   
279 #---------------------------------------------------------------------------
280 TAGFILES               = 
281 GENERATE_TAGFILE       = 
282 ALLEXTERNALS           = NO
283 EXTERNAL_GROUPS        = YES
284 PERL_PATH              = /usr/bin/perl
285 #---------------------------------------------------------------------------
286 # Configuration options related to the dot tool   
287 #---------------------------------------------------------------------------
288 CLASS_DIAGRAMS         = NO
289 HIDE_UNDOC_RELATIONS   = YES
290 HAVE_DOT               = YES
291 CLASS_GRAPH            = YES
292 COLLABORATION_GRAPH    = YES
293 GROUP_GRAPHS           = YES
294 UML_LOOK               = NO
295 TEMPLATE_RELATIONS     = NO
296 INCLUDE_GRAPH          = YES
297 INCLUDED_BY_GRAPH      = YES
298 CALL_GRAPH             = YES
299 CALLER_GRAPH           = NO
300 GRAPHICAL_HIERARCHY    = YES
301 DIRECTORY_GRAPH        = YES
302 DOT_IMAGE_FORMAT       = gif
303 DOT_PATH               =
304 DOTFILE_DIRS           = ./
305 MAX_DOT_GRAPH_WIDTH    = 1024
306 MAX_DOT_GRAPH_HEIGHT   = 1024
307 MAX_DOT_GRAPH_DEPTH    = 1000
308 DOT_TRANSPARENT        = NO
309 DOT_MULTI_TARGETS      = NO
310 GENERATE_LEGEND        = YES
311 DOT_CLEANUP            = YES
312 #---------------------------------------------------------------------------
313 # Configuration::additions related to the search engine   
314 #---------------------------------------------------------------------------
315 SEARCHENGINE           = NO