Subversion Repositories HelenOS-doc

Rev

Rev 167 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
167 jermar 1
# Doxyfile 1.4.2
2
 
3
#---------------------------------------------------------------------------
4
# Project related configuration options
5
#---------------------------------------------------------------------------
6
PROJECT_NAME           = "HelenOS Userspace (amd64)"
7
PROJECT_NUMBER         = "0.2.0"
8
OUTPUT_DIRECTORY       = $(DOCDIR)/doc/uspace-amd64
9
CREATE_SUBDIRS         = NO
10
OUTPUT_LANGUAGE        = English
11
USE_WINDOWS_ENCODING   = NO
12
BRIEF_MEMBER_DESC      = YES
13
REPEAT_BRIEF           = NO
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      = NO
32
MULTILINE_CPP_IS_BRIEF = NO
33
DETAILS_AT_TOP         = NO
34
INHERIT_DOCS           = NO
35
DISTRIBUTE_GROUP_DOC   = NO
36
SEPARATE_MEMBER_PAGES  = NO
37
TAB_SIZE               = 8
38
ALIASES                = 
39
OPTIMIZE_OUTPUT_FOR_C  = YES
40
OPTIMIZE_OUTPUT_JAVA   = NO
41
SUBGROUPING            = NO
42
#---------------------------------------------------------------------------
43
# Build related configuration options
44
#---------------------------------------------------------------------------
170 jermar 45
EXTRACT_ALL            = NO
167 jermar 46
EXTRACT_PRIVATE        = NO
47
EXTRACT_STATIC         = YES
48
EXTRACT_LOCAL_CLASSES  = YES
49
EXTRACT_LOCAL_METHODS  = YES
50
HIDE_UNDOC_MEMBERS     = YES
51
HIDE_UNDOC_CLASSES     = YES
52
HIDE_FRIEND_COMPOUNDS  = NO
53
HIDE_IN_BODY_DOCS      = NO
54
INTERNAL_DOCS          = NO
55
CASE_SENSE_NAMES       = YES
56
HIDE_SCOPE_NAMES       = YES
57
SHOW_INCLUDE_FILES     = NO
58
INLINE_INFO            = NO
59
SORT_MEMBER_DOCS       = NO
60
SORT_BRIEF_DOCS        = NO
61
SORT_BY_SCOPE_NAME     = NO
170 jermar 62
GENERATE_TODOLIST      = YES
167 jermar 63
GENERATE_TESTLIST      = NO
170 jermar 64
GENERATE_BUGLIST       = YES
167 jermar 65
GENERATE_DEPRECATEDLIST= NO
66
ENABLED_SECTIONS       = amd64
67
MAX_INITIALIZER_LINES  = 30
68
SHOW_USED_FILES        = NO
69
SHOW_DIRECTORIES       = YES
70
FILE_VERSION_FILTER    = 
71
#---------------------------------------------------------------------------
72
# configuration options related to warning and progress messages
73
#---------------------------------------------------------------------------
74
QUIET                  = NO
75
WARNINGS               = YES
76
WARN_IF_UNDOCUMENTED   = NO
77
WARN_IF_DOC_ERROR      = YES
78
WARN_NO_PARAMDOC       = NO
79
WARN_FORMAT            = "$file:$line: $text"
80
WARN_LOGFILE           = 
81
#---------------------------------------------------------------------------
82
# configuration options related to the input files
83
#---------------------------------------------------------------------------
84
INPUT                  = $(SRCDIR)/uspace/doc \
85
			 $(SRCDIR)/uspace/console \
86
			 $(SRCDIR)/uspace/fb \
87
			 $(SRCDIR)/uspace/ipcc \
88
			 $(SRCDIR)/uspace/kbd/arch/amd64 \
89
			 $(SRCDIR)/uspace/kbd/include \
90
			 $(SRCDIR)/uspace/kbd/generic \
91
			 $(SRCDIR)/uspace/klog \
92
			 $(SRCDIR)/uspace/libc/arch/amd64 \
93
			 $(SRCDIR)/uspace/libc/include \
94
			 $(SRCDIR)/uspace/libc/generic \
95
			 $(SRCDIR)/uspace/libc/malloc \
96
			 $(SRCDIR)/uspace/ns \
97
			 $(SRCDIR)/uspace/softfloat/arch/amd64 \
98
			 $(SRCDIR)/uspace/softfloat/include \
99
			 $(SRCDIR)/uspace/softfloat/generic \
100
			 $(SRCDIR)/uspace/softint \
101
			 $(SRCDIR)/uspace/pci
102
FILE_PATTERNS          = *.c \
103
                         *.h
104
RECURSIVE              = YES
105
EXCLUDE                =
106
EXCLUDE_SYMLINKS       = YES
107
EXCLUDE_PATTERNS       = *sysio* \
108
			 *libpci*
109
 
