Subversion Repositories HelenOS-doc

Rev

Rev 22 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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