Quarn OS 0.0.90
[quarnos.git] / scripts / Doxyfile
blobc3f9ecad2b59123f08474deab40fe13994716467
1 # Doxyfile 1.5.4
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           = "Quarn OS  "
8 PROJECT_NUMBER         = 0.0.90
9 OUTPUT_DIRECTORY       = Documentation
10 CREATE_SUBDIRS         = NO
11 OUTPUT_LANGUAGE        = English
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
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 QT_AUTOBRIEF           = NO
33 MULTILINE_CPP_IS_BRIEF = NO
34 DETAILS_AT_TOP         = NO
35 INHERIT_DOCS           = YES
36 SEPARATE_MEMBER_PAGES  = NO
37 TAB_SIZE               = 8
38 ALIASES                = 
39 OPTIMIZE_OUTPUT_FOR_C  = NO
40 OPTIMIZE_OUTPUT_JAVA   = NO
41 BUILTIN_STL_SUPPORT    = NO
42 CPP_CLI_SUPPORT        = NO
43 SIP_SUPPORT            = NO
44 DISTRIBUTE_GROUP_DOC   = NO
45 SUBGROUPING            = YES
46 TYPEDEF_HIDES_STRUCT   = NO
47 #---------------------------------------------------------------------------
48 # Build related configuration options
49 #---------------------------------------------------------------------------
50 EXTRACT_ALL            = NO
51 EXTRACT_PRIVATE        = YES
52 EXTRACT_STATIC         = YES
53 EXTRACT_LOCAL_CLASSES  = YES
54 EXTRACT_LOCAL_METHODS  = YES
55 EXTRACT_ANON_NSPACES   = NO
56 HIDE_UNDOC_MEMBERS     = YES
57 HIDE_UNDOC_CLASSES     = YES
58 HIDE_FRIEND_COMPOUNDS  = NO
59 HIDE_IN_BODY_DOCS      = NO
60 INTERNAL_DOCS          = NO
61 CASE_SENSE_NAMES       = YES
62 HIDE_SCOPE_NAMES       = NO
63 SHOW_INCLUDE_FILES     = YES
64 INLINE_INFO            = YES
65 SORT_MEMBER_DOCS       = YES
66 SORT_BRIEF_DOCS        = NO
67 SORT_BY_SCOPE_NAME     = NO
68 GENERATE_TODOLIST      = YES
69 GENERATE_TESTLIST      = YES
70 GENERATE_BUGLIST       = YES
71 GENERATE_DEPRECATEDLIST= YES
72 ENABLED_SECTIONS       = 
73 MAX_INITIALIZER_LINES  = 30
74 SHOW_USED_FILES        = YES
75 SHOW_DIRECTORIES       = NO
76 FILE_VERSION_FILTER    = 
77 #---------------------------------------------------------------------------
78 # configuration options related to warning and progress messages
79 #---------------------------------------------------------------------------
80 QUIET                  = NO
81 WARNINGS               = YES
82 WARN_IF_UNDOCUMENTED   = YES
83 WARN_IF_DOC_ERROR      = YES
84 WARN_NO_PARAMDOC       = NO
85 WARN_FORMAT            = "$file:$line: $text  "
86 WARN_LOGFILE           = 
87 #---------------------------------------------------------------------------
88 # configuration options related to the input files
89 #---------------------------------------------------------------------------
90 INPUT                  = .
91 INPUT_ENCODING         = UTF-8
92 FILE_PATTERNS          = *.S \
93                          *.c \
94                          *.cc \
95                          *.cxx \
96                          *.cpp \
97                          *.c++ \
98                          *.d \
99                          *.java \
100                          *.ii \
101                          *.ixx \
102                          *.ipp \
103                          *.i++ \
104                          *.inl \
105                          *.h \
106                          *.hh \
107                          *.hxx \
108                          *.hpp \
109                          *.h++ \
110                          *.idl \
111                          *.odl \
112                          *.cs \
113                          *.php \
114                          *.php3 \
115                          *.inc \
116                          *.m \
117                          *.mm \
118                          *.dox \
119                          *.py \
120                          *.f90 \
121                          *.C \
122                          *.CC \
123                          *.C++ \
124                          *.II \
125                          *.I++ \
126                          *.H \
127                          *.HH \
128                          *.H++ \
129                          *.CS \
130                          *.PHP \
131                          *.PHP3 \
132                          *.M \
133                          *.MM \
134                          *.PY \
135                          *.F90
136 RECURSIVE              = YES
137 EXCLUDE                = 
138 EXCLUDE_SYMLINKS       = NO
139 EXCLUDE_PATTERNS       = 
140 EXCLUDE_SYMBOLS        = 
141 EXAMPLE_PATH           = 
142 EXAMPLE_PATTERNS       = *
143 EXAMPLE_RECURSIVE      = NO
144 IMAGE_PATH             = 
145 INPUT_FILTER           = 
146 FILTER_PATTERNS        = 
147 FILTER_SOURCE_FILES    = NO
148 #---------------------------------------------------------------------------
149 # configuration options related to source browsing
150 #---------------------------------------------------------------------------
151 SOURCE_BROWSER         = YES
152 INLINE_SOURCES         = NO
153 STRIP_CODE_COMMENTS    = YES
154 REFERENCED_BY_RELATION = YES
155 REFERENCES_RELATION    = YES
156 REFERENCES_LINK_SOURCE = YES
157 USE_HTAGS              = NO
158 VERBATIM_HEADERS       = YES
159 #---------------------------------------------------------------------------
160 # configuration options related to the alphabetical class index
161 #---------------------------------------------------------------------------
162 ALPHABETICAL_INDEX     = YES
163 COLS_IN_ALPHA_INDEX    = 5
164 IGNORE_PREFIX          = 
165 #---------------------------------------------------------------------------
166 # configuration options related to the HTML output
167 #---------------------------------------------------------------------------
168 GENERATE_HTML          = YES
169 HTML_OUTPUT            = html
170 HTML_FILE_EXTENSION    = .html
171 HTML_HEADER            =
172 HTML_FOOTER            = scripts/foot.html
173 HTML_STYLESHEET        = scripts/doxygen.css
174 HTML_ALIGN_MEMBERS     = YES
175 GENERATE_HTMLHELP      = NO
176 HTML_DYNAMIC_SECTIONS  = NO
177 CHM_FILE               = 
178 HHC_LOCATION           = 
179 GENERATE_CHI           = NO
180 BINARY_TOC             = NO
181 TOC_EXPAND             = NO
182 DISABLE_INDEX          = NO
183 ENUM_VALUES_PER_LINE   = 4
184 GENERATE_TREEVIEW      = NO
185 TREEVIEW_WIDTH         = 250
186 #---------------------------------------------------------------------------
187 # configuration options related to the LaTeX output
188 #---------------------------------------------------------------------------
189 GENERATE_LATEX         = YES
190 LATEX_OUTPUT           = latex
191 LATEX_CMD_NAME         = latex
192 MAKEINDEX_CMD_NAME     = makeindex
193 COMPACT_LATEX          = NO
194 PAPER_TYPE             = a4wide
195 EXTRA_PACKAGES         = 
196 LATEX_HEADER           = 
197 PDF_HYPERLINKS         = NO
198 USE_PDFLATEX           = NO
199 LATEX_BATCHMODE        = NO
200 LATEX_HIDE_INDICES     = NO
201 #---------------------------------------------------------------------------
202 # configuration options related to the RTF output
203 #---------------------------------------------------------------------------
204 GENERATE_RTF           = NO
205 RTF_OUTPUT             = rtf
206 COMPACT_RTF            = NO
207 RTF_HYPERLINKS         = NO
208 RTF_STYLESHEET_FILE    = 
209 RTF_EXTENSIONS_FILE    = 
210 #---------------------------------------------------------------------------
211 # configuration options related to the man page output
212 #---------------------------------------------------------------------------
213 GENERATE_MAN           = NO
214 MAN_OUTPUT             = man
215 MAN_EXTENSION          = .3
216 MAN_LINKS              = NO
217 #---------------------------------------------------------------------------
218 # configuration options related to the XML output
219 #---------------------------------------------------------------------------
220 GENERATE_XML           = NO
221 XML_OUTPUT             = xml
222 XML_SCHEMA             = 
223 XML_DTD                = 
224 XML_PROGRAMLISTING     = YES
225 #---------------------------------------------------------------------------
226 # configuration options for the AutoGen Definitions output
227 #---------------------------------------------------------------------------
228 GENERATE_AUTOGEN_DEF   = NO
229 #---------------------------------------------------------------------------
230 # configuration options related to the Perl module output
231 #---------------------------------------------------------------------------
232 GENERATE_PERLMOD       = NO
233 PERLMOD_LATEX          = NO
234 PERLMOD_PRETTY         = YES
235 PERLMOD_MAKEVAR_PREFIX = 
236 #---------------------------------------------------------------------------
237 # Configuration options related to the preprocessor   
238 #---------------------------------------------------------------------------
239 ENABLE_PREPROCESSING   = YES
240 MACRO_EXPANSION        = NO
241 EXPAND_ONLY_PREDEF     = NO
242 SEARCH_INCLUDES        = YES
243 INCLUDE_PATH           = 
244 INCLUDE_FILE_PATTERNS  = 
245 PREDEFINED             = 
246 EXPAND_AS_DEFINED      = 
247 SKIP_FUNCTION_MACROS   = YES
248 #---------------------------------------------------------------------------
249 # Configuration::additions related to external references   
250 #---------------------------------------------------------------------------
251 TAGFILES               = 
252 GENERATE_TAGFILE       = 
253 ALLEXTERNALS           = NO
254 EXTERNAL_GROUPS        = YES
255 PERL_PATH              = /usr/bin/perl
256 #---------------------------------------------------------------------------
257 # Configuration options related to the dot tool   
258 #---------------------------------------------------------------------------
259 CLASS_DIAGRAMS         = YES
260 MSCGEN_PATH            = 
261 HIDE_UNDOC_RELATIONS   = YES
262 HAVE_DOT               = YES
263 CLASS_GRAPH            = YES
264 COLLABORATION_GRAPH    = YES
265 GROUP_GRAPHS           = YES
266 UML_LOOK               = NO
267 TEMPLATE_RELATIONS     = NO
268 INCLUDE_GRAPH          = YES
269 INCLUDED_BY_GRAPH      = YES
270 CALL_GRAPH             = NO
271 CALLER_GRAPH           = NO
272 GRAPHICAL_HIERARCHY    = YES
273 DIRECTORY_GRAPH        = YES
274 DOT_IMAGE_FORMAT       = png
275 DOT_PATH               = 
276 DOTFILE_DIRS           = 
277 DOT_GRAPH_MAX_NODES    = 
278 MAX_DOT_GRAPH_DEPTH    = 
279 DOT_TRANSPARENT        = YES
280 DOT_MULTI_TARGETS      = NO
281 GENERATE_LEGEND        = YES
282 DOT_CLEANUP            = YES
283 #---------------------------------------------------------------------------
284 # Configuration::additions related to the search engine   
285 #---------------------------------------------------------------------------
286 SEARCHENGINE           = NO