110
EXAMPLE_PATH           = 
111
EXAMPLE_PATTERNS       = *
112
EXAMPLE_RECURSIVE      = NO
113
IMAGE_PATH             = 
114
INPUT_FILTER           = 
115
FILTER_PATTERNS        = 
116
FILTER_SOURCE_FILES    = NO
117
#---------------------------------------------------------------------------
118
# configuration options related to source browsing
119
#---------------------------------------------------------------------------
170 jermar 120
SOURCE_BROWSER         = NO
167 jermar 121
INLINE_SOURCES         = NO
122
STRIP_CODE_COMMENTS    = YES
170 jermar 123
REFERENCED_BY_RELATION = NO
124
REFERENCES_RELATION    = NO
167 jermar 125
VERBATIM_HEADERS       = NO
126
#---------------------------------------------------------------------------
127
# configuration options related to the alphabetical class index
128
#---------------------------------------------------------------------------
129
ALPHABETICAL_INDEX     = YES
130
COLS_IN_ALPHA_INDEX    = 5
131
IGNORE_PREFIX          = 
132
#---------------------------------------------------------------------------
133
# configuration options related to the HTML output
134
#---------------------------------------------------------------------------
135
GENERATE_HTML          = YES
136
HTML_OUTPUT            = html
137
HTML_FILE_EXTENSION    = .html
138
HTML_HEADER            = 
139
HTML_FOOTER            = 
140
HTML_STYLESHEET        = 
141
HTML_ALIGN_MEMBERS     = YES
142
GENERATE_HTMLHELP      = NO
143
CHM_FILE               = 
144
HHC_LOCATION           = 
145
GENERATE_CHI           = NO
146
BINARY_TOC             = NO
147
TOC_EXPAND             = NO
148
DISABLE_INDEX          = NO
149
ENUM_VALUES_PER_LINE   = 4
170 jermar 150
GENERATE_TREEVIEW      = NO
167 jermar 151
TREEVIEW_WIDTH         = 250
152
#---------------------------------------------------------------------------
153
# configuration options related to the LaTeX output
154
#---------------------------------------------------------------------------
155
GENERATE_LATEX         = NO
156
LATEX_OUTPUT           = latex
157
LATEX_CMD_NAME         = latex
158
MAKEINDEX_CMD_NAME     = makeindex
159
COMPACT_LATEX          = NO
160
PAPER_TYPE             = a4wide
161
EXTRA_PACKAGES         = 
162
LATEX_HEADER           = 
163
PDF_HYPERLINKS         = YES
164
USE_PDFLATEX           = YES
165
LATEX_BATCHMODE        = NO
166
LATEX_HIDE_INDICES     = NO
167
#---------------------------------------------------------------------------
168
# configuration options related to the RTF output
169
#---------------------------------------------------------------------------
170
GENERATE_RTF           = NO
171
RTF_OUTPUT             = rtf
172
COMPACT_RTF            = NO
173
RTF_HYPERLINKS         = NO
174
RTF_STYLESHEET_FILE    = 
175
RTF_EXTENSIONS_FILE    = 
176
#---------------------------------------------------------------------------
177
# configuration options related to the man page output
178
#---------------------------------------------------------------------------
179
GENERATE_MAN           = NO
180
MAN_OUTPUT             = man
181
MAN_EXTENSION          = .2
182
MAN_LINKS              = YES
183
#---------------------------------------------------------------------------
184
# configuration options related to the XML output
185
#---------------------------------------------------------------------------
186
GENERATE_XML           = NO
187
XML_OUTPUT             = xml
188
XML_SCHEMA             = 
189
XML_DTD                = 
190
XML_PROGRAMLISTING     = YES
191
#---------------------------------------------------------------------------
192
# configuration options for the AutoGen Definitions output
193
#---------------------------------------------------------------------------
194
GENERATE_AUTOGEN_DEF   = NO
195
#---------------------------------------------------------------------------
196
# configuration options related to the Perl module output
197
#---------------------------------------------------------------------------
198
GENERATE_PERLMOD       = NO
199
PERLMOD_LATEX          = NO
200
PERLMOD_PRETTY         = YES
201
PERLMOD_MAKEVAR_PREFIX = 
202
#---------------------------------------------------------------------------
203
# Configuration options related to the preprocessor   
204
#---------------------------------------------------------------------------
205
ENABLE_PREPROCESSING   = YES
206
MACRO_EXPANSION        = NO
207
EXPAND_ONLY_PREDEF     = NO
208
SEARCH_INCLUDES        = YES
209
INCLUDE_PATH           = 
210
INCLUDE_FILE_PATTERNS  = 
211
PREDEFINED             = CONFIG_SMP \
212
			 CONFIG_HT
213
EXPAND_AS_DEFINED      = 
214
SKIP_FUNCTION_MACROS   = NO
215
#---------------------------------------------------------------------------
216
# Configuration::additions related to external references   
217
#---------------------------------------------------------------------------
218
TAGFILES               = 
219
GENERATE_TAGFILE       = 
220
ALLEXTERNALS           = NO
221
EXTERNAL_GROUPS        = YES
222
PERL_PATH              = /usr/bin/perl
223
#---------------------------------------------------------------------------
224
# Configuration options related to the dot tool   
225
#---------------------------------------------------------------------------
170 jermar 226
CLASS_DIAGRAMS         = NO
167 jermar 227
HIDE_UNDOC_RELATIONS   = YES
228
HAVE_DOT               = $(DOT)
229
CLASS_GRAPH            = NO
230
COLLABORATION_GRAPH    = NO
231
GROUP_GRAPHS           = NO
232
UML_LOOK               = NO
233
TEMPLATE_RELATIONS     = NO
234
INCLUDE_GRAPH          = YES
235
INCLUDED_BY_GRAPH      = YES
236
CALL_GRAPH             = YES
170 jermar 237
GRAPHICAL_HIERARCHY    = NO
167 jermar 238
DIRECTORY_GRAPH        = NO
239
DOT_IMAGE_FORMAT       = png
240
DOT_PATH               = 
241
DOTFILE_DIRS           = 
242
MAX_DOT_GRAPH_WIDTH    = 1024
243
MAX_DOT_GRAPH_HEIGHT   = 1024
244
MAX_DOT_GRAPH_DEPTH    = 1000
245
DOT_TRANSPARENT        = NO
246
DOT_MULTI_TARGETS      = NO
247
GENERATE_LEGEND        = YES
248
DOT_CLEANUP            = YES
249
#---------------------------------------------------------------------------
250
# Configuration::additions related to the search engine   
251
#---------------------------------------------------------------------------
252
SEARCHENGINE           = NO