Added a ReadableList for Exits (e.g., [north west south] instead of a table listing.
[UnsignedByte.git] / Doxyfile
blobe99728ff64f5fcf66d71c504cf38dd638ed1db54
1 # Doxyfile 1.5.3
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           = UnsignedByte
8 PROJECT_NUMBER         = 2008-06-04
9 OUTPUT_DIRECTORY       = doc/
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      = YES
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    = YES
42 CPP_CLI_SUPPORT        = NO
43 DISTRIBUTE_GROUP_DOC   = NO
44 SUBGROUPING            = YES
45 #---------------------------------------------------------------------------
46 # Build related configuration options
47 #---------------------------------------------------------------------------
48 EXTRACT_ALL            = NO
49 EXTRACT_PRIVATE        = NO
50 EXTRACT_STATIC         = NO
51 EXTRACT_LOCAL_CLASSES  = YES
52 EXTRACT_LOCAL_METHODS  = NO
53 EXTRACT_ANON_NSPACES   = NO
54 HIDE_UNDOC_MEMBERS     = YES
55 HIDE_UNDOC_CLASSES     = YES
56 HIDE_FRIEND_COMPOUNDS  = NO
57 HIDE_IN_BODY_DOCS      = NO
58 INTERNAL_DOCS          = NO
59 CASE_SENSE_NAMES       = YES
60 HIDE_SCOPE_NAMES       = NO
61 SHOW_INCLUDE_FILES     = YES
62 INLINE_INFO            = YES
63 SORT_MEMBER_DOCS       = YES
64 SORT_BRIEF_DOCS        = NO
65 SORT_BY_SCOPE_NAME     = YES
66 GENERATE_TODOLIST      = YES
67 GENERATE_TESTLIST      = YES
68 GENERATE_BUGLIST       = YES
69 GENERATE_DEPRECATEDLIST= YES
70 ENABLED_SECTIONS       = 
71 MAX_INITIALIZER_LINES  = 30
72 SHOW_USED_FILES        = NO
73 SHOW_DIRECTORIES       = NO
74 FILE_VERSION_FILTER    = 
75 #---------------------------------------------------------------------------
76 # configuration options related to warning and progress messages
77 #---------------------------------------------------------------------------
78 QUIET                  = NO
79 WARNINGS               = YES
80 WARN_IF_UNDOCUMENTED   = YES
81 WARN_IF_DOC_ERROR      = YES
82 WARN_NO_PARAMDOC       = NO
83 WARN_FORMAT            = "$file:$line: $text             "
84 WARN_LOGFILE           = Doxygen.log
85 #---------------------------------------------------------------------------
86 # configuration options related to the input files
87 #---------------------------------------------------------------------------
88 INPUT                  = src
89 INPUT_ENCODING         = UTF-8
90 FILE_PATTERNS          = *.h
91 RECURSIVE              = YES
92 EXCLUDE                = src/Sockets \
93                          src/Sqlite3 \
94                          src/TestCases \
95                          src/Resource/sqlite3.h
96 EXCLUDE_SYMLINKS       = NO
97 EXCLUDE_PATTERNS       = 
98 EXCLUDE_SYMBOLS        = 
99 EXAMPLE_PATH           = 
100 EXAMPLE_PATTERNS       = *
101 EXAMPLE_RECURSIVE      = NO
102 IMAGE_PATH             = 
103 INPUT_FILTER           = 
104 FILTER_PATTERNS        = 
105 FILTER_SOURCE_FILES    = NO
106 #---------------------------------------------------------------------------
107 # configuration options related to source browsing
108 #---------------------------------------------------------------------------
109 SOURCE_BROWSER         = YES
110 INLINE_SOURCES         = NO
111 STRIP_CODE_COMMENTS    = YES
112 REFERENCED_BY_RELATION = NO
113 REFERENCES_RELATION    = NO
114 REFERENCES_LINK_SOURCE = NO
115 USE_HTAGS              = NO
116 VERBATIM_HEADERS       = YES
117 #---------------------------------------------------------------------------
118 # configuration options related to the alphabetical class index
119 #---------------------------------------------------------------------------
120 ALPHABETICAL_INDEX     = NO
121 COLS_IN_ALPHA_INDEX    = 5
122 IGNORE_PREFIX          = 
123 #---------------------------------------------------------------------------
124 # configuration options related to the HTML output
125 #---------------------------------------------------------------------------
126 GENERATE_HTML          = YES
127 HTML_OUTPUT            = html
128 HTML_FILE_EXTENSION    = .html
129 HTML_HEADER            = 
130 HTML_FOOTER            = sflogo.inc
131 HTML_STYLESHEET        = 
132 HTML_ALIGN_MEMBERS     = YES
133 GENERATE_HTMLHELP      = NO
134 HTML_DYNAMIC_SECTIONS  = NO
135 CHM_FILE               = 
136 HHC_LOCATION           = 
137 GENERATE_CHI           = NO
138 BINARY_TOC             = NO
139 TOC_EXPAND             = NO
140 DISABLE_INDEX          = NO
141 ENUM_VALUES_PER_LINE   = 4
142 GENERATE_TREEVIEW      = NO
143 TREEVIEW_WIDTH         = 250
144 #---------------------------------------------------------------------------
145 # configuration options related to the LaTeX output
146 #---------------------------------------------------------------------------
147 GENERATE_LATEX         = NO
148 LATEX_OUTPUT           = latex
149 LATEX_CMD_NAME         = latex
150 MAKEINDEX_CMD_NAME     = makeindex
151 COMPACT_LATEX          = NO
152 PAPER_TYPE             = a4wide
153 EXTRA_PACKAGES         = 
154 LATEX_HEADER           = 
155 PDF_HYPERLINKS         = NO
156 USE_PDFLATEX           = NO
157 LATEX_BATCHMODE        = NO
158 LATEX_HIDE_INDICES     = NO
159 #---------------------------------------------------------------------------
160 # configuration options related to the RTF output
161 #---------------------------------------------------------------------------
162 GENERATE_RTF           = NO
163 RTF_OUTPUT             = rtf
164 COMPACT_RTF            = NO
165 RTF_HYPERLINKS         = NO
166 RTF_STYLESHEET_FILE    = 
167 RTF_EXTENSIONS_FILE    = 
168 #---------------------------------------------------------------------------
169 # configuration options related to the man page output
170 #---------------------------------------------------------------------------
171 GENERATE_MAN           = NO
172 MAN_OUTPUT             = man
173 MAN_EXTENSION          = .3
174 MAN_LINKS              = NO
175 #---------------------------------------------------------------------------
176 # configuration options related to the XML output
177 #---------------------------------------------------------------------------
178 GENERATE_XML           = NO
179 XML_OUTPUT             = xml
180 XML_SCHEMA             = 
181 XML_DTD                = 
182 XML_PROGRAMLISTING     = YES
183 #---------------------------------------------------------------------------
184 # configuration options for the AutoGen Definitions output
185 #---------------------------------------------------------------------------
186 GENERATE_AUTOGEN_DEF   = NO
187 #---------------------------------------------------------------------------
188 # configuration options related to the Perl module output
189 #---------------------------------------------------------------------------
190 GENERATE_PERLMOD       = NO
191 PERLMOD_LATEX          = NO
192 PERLMOD_PRETTY         = YES
193 PERLMOD_MAKEVAR_PREFIX = 
194 #---------------------------------------------------------------------------
195 # Configuration options related to the preprocessor   
196 #---------------------------------------------------------------------------
197 ENABLE_PREPROCESSING   = YES
198 MACRO_EXPANSION        = NO
199 EXPAND_ONLY_PREDEF     = NO
200 SEARCH_INCLUDES        = YES
201 INCLUDE_PATH           = 
202 INCLUDE_FILE_PATTERNS  = 
203 PREDEFINED             = 
204 EXPAND_AS_DEFINED      = 
205 SKIP_FUNCTION_MACROS   = YES
206 #---------------------------------------------------------------------------
207 # Configuration::additions related to external references   
208 #---------------------------------------------------------------------------
209 TAGFILES               = 
210 GENERATE_TAGFILE       = 
211 ALLEXTERNALS           = NO
212 EXTERNAL_GROUPS        = YES
213 PERL_PATH              = /usr/bin/perl
214 #---------------------------------------------------------------------------
215 # Configuration options related to the dot tool   
216 #---------------------------------------------------------------------------
217 CLASS_DIAGRAMS         = NO
218 MSCGEN_PATH            = 
219 HIDE_UNDOC_RELATIONS   = YES
220 HAVE_DOT               = YES
221 CLASS_GRAPH            = YES
222 COLLABORATION_GRAPH    = NO
223 GROUP_GRAPHS           = YES
224 UML_LOOK               = NO
225 TEMPLATE_RELATIONS     = NO
226 INCLUDE_GRAPH          = NO
227 INCLUDED_BY_GRAPH      = NO
228 CALL_GRAPH             = NO
229 CALLER_GRAPH           = NO
230 GRAPHICAL_HIERARCHY    = YES
231 DIRECTORY_GRAPH        = NO
232 DOT_IMAGE_FORMAT       = png
233 DOT_PATH               = 
234 DOTFILE_DIRS           = 
235 DOT_GRAPH_MAX_NODES    = 50
236 MAX_DOT_GRAPH_DEPTH    = 1000
237 DOT_TRANSPARENT        = NO
238 DOT_MULTI_TARGETS      = NO
239 GENERATE_LEGEND        = YES
240 DOT_CLEANUP            = YES
241 #---------------------------------------------------------------------------
242 # Configuration::additions related to the search engine   
243 #---------------------------------------------------------------------------
244 SEARCHENGINE           = NO