Gitiles
Code Review Sign In
review.coreboot.org / coreboot / 4c7eee27447e1a41808a11be8ce55031e97fdccf / . / Documentation / doxygen / Doxyfile.coreboot_platform
blob: a7770bb69da99e8cda818d456a0e9d808ffa0650 [file] [log] [blame]
Martin Rothb1574e32016-07-07 15:50:28 -0600[diff] [blame]1# Doxyfile 1.8.11
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8
7PROJECT_NAME = "coreboot for $(DOXYGEN_PLATFORM)"
8PROJECT_NUMBER =
9PROJECT_BRIEF = "coreboot is an Open Source project aimed at replacing the proprietary BIOS found in most computers."
10PROJECT_LOGO = Documentation/coreboot_logo.png
11OUTPUT_DIRECTORY = $(DOXYGEN_OUTPUT_DIR)
12CREATE_SUBDIRS = YES
13ALLOW_UNICODE_NAMES = NO
14OUTPUT_LANGUAGE = English
15BRIEF_MEMBER_DESC = YES
16REPEAT_BRIEF = YES
17ABBREVIATE_BRIEF =
18ALWAYS_DETAILED_SEC = YES
19INLINE_INHERITED_MEMB = NO
20FULL_PATH_NAMES = YES
21STRIP_FROM_PATH =
22STRIP_FROM_INC_PATH =
23SHORT_NAMES = NO
24JAVADOC_AUTOBRIEF = YES
25QT_AUTOBRIEF = NO
26MULTILINE_CPP_IS_BRIEF = NO
27INHERIT_DOCS = YES
28SEPARATE_MEMBER_PAGES = NO
29TAB_SIZE = 8
30ALIASES =
31TCL_SUBST =
32OPTIMIZE_OUTPUT_FOR_C = YES
33OPTIMIZE_OUTPUT_JAVA = NO
34OPTIMIZE_FOR_FORTRAN = NO
35OPTIMIZE_OUTPUT_VHDL = NO
36EXTENSION_MAPPING =
37MARKDOWN_SUPPORT = YES
38AUTOLINK_SUPPORT = YES
39BUILTIN_STL_SUPPORT = NO
40CPP_CLI_SUPPORT = NO
41SIP_SUPPORT = NO
42IDL_PROPERTY_SUPPORT = YES
43DISTRIBUTE_GROUP_DOC = NO
44GROUP_NESTED_COMPOUNDS = NO
45SUBGROUPING = YES
46INLINE_GROUPED_CLASSES = NO
47INLINE_SIMPLE_STRUCTS = NO
48TYPEDEF_HIDES_STRUCT = NO
49LOOKUP_CACHE_SIZE = 0
50#---------------------------------------------------------------------------
51# Build related configuration options
52#---------------------------------------------------------------------------
53EXTRACT_ALL = YES
54EXTRACT_PRIVATE = NO
55EXTRACT_PACKAGE = NO
56EXTRACT_STATIC = YES
57EXTRACT_LOCAL_CLASSES = YES
58EXTRACT_LOCAL_METHODS = NO
59EXTRACT_ANON_NSPACES = NO
60HIDE_UNDOC_MEMBERS = NO
61HIDE_UNDOC_CLASSES = NO
62HIDE_FRIEND_COMPOUNDS = NO
63HIDE_IN_BODY_DOCS = NO
64INTERNAL_DOCS = NO
65CASE_SENSE_NAMES = YES
66HIDE_SCOPE_NAMES = NO
67HIDE_COMPOUND_REFERENCE= NO
68SHOW_INCLUDE_FILES = YES
69SHOW_GROUPED_MEMB_INC = NO
70FORCE_LOCAL_INCLUDES = NO
71INLINE_INFO = YES
72SORT_MEMBER_DOCS = YES
73SORT_BRIEF_DOCS = NO
74SORT_MEMBERS_CTORS_1ST = NO
75SORT_GROUP_NAMES = NO
76SORT_BY_SCOPE_NAME = NO
77STRICT_PROTO_MATCHING = NO
78GENERATE_TODOLIST = YES
79GENERATE_TESTLIST = YES
80GENERATE_BUGLIST = YES
81GENERATE_DEPRECATEDLIST= YES
82ENABLED_SECTIONS =
83MAX_INITIALIZER_LINES = 30
84SHOW_USED_FILES = YES
85SHOW_FILES = YES
86SHOW_NAMESPACES = YES
87FILE_VERSION_FILTER =
88LAYOUT_FILE =
89CITE_BIB_FILES =
90#---------------------------------------------------------------------------
91# Configuration options related to warning and progress messages
92#---------------------------------------------------------------------------
93QUIET = YES
94WARNINGS = YES
95WARN_IF_UNDOCUMENTED = YES
96WARN_IF_DOC_ERROR = YES
97WARN_NO_PARAMDOC = YES
98WARN_AS_ERROR = NO
99WARN_FORMAT = "$file:$line: $text"
100WARN_LOGFILE =
101#---------------------------------------------------------------------------
102# Configuration options related to the input files
103#---------------------------------------------------------------------------
104INPUT = $(DOXYFILES)
105INPUT_ENCODING = UTF-8
106FILE_PATTERNS =
107RECURSIVE = NO
108EXCLUDE =
109EXCLUDE_SYMLINKS = NO
110EXCLUDE_PATTERNS =
111EXCLUDE_SYMBOLS =
112EXAMPLE_PATH =
113EXAMPLE_PATTERNS =
114EXAMPLE_RECURSIVE = NO
115IMAGE_PATH =
116INPUT_FILTER =
117FILTER_PATTERNS =
118FILTER_SOURCE_FILES = NO
119FILTER_SOURCE_PATTERNS =
120USE_MDFILE_AS_MAINPAGE =
121#---------------------------------------------------------------------------
122# Configuration options related to source browsing
123#---------------------------------------------------------------------------
124SOURCE_BROWSER = YES
125INLINE_SOURCES = NO
126STRIP_CODE_COMMENTS = NO
127REFERENCED_BY_RELATION = YES
128REFERENCES_RELATION = YES
129REFERENCES_LINK_SOURCE = YES
130SOURCE_TOOLTIPS = YES
131USE_HTAGS = NO
132VERBATIM_HEADERS = YES
133CLANG_ASSISTED_PARSING = NO
134CLANG_OPTIONS =
135#---------------------------------------------------------------------------
136# Configuration options related to the alphabetical class index
137#---------------------------------------------------------------------------
138ALPHABETICAL_INDEX = YES
139COLS_IN_ALPHA_INDEX = 5
140IGNORE_PREFIX =
141#---------------------------------------------------------------------------
142# Configuration options related to the HTML output
143#---------------------------------------------------------------------------
144GENERATE_HTML = YES
145HTML_OUTPUT = html
146HTML_FILE_EXTENSION = .html
147HTML_HEADER =
148HTML_FOOTER =
149HTML_STYLESHEET =
150HTML_EXTRA_STYLESHEET =
151HTML_EXTRA_FILES =
152HTML_COLORSTYLE_HUE = 220
153HTML_COLORSTYLE_SAT = 100
154HTML_COLORSTYLE_GAMMA = 80
155HTML_TIMESTAMP = NO
156HTML_DYNAMIC_SECTIONS = NO
157HTML_INDEX_NUM_ENTRIES = 100
158GENERATE_DOCSET = NO
159DOCSET_FEEDNAME = "Doxygen documentation"
160DOCSET_BUNDLE_ID = org.doxygen.Project
161DOCSET_PUBLISHER_ID = org.doxygen.Publisher
162DOCSET_PUBLISHER_NAME = Publisher
163GENERATE_HTMLHELP = NO
164CHM_FILE =
165HHC_LOCATION =
166GENERATE_CHI = NO
167CHM_INDEX_ENCODING =
168BINARY_TOC = NO
169TOC_EXPAND = NO
170GENERATE_QHP = NO
171QCH_FILE =
172QHP_NAMESPACE = org.doxygen.Project
173QHP_VIRTUAL_FOLDER = doc
174QHP_CUST_FILTER_NAME =
175QHP_CUST_FILTER_ATTRS =
176QHP_SECT_FILTER_ATTRS =
177QHG_LOCATION =
178GENERATE_ECLIPSEHELP = NO
179ECLIPSE_DOC_ID = org.doxygen.Project
180DISABLE_INDEX = NO
181GENERATE_TREEVIEW = YES
182ENUM_VALUES_PER_LINE = 4
183TREEVIEW_WIDTH = 250
184EXT_LINKS_IN_WINDOW = NO
185FORMULA_FONTSIZE = 10
186FORMULA_TRANSPARENT = YES
187USE_MATHJAX = NO
188MATHJAX_FORMAT = HTML-CSS
189MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
190MATHJAX_EXTENSIONS =
191MATHJAX_CODEFILE =
192SEARCHENGINE = YES
193SERVER_BASED_SEARCH = NO
194EXTERNAL_SEARCH = NO
195SEARCHENGINE_URL =
196SEARCHDATA_FILE = searchdata.xml
197EXTERNAL_SEARCH_ID =
198EXTRA_SEARCH_MAPPINGS =
199#---------------------------------------------------------------------------
200# Configuration options related to the LaTeX output
201#---------------------------------------------------------------------------
202GENERATE_LATEX = NO
203LATEX_OUTPUT = latex
204LATEX_CMD_NAME = latex
205MAKEINDEX_CMD_NAME = makeindex
206COMPACT_LATEX = NO
207PAPER_TYPE = a4wide
208EXTRA_PACKAGES =
209LATEX_HEADER =
210LATEX_FOOTER =
211LATEX_EXTRA_STYLESHEET =
212LATEX_EXTRA_FILES =
213PDF_HYPERLINKS = NO
214USE_PDFLATEX = NO
215LATEX_BATCHMODE = NO
216LATEX_HIDE_INDICES = NO
217LATEX_SOURCE_CODE = NO
218LATEX_BIB_STYLE = plain
219LATEX_TIMESTAMP = NO
220#---------------------------------------------------------------------------
221# Configuration options related to the RTF output
222#---------------------------------------------------------------------------
223GENERATE_RTF = NO
224RTF_OUTPUT = rtf
225COMPACT_RTF = NO
226RTF_HYPERLINKS = NO
227RTF_STYLESHEET_FILE =
228RTF_EXTENSIONS_FILE =
229RTF_SOURCE_CODE = NO
230#---------------------------------------------------------------------------
231# Configuration options related to the man page output
232#---------------------------------------------------------------------------
233GENERATE_MAN = NO
234MAN_OUTPUT = man
235MAN_EXTENSION = .3
236MAN_SUBDIR =
237MAN_LINKS = NO
238#---------------------------------------------------------------------------
239# Configuration options related to the XML output
240#---------------------------------------------------------------------------
241GENERATE_XML = NO
242XML_OUTPUT = xml
243XML_PROGRAMLISTING = YES
244#---------------------------------------------------------------------------
245# Configuration options related to the DOCBOOK output
246#---------------------------------------------------------------------------
247GENERATE_DOCBOOK = NO
248DOCBOOK_OUTPUT = docbook
249DOCBOOK_PROGRAMLISTING = NO
250#---------------------------------------------------------------------------
251# Configuration options for the AutoGen Definitions output
252#---------------------------------------------------------------------------
253GENERATE_AUTOGEN_DEF = NO
254#---------------------------------------------------------------------------
255# Configuration options related to the Perl module output
256#---------------------------------------------------------------------------
257GENERATE_PERLMOD = NO
258PERLMOD_LATEX = NO
259PERLMOD_PRETTY = YES
260PERLMOD_MAKEVAR_PREFIX =
261#---------------------------------------------------------------------------
262# Configuration options related to the preprocessor
263#---------------------------------------------------------------------------
264ENABLE_PREPROCESSING = YES
265MACRO_EXPANSION = YES
266EXPAND_ONLY_PREDEF = YES
267SEARCH_INCLUDES = YES
268INCLUDE_PATH =
269INCLUDE_FILE_PATTERNS =
270PREDEFINED = __attribute__(x)=
271EXPAND_AS_DEFINED =
272SKIP_FUNCTION_MACROS = YES
273#---------------------------------------------------------------------------
274# Configuration options related to external references
275#---------------------------------------------------------------------------
276TAGFILES =
277GENERATE_TAGFILE =
278ALLEXTERNALS = NO
279EXTERNAL_GROUPS = YES
280EXTERNAL_PAGES = YES
281PERL_PATH = /usr/bin/perl
282#---------------------------------------------------------------------------
283# Configuration options related to the dot tool
284#---------------------------------------------------------------------------
285CLASS_DIAGRAMS = YES
286MSCGEN_PATH =
287DIA_PATH =
288HIDE_UNDOC_RELATIONS = NO
289HAVE_DOT = NO
290DOT_NUM_THREADS = 0
291DOT_FONTNAME = Helvetica
292DOT_FONTSIZE = 10
293DOT_FONTPATH =
294CLASS_GRAPH = YES
295COLLABORATION_GRAPH = YES
296GROUP_GRAPHS = YES
297UML_LOOK = YES
298UML_LIMIT_NUM_FIELDS = 10
299TEMPLATE_RELATIONS = NO
300INCLUDE_GRAPH = YES
301INCLUDED_BY_GRAPH = YES
302CALL_GRAPH = YES
303CALLER_GRAPH = YES
304GRAPHICAL_HIERARCHY = YES
305DIRECTORY_GRAPH = YES
306DOT_IMAGE_FORMAT = png
307INTERACTIVE_SVG = NO
308DOT_PATH =
309DOTFILE_DIRS =
310MSCFILE_DIRS =
311DIAFILE_DIRS =
312PLANTUML_JAR_PATH =
313PLANTUML_INCLUDE_PATH =
314DOT_GRAPH_MAX_NODES = 50
315MAX_DOT_GRAPH_DEPTH = 0
316DOT_TRANSPARENT = NO
317DOT_MULTI_TARGETS = YES
318GENERATE_LEGEND = YES
319DOT_CLEANUP = YES