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 (ia64)"
7
PROJECT_NUMBER         = "0.2.0"
8
OUTPUT_DIRECTORY       = $(DOCDIR)/doc/uspace-ia64
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       = ia64
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/ia64 \
89
			 $(SRCDIR)/uspace/kbd/include \
90
			 $(SRCDIR)/uspace/kbd/generic \
91
			 $(SRCDIR)/uspace/klog \
92
			 $(SRCDIR)/uspace/libc/arch/ia64 \
93
			 $(SRCDIR)/uspace/libc/include \
94
			 $(SRCDIR)/uspace/libc/generic \
95
			 $(SRCDIR)/uspace/libc/malloc \
96
			 $(SRCDIR)/uspace/ns \
97
			 $(SRCDIR)/uspace/softfloat/arch/ia64 \
98
			 $(SRCDIR)/uspace/softfloat/include \
99
			 $(SRCDIR)/uspace/softfloat/generic \
100
			 $(SRCDIR)/uspace/softint
101
FILE_PATTERNS          = *.c \
102
                         *.h
103
RECURSIVE              = YES
104
EXCLUDE                =
105
EXCLUDE_SYMLINKS       = YES
106
EXCLUDE_PATTERNS       = *ega* \
107
			 fb.[ch] \
108
			 *font* \
109
			 *libpci*
110
 
111
EXAMPLE_PATH           = 
112
EXAMPLE_PATTERNS       = *
113
EXAMPLE_RECURSIVE      = NO
114
IMAGE_PATH             = 
115
INPUT_FILTER           = 
116
FILTER_PATTERNS        = 
117
FILTER_SOURCE_FILES    = NO
118
#---------------------------------------------------------------------------
119
# configuration options related to source browsing
120
#---------------------------------------------------------------------------
170 jermar 121
SOURCE_BROWSER         = NO
167 jermar 122
INLINE_SOURCES         = NO
123
STRIP_CODE_COMMENTS    = YES
170 jermar 124
REFERENCED_BY_RELATION = NO
125
REFERENCES_RELATION    = NO
167 jermar 126
VERBATIM_HEADERS       = NO
127
#---------------------------------------------------------------------------
128
# configuration options related to the alphabetical class index
129
#---------------------------------------------------------------------------
130
ALPHABETICAL_INDEX     = YES
131
COLS_IN_ALPHA_INDEX    = 5
132
IGNORE_PREFIX          = 
133
#---------------------------------------------------------------------------
134
# configuration options related to the HTML output
135
#---------------------------------------------------------------------------
136
GENERATE_HTML          = YES
137
HTML_OUTPUT            = html
138
HTML_FILE_EXTENSION    = .html
139
HTML_HEADER            = 
140
HTML_FOOTER            = 
141
HTML_STYLESHEET        = 
142
HTML_ALIGN_MEMBERS     = YES
143
GENERATE_HTMLHELP      = NO
144
CHM_FILE               = 
145
HHC_LOCATION           = 
146
GENERATE_CHI           = NO
147
BINARY_TOC             = NO
148
TOC_EXPAND             = NO
149
DISABLE_INDEX          = NO
150
ENUM_VALUES_PER_LINE   = 4
170 jermar 151
GENERATE_TREEVIEW      = NO
167 jermar 152
TREEVIEW_WIDTH         = 250
153
#---------------------------------------------------------------------------
154
# configuration options related to the LaTeX output
155
#---------------------------------------------------------------------------
156
GENERATE_LATEX         = NO
157
LATEX_OUTPUT           = latex
158
LATEX_CMD_NAME         = latex
159
MAKEINDEX_CMD_NAME     = makeindex
160
COMPACT_LATEX          = NO
161
PAPER_TYPE             = a4wide
162
EXTRA_PACKAGES         = 
163
LATEX_HEADER           = 
164
PDF_HYPERLINKS         = YES
165
USE_PDFLATEX           = YES
166
LATEX_BATCHMODE        = NO
167
LATEX_HIDE_INDICES     = NO
168
#---------------------------------------------------------------------------
169
# configuration options related to the RTF output
170
#---------------------------------------------------------------------------
171
GENERATE_RTF           = NO
172
RTF_OUTPUT             = rtf
173
COMPACT_RTF            = NO
174
RTF_HYPERLINKS         = NO
175
RTF_STYLESHEET_FILE    = 
176
RTF_EXTENSIONS_FILE    = 
177
#---------------------------------------------------------------------------
178
# configuration options related to the man page output
179
#---------------------------------------------------------------------------
180
GENERATE_MAN           = NO
181
MAN_OUTPUT             = man
182
MAN_EXTENSION          = .2
183
MAN_LINKS              = YES
184
#---------------------------------------------------------------------------
185
# configuration options related to the XML output
186
#---------------------------------------------------------------------------
187
GENERATE_XML           = NO
188
XML_OUTPUT             = xml
189
XML_SCHEMA             = 
190
XML_DTD                = 
191
XML_PROGRAMLISTING     = YES
192
#---------------------------------------------------------------------------
193
# configuration options for the AutoGen Definitions output
194
#---------------------------------------------------------------------------
195
GENERATE_AUTOGEN_DEF   = NO
196
#---------------------------------------------------------------------------
197
# configuration options related to the Perl module output
198
#---------------------------------------------------------------------------
199
GENERATE_PERLMOD       = NO
200
PERLMOD_LATEX          = NO
201
PERLMOD_PRETTY         = YES
202
PERLMOD_MAKEVAR_PREFIX = 
203
#---------------------------------------------------------------------------
204
# Configuration options related to the preprocessor   
205
#---------------------------------------------------------------------------
206
ENABLE_PREPROCESSING   = YES
207
MACRO_EXPANSION        = NO
208
EXPAND_ONLY_PREDEF     = NO
209
SEARCH_INCLUDES        = YES
210
INCLUDE_PATH           = 
211
INCLUDE_FILE_PATTERNS  = 
212
PREDEFINED             = CONFIG_SMP \
213
			 CONFIG_HT
