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