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