1b741800eebb4d4124f640b4941bca83e5eef96f
[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 = hal \
65 subsys \
66 services \
67 regtests \
68 iface
69 FILE_PATTERNS = *.c \
70 *.h
71 RECURSIVE = YES
72 EXCLUDE = subsys/win32k \
73 subsys/system/explorer
74 EXCLUDE_SYMLINKS = NO
75 EXCLUDE_PATTERNS =
76 EXAMPLE_PATH =
77 EXAMPLE_PATTERNS =
78 EXAMPLE_RECURSIVE = YES
79 IMAGE_PATH =
80 INPUT_FILTER =
81 FILTER_SOURCE_FILES = NO
82 #---------------------------------------------------------------------------
83 # configuration options related to source browsing
84 #---------------------------------------------------------------------------
85 SOURCE_BROWSER = NO
86 INLINE_SOURCES = YES
87 STRIP_CODE_COMMENTS = YES
88 REFERENCED_BY_RELATION = YES
89 REFERENCES_RELATION = YES
90 VERBATIM_HEADERS = NO
91 #---------------------------------------------------------------------------
92 # configuration options related to the alphabetical class index
93 #---------------------------------------------------------------------------
94 ALPHABETICAL_INDEX = YES
95 COLS_IN_ALPHA_INDEX = 5
96 IGNORE_PREFIX =
97 #---------------------------------------------------------------------------
98 # configuration options related to the HTML output
99 #---------------------------------------------------------------------------
100 GENERATE_HTML = YES
101 HTML_OUTPUT = html
102 HTML_FILE_EXTENSION = .html
103 HTML_HEADER =
104 HTML_FOOTER =
105 HTML_STYLESHEET =
106 HTML_ALIGN_MEMBERS = YES
107 GENERATE_HTMLHELP = NO
108 CHM_FILE =
109 HHC_LOCATION =
110 GENERATE_CHI = NO
111 BINARY_TOC = NO
112 TOC_EXPAND = NO
113 DISABLE_INDEX = NO
114 ENUM_VALUES_PER_LINE = 4
115 GENERATE_TREEVIEW = YES
116 TREEVIEW_WIDTH = 250
117 #---------------------------------------------------------------------------
118 # configuration options related to the LaTeX output
119 #---------------------------------------------------------------------------
120 GENERATE_LATEX = NO
121 LATEX_OUTPUT = latex
122 LATEX_CMD_NAME = latex
123 MAKEINDEX_CMD_NAME = makeindex
124 COMPACT_LATEX = NO
125 PAPER_TYPE = a4wide
126 EXTRA_PACKAGES =
127 LATEX_HEADER =
128 PDF_HYPERLINKS = NO
129 USE_PDFLATEX = NO
130 LATEX_BATCHMODE = NO
131 LATEX_HIDE_INDICES = NO
132 #---------------------------------------------------------------------------
133 # configuration options related to the RTF output
134 #---------------------------------------------------------------------------
135 GENERATE_RTF = NO
136 RTF_OUTPUT = rtf
137 COMPACT_RTF = YES
138 RTF_HYPERLINKS = YES
139 RTF_STYLESHEET_FILE =
140 RTF_EXTENSIONS_FILE =
141 #---------------------------------------------------------------------------
142 # configuration options related to the man page output
143 #---------------------------------------------------------------------------
144 GENERATE_MAN = NO
145 MAN_OUTPUT = man
146 MAN_EXTENSION = .3
147 MAN_LINKS = NO
148 #---------------------------------------------------------------------------
149 # configuration options related to the XML output
150 #---------------------------------------------------------------------------
151 GENERATE_XML = NO
152 XML_OUTPUT = xml
153 XML_SCHEMA =
154 XML_DTD =
155 #---------------------------------------------------------------------------
156 # configuration options for the AutoGen Definitions output
157 #---------------------------------------------------------------------------
158 GENERATE_AUTOGEN_DEF = NO
159 #---------------------------------------------------------------------------
160 # configuration options related to the Perl module output
161 #---------------------------------------------------------------------------
162 GENERATE_PERLMOD = NO
163 PERLMOD_LATEX = NO
164 PERLMOD_PRETTY = YES
165 PERLMOD_MAKEVAR_PREFIX =
166 #---------------------------------------------------------------------------
167 # Configuration options related to the preprocessor
168 #---------------------------------------------------------------------------
169 ENABLE_PREPROCESSING = NO
170 MACRO_EXPANSION = NO
171 EXPAND_ONLY_PREDEF = NO
172 SEARCH_INCLUDES = YES
173 INCLUDE_PATH = include
174 INCLUDE_FILE_PATTERNS = *.h
175 PREDEFINED =
176 EXPAND_AS_DEFINED =
177 SKIP_FUNCTION_MACROS = YES
178 #---------------------------------------------------------------------------
179 # Configuration::addtions related to external references
180 #---------------------------------------------------------------------------
181 TAGFILES =
182 GENERATE_TAGFILE =
183 ALLEXTERNALS = NO
184 EXTERNAL_GROUPS = YES
185 PERL_PATH = /usr/bin/perl
186 #---------------------------------------------------------------------------
187 # Configuration options related to the dot tool
188 #---------------------------------------------------------------------------
189 CLASS_DIAGRAMS = YES
190 HIDE_UNDOC_RELATIONS = NO
191 HAVE_DOT = YES
192 CLASS_GRAPH = YES
193 COLLABORATION_GRAPH = YES
194 UML_LOOK = NO
195 TEMPLATE_RELATIONS = NO
196 INCLUDE_GRAPH = YES
197 INCLUDED_BY_GRAPH = YES
198 CALL_GRAPH = YES
199 GRAPHICAL_HIERARCHY = YES
200 DOT_IMAGE_FORMAT = png
201 DOT_PATH =
202 DOTFILE_DIRS =
203 MAX_DOT_GRAPH_WIDTH = 1024
204 MAX_DOT_GRAPH_HEIGHT = 1024
205 MAX_DOT_GRAPH_DEPTH = 0
206 GENERATE_LEGEND = YES
207 DOT_CLEANUP = YES
208 #---------------------------------------------------------------------------
209 # Configuration::addtions related to the search engine
210 #---------------------------------------------------------------------------
211 SEARCHENGINE = NO