Subversion Repositories HelenOS-doc

Rev

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