214
EXPAND_AS_DEFINED      = 
215
SKIP_FUNCTION_MACROS   = NO
216
#---------------------------------------------------------------------------
217
# Configuration::additions related to external references   
218
#---------------------------------------------------------------------------
219
TAGFILES               = 
220
GENERATE_TAGFILE       = 
221
ALLEXTERNALS           = NO
222
EXTERNAL_GROUPS        = YES
223
PERL_PATH              = /usr/bin/perl
224
#---------------------------------------------------------------------------
225
# Configuration options related to the dot tool   
226
#---------------------------------------------------------------------------
170 jermar 227
CLASS_DIAGRAMS         = NO
167 jermar 228
HIDE_UNDOC_RELATIONS   = YES
229
HAVE_DOT               = $(DOT)
230
CLASS_GRAPH            = NO
231
COLLABORATION_GRAPH    = NO
232
GROUP_GRAPHS           = NO
233
UML_LOOK               = NO
234
TEMPLATE_RELATIONS     = NO
235
INCLUDE_GRAPH          = YES
236
INCLUDED_BY_GRAPH      = YES
237
CALL_GRAPH             = YES
170 jermar 238
GRAPHICAL_HIERARCHY    = NO
167 jermar 239
DIRECTORY_GRAPH        = NO
240
DOT_IMAGE_FORMAT       = png
241
DOT_PATH               = 
242
DOTFILE_DIRS           = 
243
MAX_DOT_GRAPH_WIDTH    = 1024
244
MAX_DOT_GRAPH_HEIGHT   = 1024
245
MAX_DOT_GRAPH_DEPTH    = 1000
246
DOT_TRANSPARENT        = NO
247
DOT_MULTI_TARGETS      = NO
248
GENERATE_LEGEND        = YES
249
DOT_CLEANUP            = YES
250
#---------------------------------------------------------------------------
251
# Configuration::additions related to the search engine   
252
#---------------------------------------------------------------------------
253
SEARCHENGINE           = NO