Subversion Repositories HelenOS-doc

Rev

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

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