source: Documentation/doxygen/doxyfile_global_warp_docs.cfg

Last change on this file was 1772, checked in by murphpo, 12 years ago
File size: 11.7 KB
Line 
1
2#---------------------------------------------------------------------------
3# Project related configuration options
4#---------------------------------------------------------------------------
5DOXYFILE_ENCODING      = UTF-8
6PROJECT_NAME           = w3_userio driver
7PROJECT_NUMBER         = 
8PROJECT_BRIEF          = "Driver for WARP v3 user IO control core (w3_userio_v1_00_a)"
9PROJECT_LOGO           = 
10OUTPUT_DIRECTORY       = .
11CREATE_SUBDIRS         = NO
12OUTPUT_LANGUAGE        = English
13BRIEF_MEMBER_DESC      = NO
14REPEAT_BRIEF           = NO
15ABBREVIATE_BRIEF       = "The $name class" \
16                         "The $name widget" \
17                         "The $name file" \
18                         is \
19                         provides \
20                         specifies \
21                         contains \
22                         represents \
23                         a \
24                         an \
25                         the
26ALWAYS_DETAILED_SEC    = NO
27INLINE_INHERITED_MEMB  = NO
28FULL_PATH_NAMES        = NO
29STRIP_FROM_PATH        = 
30STRIP_FROM_INC_PATH    = 
31SHORT_NAMES            = NO
32JAVADOC_AUTOBRIEF      = NO
33QT_AUTOBRIEF           = NO
34MULTILINE_CPP_IS_BRIEF = NO
35INHERIT_DOCS           = YES
36SEPARATE_MEMBER_PAGES  = NO
37TAB_SIZE               = 8
38ALIASES                = 
39TCL_SUBST              = 
40OPTIMIZE_OUTPUT_FOR_C  = YES
41OPTIMIZE_OUTPUT_JAVA   = NO
42OPTIMIZE_FOR_FORTRAN   = NO
43OPTIMIZE_OUTPUT_VHDL   = NO
44EXTENSION_MAPPING      = 
45MARKDOWN_SUPPORT       = YES
46BUILTIN_STL_SUPPORT    = NO
47CPP_CLI_SUPPORT        = NO
48SIP_SUPPORT            = NO
49IDL_PROPERTY_SUPPORT   = YES
50DISTRIBUTE_GROUP_DOC   = NO
51SUBGROUPING            = YES
52INLINE_GROUPED_CLASSES = NO
53INLINE_SIMPLE_STRUCTS  = NO
54TYPEDEF_HIDES_STRUCT   = NO
55SYMBOL_CACHE_SIZE      = 0
56LOOKUP_CACHE_SIZE      = 0
57
58#---------------------------------------------------------------------------
59# Build related configuration options
60#---------------------------------------------------------------------------
61EXTRACT_ALL            = YES
62EXTRACT_PRIVATE        = NO
63EXTRACT_PACKAGE        = NO
64EXTRACT_STATIC         = NO
65EXTRACT_LOCAL_CLASSES  = YES
66EXTRACT_LOCAL_METHODS  = NO
67EXTRACT_ANON_NSPACES   = NO
68HIDE_UNDOC_MEMBERS     = NO
69HIDE_UNDOC_CLASSES     = NO
70HIDE_FRIEND_COMPOUNDS  = NO
71HIDE_IN_BODY_DOCS      = NO
72INTERNAL_DOCS          = NO
73CASE_SENSE_NAMES       = NO
74HIDE_SCOPE_NAMES       = NO
75SHOW_INCLUDE_FILES     = YES
76FORCE_LOCAL_INCLUDES   = NO
77INLINE_INFO            = YES
78SORT_MEMBER_DOCS       = NO
79SORT_BRIEF_DOCS        = NO
80SORT_MEMBERS_CTORS_1ST = NO
81SORT_GROUP_NAMES       = NO
82SORT_BY_SCOPE_NAME     = NO
83STRICT_PROTO_MATCHING  = NO
84GENERATE_TODOLIST      = NO
85GENERATE_TESTLIST      = NO
86GENERATE_BUGLIST       = NO
87GENERATE_DEPRECATEDLIST= NO
88ENABLED_SECTIONS       = 
89MAX_INITIALIZER_LINES  = 30
90SHOW_USED_FILES        = YES
91SHOW_FILES             = YES
92SHOW_NAMESPACES        = YES
93FILE_VERSION_FILTER    = 
94LAYOUT_FILE            = doxygen_layout_warp_docs.xml
95CITE_BIB_FILES         = 
96
97#---------------------------------------------------------------------------
98# configuration options related to warning and progress messages
99#---------------------------------------------------------------------------
100QUIET                  = NO
101WARNINGS               = YES
102WARN_IF_UNDOCUMENTED   = YES
103WARN_IF_DOC_ERROR      = YES
104WARN_NO_PARAMDOC       = NO
105WARN_FORMAT            = "$file:$line: $text"
106WARN_LOGFILE           = 
107
108#---------------------------------------------------------------------------
109# configuration options related to the input files
110#---------------------------------------------------------------------------
111INPUT                  = 
112INPUT_ENCODING         = UTF-8
113FILE_PATTERNS          = *.c \
114                         *.cc \
115                         *.cxx \
116                         *.cpp \
117                         *.c++ \
118                         *.d \
119                         *.java \
120                         *.ii \
121                         *.ixx \
122                         *.ipp \
123                         *.i++ \
124                         *.inl \
125                         *.h \
126                         *.hh \
127                         *.hxx \
128                         *.hpp \
129                         *.h++ \
130                         *.idl \
131                         *.odl \
132                         *.cs \
133                         *.php \
134                         *.php3 \
135                         *.inc \
136                         *.m \
137                         *.markdown \
138                         *.md \
139                         *.mm \
140                         *.dox \
141                         *.py \
142                         *.f90 \
143                         *.f \
144                         *.for \
145                         *.vhd \
146                         *.vhdl
147RECURSIVE              = NO
148EXCLUDE                = 
149EXCLUDE_SYMLINKS       = NO
150EXCLUDE_PATTERNS       = 
151EXCLUDE_SYMBOLS        = 
152EXAMPLE_PATH           = 
153EXAMPLE_PATTERNS       = *
154EXAMPLE_RECURSIVE      = NO
155IMAGE_PATH             = 
156INPUT_FILTER           = 
157FILTER_PATTERNS        = 
158FILTER_SOURCE_FILES    = NO
159FILTER_SOURCE_PATTERNS = 
160
161#---------------------------------------------------------------------------
162# configuration options related to source browsing
163#---------------------------------------------------------------------------
164SOURCE_BROWSER         = NO
165INLINE_SOURCES         = NO
166STRIP_CODE_COMMENTS    = YES
167REFERENCED_BY_RELATION = NO
168REFERENCES_RELATION    = NO
169REFERENCES_LINK_SOURCE = YES
170USE_HTAGS              = NO
171VERBATIM_HEADERS       = NO
172
173#---------------------------------------------------------------------------
174# configuration options related to the alphabetical class index
175#---------------------------------------------------------------------------
176ALPHABETICAL_INDEX     = NO
177COLS_IN_ALPHA_INDEX    = 5
178IGNORE_PREFIX          = 
179
180#---------------------------------------------------------------------------
181# configuration options related to the HTML output
182#---------------------------------------------------------------------------
183GENERATE_HTML          = YES
184HTML_OUTPUT            = html
185HTML_FILE_EXTENSION    = .html
186HTML_HEADER            = 
187HTML_FOOTER            = 
188HTML_STYLESHEET        = 
189HTML_EXTRA_FILES       = 
190HTML_COLORSTYLE_HUE    = 220
191HTML_COLORSTYLE_SAT    = 100
192HTML_COLORSTYLE_GAMMA  = 80
193HTML_TIMESTAMP         = YES
194HTML_DYNAMIC_SECTIONS  = NO
195HTML_INDEX_NUM_ENTRIES = 100
196GENERATE_DOCSET        = NO
197DOCSET_FEEDNAME        = "Doxygen generated docs"
198DOCSET_BUNDLE_ID       = org.doxygen.Project
199DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
200DOCSET_PUBLISHER_NAME  = Publisher
201GENERATE_HTMLHELP      = NO
202CHM_FILE               = 
203HHC_LOCATION           = 
204GENERATE_CHI           = NO
205CHM_INDEX_ENCODING     = 
206BINARY_TOC             = NO
207TOC_EXPAND             = NO
208GENERATE_QHP           = NO
209QCH_FILE               = 
210QHP_NAMESPACE          = org.doxygen.Project
211QHP_VIRTUAL_FOLDER     = doc
212QHP_CUST_FILTER_NAME   = 
213QHP_CUST_FILTER_ATTRS  = 
214QHP_SECT_FILTER_ATTRS  = 
215QHG_LOCATION           = 
216GENERATE_ECLIPSEHELP   = NO
217ECLIPSE_DOC_ID         = org.doxygen.Project
218DISABLE_INDEX          = NO
219GENERATE_TREEVIEW      = YES
220ENUM_VALUES_PER_LINE   = 4
221TREEVIEW_WIDTH         = 250
222EXT_LINKS_IN_WINDOW    = NO
223FORMULA_FONTSIZE       = 10
224FORMULA_TRANSPARENT    = YES
225USE_MATHJAX            = NO
226MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
227MATHJAX_EXTENSIONS     = 
228SEARCHENGINE           = NO
229SERVER_BASED_SEARCH    = NO
230
231#---------------------------------------------------------------------------
232# configuration options related to the LaTeX output
233#---------------------------------------------------------------------------
234GENERATE_LATEX         = NO
235LATEX_OUTPUT           = latex
236LATEX_CMD_NAME         = latex
237MAKEINDEX_CMD_NAME     = makeindex
238COMPACT_LATEX          = NO
239PAPER_TYPE             = a4
240EXTRA_PACKAGES         = 
241LATEX_HEADER           = 
242LATEX_FOOTER           = 
243PDF_HYPERLINKS         = YES
244USE_PDFLATEX           = YES
245LATEX_BATCHMODE        = NO
246LATEX_HIDE_INDICES     = NO
247LATEX_SOURCE_CODE      = NO
248LATEX_BIB_STYLE        = plain
249
250#---------------------------------------------------------------------------
251# configuration options related to the RTF output
252#---------------------------------------------------------------------------
253GENERATE_RTF           = NO
254RTF_OUTPUT             = rtf
255COMPACT_RTF            = NO
256RTF_HYPERLINKS         = NO
257RTF_STYLESHEET_FILE    = 
258RTF_EXTENSIONS_FILE    = 
259
260#---------------------------------------------------------------------------
261# configuration options related to the man page output
262#---------------------------------------------------------------------------
263GENERATE_MAN           = NO
264MAN_OUTPUT             = man
265MAN_EXTENSION          = .3
266MAN_LINKS              = NO
267
268#---------------------------------------------------------------------------
269# configuration options related to the XML output
270#---------------------------------------------------------------------------
271GENERATE_XML           = NO
272XML_OUTPUT             = xml
273XML_SCHEMA             = 
274XML_DTD                = 
275XML_PROGRAMLISTING     = YES
276
277#---------------------------------------------------------------------------
278# configuration options for the AutoGen Definitions output
279#---------------------------------------------------------------------------
280GENERATE_AUTOGEN_DEF   = NO
281
282#---------------------------------------------------------------------------
283# configuration options related to the Perl module output
284#---------------------------------------------------------------------------
285GENERATE_PERLMOD       = NO
286PERLMOD_LATEX          = NO
287PERLMOD_PRETTY         = YES
288PERLMOD_MAKEVAR_PREFIX = 
289
290#---------------------------------------------------------------------------
291# Configuration options related to the preprocessor
292#---------------------------------------------------------------------------
293ENABLE_PREPROCESSING   = YES
294MACRO_EXPANSION        = NO
295EXPAND_ONLY_PREDEF     = YES
296SEARCH_INCLUDES        = YES
297INCLUDE_PATH           = 
298INCLUDE_FILE_PATTERNS  = 
299PREDEFINED             = 
300EXPAND_AS_DEFINED      = 
301SKIP_FUNCTION_MACROS   = YES
302
303#---------------------------------------------------------------------------
304# Configuration::additions related to external references
305#---------------------------------------------------------------------------
306TAGFILES               = 
307GENERATE_TAGFILE       = 
308ALLEXTERNALS           = NO
309EXTERNAL_GROUPS        = YES
310PERL_PATH              = /usr/bin/perl
311
312#---------------------------------------------------------------------------
313# Configuration options related to the dot tool
314#---------------------------------------------------------------------------
315CLASS_DIAGRAMS         = NO
316MSCGEN_PATH            = 
317HIDE_UNDOC_RELATIONS   = YES
318HAVE_DOT               = NO
319DOT_NUM_THREADS        = 0
320DOT_FONTNAME           = Helvetica
321DOT_FONTSIZE           = 10
322DOT_FONTPATH           = 
323CLASS_GRAPH            = YES
324COLLABORATION_GRAPH    = YES
325GROUP_GRAPHS           = YES
326UML_LOOK               = NO
327UML_LIMIT_NUM_FIELDS   = 10
328TEMPLATE_RELATIONS     = NO
329INCLUDE_GRAPH          = YES
330INCLUDED_BY_GRAPH      = YES
331CALL_GRAPH             = NO
332CALLER_GRAPH           = NO
333GRAPHICAL_HIERARCHY    = YES
334DIRECTORY_GRAPH        = YES
335DOT_IMAGE_FORMAT       = png
336INTERACTIVE_SVG        = NO
337DOT_PATH               = 
338DOTFILE_DIRS           = 
339MSCFILE_DIRS           = 
340DOT_GRAPH_MAX_NODES    = 50
341MAX_DOT_GRAPH_DEPTH    = 0
342DOT_TRANSPARENT        = NO
343DOT_MULTI_TARGETS      = NO
344GENERATE_LEGEND        = YES
345DOT_CLEANUP            = YES
Note: See TracBrowser for help on using the repository browser.