bf89aaac729ca31e85966583a4bb9d3fe2c38dde
[keystone-rtos/edma3_lld.git] / packages / ti / sdo / edma3 / drv / docs / EDMA3_Driver_Doxygen.cfg
1 # Doxyfile 1.4.6
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = "EDMA3 Driver"
7 PROJECT_NUMBER         = 02.11.00
8 OUTPUT_DIRECTORY       = .
9 CREATE_SUBDIRS         = NO
10 OUTPUT_LANGUAGE        = English
11 USE_WINDOWS_ENCODING   = YES
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
14 ABBREVIATE_BRIEF       =
15 ALWAYS_DETAILED_SEC    = NO
16 INLINE_INHERITED_MEMB  = NO
17 FULL_PATH_NAMES        = NO
18 STRIP_FROM_PATH        =
19 STRIP_FROM_INC_PATH    =
20 SHORT_NAMES            = NO
21 JAVADOC_AUTOBRIEF      = NO
22 MULTILINE_CPP_IS_BRIEF = NO
23 DETAILS_AT_TOP         = NO
24 INHERIT_DOCS           = YES
25 SEPARATE_MEMBER_PAGES  = NO
26 TAB_SIZE               = 8
27 ALIASES                =
28 OPTIMIZE_OUTPUT_FOR_C  = YES
29 OPTIMIZE_OUTPUT_JAVA   = NO
30 BUILTIN_STL_SUPPORT    = NO
31 DISTRIBUTE_GROUP_DOC   = NO
32 SUBGROUPING            = YES
33 #---------------------------------------------------------------------------
34 # Build related configuration options
35 #---------------------------------------------------------------------------
36 EXTRACT_ALL            = NO
37 EXTRACT_PRIVATE        = NO
38 EXTRACT_STATIC         = YES
39 EXTRACT_LOCAL_CLASSES  = YES
40 EXTRACT_LOCAL_METHODS  = NO
41 HIDE_UNDOC_MEMBERS     = YES
42 HIDE_UNDOC_CLASSES     = YES
43 HIDE_FRIEND_COMPOUNDS  = NO
44 HIDE_IN_BODY_DOCS      = YES
45 INTERNAL_DOCS          = NO
46 CASE_SENSE_NAMES       = NO
47 HIDE_SCOPE_NAMES       = NO
48 SHOW_INCLUDE_FILES     = YES
49 INLINE_INFO            = YES
50 SORT_MEMBER_DOCS       = NO
51 SORT_BRIEF_DOCS        = NO
52 SORT_BY_SCOPE_NAME     = NO
53 GENERATE_TODOLIST      = YES
54 GENERATE_TESTLIST      = YES
55 GENERATE_BUGLIST       = YES
56 GENERATE_DEPRECATEDLIST= YES
57 ENABLED_SECTIONS       =
58 MAX_INITIALIZER_LINES  = 30
59 SHOW_USED_FILES        = YES
60 SHOW_DIRECTORIES       = NO
61 FILE_VERSION_FILTER    =
62 #---------------------------------------------------------------------------
63 # configuration options related to warning and progress messages
64 #---------------------------------------------------------------------------
65 QUIET                  = NO
66 WARNINGS               = YES
67 WARN_IF_UNDOCUMENTED   = YES
68 WARN_IF_DOC_ERROR      = YES
69 WARN_NO_PARAMDOC       = NO
70 WARN_FORMAT            = "$file:$line: $text"
71 WARN_LOGFILE           =
72 #---------------------------------------------------------------------------
73 # configuration options related to the input files
74 #---------------------------------------------------------------------------
75 INPUT                  = ..\edma3_drv.h \
76                          ..\src
77 FILE_PATTERNS          = *.c \
78                          *.h
79 RECURSIVE              = YES
80 EXCLUDE                =
81 EXCLUDE_SYMLINKS       = NO
82 EXCLUDE_PATTERNS       =
83 EXAMPLE_PATH           =
84 EXAMPLE_PATTERNS       =
85 EXAMPLE_RECURSIVE      = NO
86 IMAGE_PATH             =
87 INPUT_FILTER           =
88 FILTER_PATTERNS        =
89 FILTER_SOURCE_FILES    = NO
90 #---------------------------------------------------------------------------
91 # configuration options related to source browsing
92 #---------------------------------------------------------------------------
93 SOURCE_BROWSER         = NO
94 INLINE_SOURCES         = NO
95 STRIP_CODE_COMMENTS    = YES
96 REFERENCED_BY_RELATION = NO
97 REFERENCES_RELATION    = NO
98 REFERENCES_LINK_SOURCE = YES
99 USE_HTAGS              = NO
100 VERBATIM_HEADERS       = NO
101 #---------------------------------------------------------------------------
102 # configuration options related to the alphabetical class index
103 #---------------------------------------------------------------------------
104 ALPHABETICAL_INDEX     = YES
105 COLS_IN_ALPHA_INDEX    = 4
106 IGNORE_PREFIX          =
107 #---------------------------------------------------------------------------
108 # configuration options related to the HTML output
109 #---------------------------------------------------------------------------
110 GENERATE_HTML          = YES
111 HTML_OUTPUT            = html
112 HTML_FILE_EXTENSION    = .html
113 HTML_HEADER            =
114 HTML_FOOTER            =
115 HTML_STYLESHEET        =
116 HTML_ALIGN_MEMBERS     = YES
117 GENERATE_HTMLHELP      = YES
118 CHM_FILE               = ..\EDMA3_Driver.chm
119 HHC_LOCATION           = "C:\Program Files\HTML Help Workshop\hhc.exe"
120 GENERATE_CHI           = NO
121 BINARY_TOC             = NO
122 TOC_EXPAND             = NO
123 DISABLE_INDEX          = NO
124 ENUM_VALUES_PER_LINE   = 1
125 GENERATE_TREEVIEW      = NO
126 TREEVIEW_WIDTH         = 250
127 #---------------------------------------------------------------------------
128 # configuration options related to the LaTeX output
129 #---------------------------------------------------------------------------
130 GENERATE_LATEX         = NO
131 LATEX_OUTPUT           = latex
132 LATEX_CMD_NAME         = latex
133 MAKEINDEX_CMD_NAME     = makeindex
134 COMPACT_LATEX          = NO
135 PAPER_TYPE             = a4wide
136 EXTRA_PACKAGES         =
137 LATEX_HEADER           =
138 PDF_HYPERLINKS         = NO
139 USE_PDFLATEX           = NO
140 LATEX_BATCHMODE        = NO
141 LATEX_HIDE_INDICES     = NO
142 #---------------------------------------------------------------------------
143 # configuration options related to the RTF output
144 #---------------------------------------------------------------------------
145 GENERATE_RTF           = NO
146 RTF_OUTPUT             = rtf
147 COMPACT_RTF            = NO
148 RTF_HYPERLINKS         = NO
149 RTF_STYLESHEET_FILE    =
150 RTF_EXTENSIONS_FILE    =
151 #---------------------------------------------------------------------------
152 # configuration options related to the man page output
153 #---------------------------------------------------------------------------
154 GENERATE_MAN           = NO
155 MAN_OUTPUT             = man
156 MAN_EXTENSION          = .3
157 MAN_LINKS              = NO
158 #---------------------------------------------------------------------------
159 # configuration options related to the XML output
160 #---------------------------------------------------------------------------
161 GENERATE_XML           = NO
162 XML_OUTPUT             = xml
163 XML_SCHEMA             =
164 XML_DTD                =
165 XML_PROGRAMLISTING     = YES
166 #---------------------------------------------------------------------------
167 # configuration options for the AutoGen Definitions output
168 #---------------------------------------------------------------------------
169 GENERATE_AUTOGEN_DEF   = NO
170 #---------------------------------------------------------------------------
171 # configuration options related to the Perl module output
172 #---------------------------------------------------------------------------
173 GENERATE_PERLMOD       = NO
174 PERLMOD_LATEX          = NO
175 PERLMOD_PRETTY         = YES
176 PERLMOD_MAKEVAR_PREFIX =
177 #---------------------------------------------------------------------------
178 # Configuration options related to the preprocessor
179 #---------------------------------------------------------------------------
180 ENABLE_PREPROCESSING   = YES
181 MACRO_EXPANSION        = NO
182 EXPAND_ONLY_PREDEF     = NO
183 SEARCH_INCLUDES        = YES
184 INCLUDE_PATH           =
185 INCLUDE_FILE_PATTERNS  =
186 PREDEFINED             =
187 EXPAND_AS_DEFINED      =
188 SKIP_FUNCTION_MACROS   = YES
189 #---------------------------------------------------------------------------
190 # Configuration::additions related to external references
191 #---------------------------------------------------------------------------
192 TAGFILES               =
193 GENERATE_TAGFILE       =
194 ALLEXTERNALS           = NO
195 EXTERNAL_GROUPS        = YES
196 PERL_PATH              = /usr/bin/perl
197 #---------------------------------------------------------------------------
198 # Configuration options related to the dot tool
199 #---------------------------------------------------------------------------
200 CLASS_DIAGRAMS         = NO
201 HIDE_UNDOC_RELATIONS   = YES
202 HAVE_DOT               = NO
203 CLASS_GRAPH            = YES
204 COLLABORATION_GRAPH    = YES
205 GROUP_GRAPHS           = YES
206 UML_LOOK               = NO
207 TEMPLATE_RELATIONS     = NO
208 INCLUDE_GRAPH          = YES
209 INCLUDED_BY_GRAPH      = YES
210 CALL_GRAPH             = NO
211 CALLER_GRAPH           = NO
212 GRAPHICAL_HIERARCHY    = YES
213 DIRECTORY_GRAPH        = YES
214 DOT_IMAGE_FORMAT       = png
215 DOT_PATH               =
216 DOTFILE_DIRS           =
217 MAX_DOT_GRAPH_WIDTH    = 1024
218 MAX_DOT_GRAPH_HEIGHT   = 1024
219 MAX_DOT_GRAPH_DEPTH    = 0
220 DOT_TRANSPARENT        = NO
221 DOT_MULTI_TARGETS      = NO
222 GENERATE_LEGEND        = YES
223 DOT_CLEANUP            = YES
224 #---------------------------------------------------------------------------
225 # Configuration::additions related to the search engine
226 #---------------------------------------------------------------------------
227 SEARCHENGINE           = NO