xref: /reactos/modules/rosapps/Doxyfile (revision d6eebaa4)
1# Doxyfile 1.3.5
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME           = "ROSApps"
7PROJECT_NUMBER         =
8OUTPUT_DIRECTORY       = doxy-doc
9OUTPUT_LANGUAGE        = English
10USE_WINDOWS_ENCODING   = YES
11BRIEF_MEMBER_DESC      = YES
12REPEAT_BRIEF           = YES
13ALWAYS_DETAILED_SEC    = NO
14INLINE_INHERITED_MEMB  = NO
15FULL_PATH_NAMES        = YES
16STRIP_FROM_PATH        = D:\osexperts\
17SHORT_NAMES            = NO
18JAVADOC_AUTOBRIEF      = YES
19MULTILINE_CPP_IS_BRIEF = NO
20DETAILS_AT_TOP         = NO
21INHERIT_DOCS           = NO
22DISTRIBUTE_GROUP_DOC   = NO
23TAB_SIZE               = 8
24ALIASES                =
25OPTIMIZE_OUTPUT_FOR_C  = NO
26OPTIMIZE_OUTPUT_JAVA   = NO
27SUBGROUPING            = YES
28#---------------------------------------------------------------------------
29# Build related configuration options
30#---------------------------------------------------------------------------
31EXTRACT_ALL            = YES
32EXTRACT_PRIVATE        = NO
33EXTRACT_STATIC         = NO
34EXTRACT_LOCAL_CLASSES  = NO
35HIDE_UNDOC_MEMBERS     = NO
36HIDE_UNDOC_CLASSES     = NO
37HIDE_FRIEND_COMPOUNDS  = NO
38HIDE_IN_BODY_DOCS      = NO
39INTERNAL_DOCS          = YES
40CASE_SENSE_NAMES       = YES
41HIDE_SCOPE_NAMES       = NO
42SHOW_INCLUDE_FILES     = YES
43INLINE_INFO            = YES
44SORT_MEMBER_DOCS       = YES
45GENERATE_TODOLIST      = YES
46GENERATE_TESTLIST      = YES
47GENERATE_BUGLIST       = YES
48GENERATE_DEPRECATEDLIST= YES
49ENABLED_SECTIONS       =
50MAX_INITIALIZER_LINES  = 30
51SHOW_USED_FILES        = YES
52#---------------------------------------------------------------------------
53# configuration options related to warning and progress messages
54#---------------------------------------------------------------------------
55QUIET                  = NO
56HAVE_DOT               = YES
57WARN_IF_UNDOCUMENTED   = NO
58WARN_IF_DOC_ERROR      = YES
59WARN_FORMAT            = "$file:$line: $text"
60WARN_LOGFILE           =
61#---------------------------------------------------------------------------
62# configuration options related to the input files
63#---------------------------------------------------------------------------
64INPUT                  = .
65FILE_PATTERNS          = *.c \
66                         *.h
67RECURSIVE              = YES
68EXCLUDE                =
69EXCLUDE_SYMLINKS       = NO
70EXCLUDE_PATTERNS       =
71EXAMPLE_PATH           =
72EXAMPLE_PATTERNS       =
73EXAMPLE_RECURSIVE      = YES
74IMAGE_PATH             =
75INPUT_FILTER           =
76FILTER_SOURCE_FILES    = NO
77#---------------------------------------------------------------------------
78# configuration options related to source browsing
79#---------------------------------------------------------------------------
80SOURCE_BROWSER         = NO
81INLINE_SOURCES         = YES
82STRIP_CODE_COMMENTS    = YES
83REFERENCED_BY_RELATION = YES
84REFERENCES_RELATION    = YES
85VERBATIM_HEADERS       = NO
86#---------------------------------------------------------------------------
87# configuration options related to the alphabetical class index
88#---------------------------------------------------------------------------
89ALPHABETICAL_INDEX     = YES
90COLS_IN_ALPHA_INDEX    = 5
91IGNORE_PREFIX          =
92#---------------------------------------------------------------------------
93# configuration options related to the HTML output
94#---------------------------------------------------------------------------
95GENERATE_HTML          = YES
96HTML_OUTPUT            = html
97HTML_FILE_EXTENSION    = .html
98HTML_HEADER            =
99HTML_FOOTER            =
100HTML_STYLESHEET        =
101HTML_ALIGN_MEMBERS     = YES
102GENERATE_HTMLHELP      = NO
103CHM_FILE               =
104HHC_LOCATION           =
105GENERATE_CHI           = NO
106BINARY_TOC             = NO
107TOC_EXPAND             = NO
108DISABLE_INDEX          = NO
109ENUM_VALUES_PER_LINE   = 4
110GENERATE_TREEVIEW      = YES
111TREEVIEW_WIDTH         = 200
112#---------------------------------------------------------------------------
113# configuration options related to the LaTeX output
114#---------------------------------------------------------------------------
115GENERATE_LATEX         = NO
116LATEX_OUTPUT           = latex
117LATEX_CMD_NAME         = latex
118MAKEINDEX_CMD_NAME     = makeindex
119COMPACT_LATEX          = NO
120PAPER_TYPE             = a4wide
121EXTRA_PACKAGES         =
122LATEX_HEADER           =
123PDF_HYPERLINKS         = NO
124USE_PDFLATEX           = NO
125LATEX_BATCHMODE        = NO
126LATEX_HIDE_INDICES     = NO
127#---------------------------------------------------------------------------
128# configuration options related to the RTF output
129#---------------------------------------------------------------------------
130GENERATE_RTF           = NO
131RTF_OUTPUT             = rtf
132COMPACT_RTF            = YES
133RTF_HYPERLINKS         = YES
134RTF_STYLESHEET_FILE    =
135RTF_EXTENSIONS_FILE    =
136#---------------------------------------------------------------------------
137# configuration options related to the man page output
138#---------------------------------------------------------------------------
139GENERATE_MAN           = NO
140MAN_OUTPUT             = man
141MAN_EXTENSION          = .3
142MAN_LINKS              = NO
143#---------------------------------------------------------------------------
144# configuration options related to the XML output
145#---------------------------------------------------------------------------
146GENERATE_XML           = NO
147XML_OUTPUT             = xml
148XML_SCHEMA             =
149XML_DTD                =
150#---------------------------------------------------------------------------
151# configuration options for the AutoGen Definitions output
152#---------------------------------------------------------------------------
153GENERATE_AUTOGEN_DEF   = NO
154#---------------------------------------------------------------------------
155# configuration options related to the Perl module output
156#---------------------------------------------------------------------------
157GENERATE_PERLMOD       = NO
158PERLMOD_LATEX          = NO
159PERLMOD_PRETTY         = YES
160PERLMOD_MAKEVAR_PREFIX =
161#---------------------------------------------------------------------------
162# Configuration options related to the preprocessor
163#---------------------------------------------------------------------------
164ENABLE_PREPROCESSING   = NO
165MACRO_EXPANSION        = NO
166EXPAND_ONLY_PREDEF     = NO
167SEARCH_INCLUDES        = YES
168INCLUDE_PATH           = ../reactos/include
169INCLUDE_FILE_PATTERNS  = *.h
170PREDEFINED             =
171EXPAND_AS_DEFINED      =
172SKIP_FUNCTION_MACROS   = YES
173#---------------------------------------------------------------------------
174# Configuration::addtions related to external references
175#---------------------------------------------------------------------------
176TAGFILES               =
177GENERATE_TAGFILE       =
178ALLEXTERNALS           = NO
179EXTERNAL_GROUPS        = YES
180PERL_PATH              = /usr/bin/perl
181#---------------------------------------------------------------------------
182# Configuration options related to the dot tool
183#---------------------------------------------------------------------------
184CLASS_DIAGRAMS         = YES
185HIDE_UNDOC_RELATIONS   = NO
186HAVE_DOT               = YES
187CLASS_GRAPH            = YES
188COLLABORATION_GRAPH    = YES
189UML_LOOK               = NO
190TEMPLATE_RELATIONS     = NO
191INCLUDE_GRAPH          = YES
192INCLUDED_BY_GRAPH      = YES
193CALL_GRAPH             = YES
194GRAPHICAL_HIERARCHY    = YES
195DOT_IMAGE_FORMAT       = png
196DOT_PATH               =
197DOTFILE_DIRS           =
198MAX_DOT_GRAPH_WIDTH    = 1024
199MAX_DOT_GRAPH_HEIGHT   = 1024
200MAX_DOT_GRAPH_DEPTH    = 0
201GENERATE_LEGEND        = YES
202DOT_CLEANUP            = YES
203#---------------------------------------------------------------------------
204# Configuration::addtions related to the search engine
205#---------------------------------------------------------------------------
206SEARCHENGINE           = YES
207