Subversion Repositories HelenOS-doc

Rev

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

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