Subversion Repositories HelenOS-doc

Rev

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