Subversion Repositories HelenOS-doc

Rev

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