Doxyfile 8.57 KB
Newer Older
1
# Doxyfile 1.3.5
2 3

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