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