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