Fix doxygen comments that were breaking parsing.
[tagua.git] / src / Doxyfile
blobb8447a72ea77792bb769e3c4202e7f92d3fc78b8
1 # Doxyfile 1.5.5
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           = Tagua
8 PROJECT_NUMBER         = 1.0
9 OUTPUT_DIRECTORY       = doxy/en
10 CREATE_SUBDIRS         = NO
11 OUTPUT_LANGUAGE        = English
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
14 ABBREVIATE_BRIEF       = 
15 ALWAYS_DETAILED_SEC    = NO
16 INLINE_INHERITED_MEMB  = NO
17 FULL_PATH_NAMES        = YES
18 STRIP_FROM_PATH        = 
19 STRIP_FROM_INC_PATH    = 
20 SHORT_NAMES            = NO
21 JAVADOC_AUTOBRIEF      = NO
22 QT_AUTOBRIEF           = NO
23 MULTILINE_CPP_IS_BRIEF = NO
24 DETAILS_AT_TOP         = NO
25 INHERIT_DOCS           = YES
26 SEPARATE_MEMBER_PAGES  = NO
27 TAB_SIZE               = 2
28 ALIASES                = 
29 OPTIMIZE_OUTPUT_FOR_C  = NO
30 OPTIMIZE_OUTPUT_JAVA   = NO
31 OPTIMIZE_FOR_FORTRAN   = NO
32 OPTIMIZE_OUTPUT_VHDL   = NO
33 BUILTIN_STL_SUPPORT    = NO
34 CPP_CLI_SUPPORT        = NO
35 SIP_SUPPORT            = NO
36 DISTRIBUTE_GROUP_DOC   = NO
37 SUBGROUPING            = YES
38 TYPEDEF_HIDES_STRUCT   = NO
39 #---------------------------------------------------------------------------
40 # Build related configuration options
41 #---------------------------------------------------------------------------
42 EXTRACT_ALL            = YES
43 EXTRACT_PRIVATE        = YES
44 EXTRACT_STATIC         = YES
45 EXTRACT_LOCAL_CLASSES  = NO
46 EXTRACT_LOCAL_METHODS  = NO
47 EXTRACT_ANON_NSPACES   = YES
48 HIDE_UNDOC_MEMBERS     = YES
49 HIDE_UNDOC_CLASSES     = YES
50 HIDE_FRIEND_COMPOUNDS  = NO
51 HIDE_IN_BODY_DOCS      = NO
52 INTERNAL_DOCS          = NO
53 CASE_SENSE_NAMES       = YES
54 HIDE_SCOPE_NAMES       = NO
55 SHOW_INCLUDE_FILES     = YES
56 INLINE_INFO            = YES
57 SORT_MEMBER_DOCS       = YES
58 SORT_BRIEF_DOCS        = NO
59 SORT_GROUP_NAMES       = NO
60 SORT_BY_SCOPE_NAME     = YES
61 GENERATE_TODOLIST      = YES
62 GENERATE_TESTLIST      = YES
63 GENERATE_BUGLIST       = YES
64 GENERATE_DEPRECATEDLIST= YES
65 ENABLED_SECTIONS       = 
66 MAX_INITIALIZER_LINES  = 30
67 SHOW_USED_FILES        = YES
68 SHOW_DIRECTORIES       = YES
69 FILE_VERSION_FILTER    = 
70 #---------------------------------------------------------------------------
71 # configuration options related to warning and progress messages
72 #---------------------------------------------------------------------------
73 QUIET                  = YES
74 WARNINGS               = YES
75 WARN_IF_UNDOCUMENTED   = YES
76 WARN_IF_DOC_ERROR      = YES
77 WARN_NO_PARAMDOC       = NO
78 WARN_FORMAT            = "$file:$line: $text"
79 WARN_LOGFILE           = 
80 #---------------------------------------------------------------------------
81 # configuration options related to the input files
82 #---------------------------------------------------------------------------
83 INPUT                  = 
84 INPUT_ENCODING         = UTF-8
85 FILE_PATTERNS          = 
86 RECURSIVE              = YES
87 EXCLUDE                = 
88 EXCLUDE_SYMLINKS       = NO
89 EXCLUDE_PATTERNS       = ui_* \
90                          moc_*
91 EXCLUDE_SYMBOLS        = 
92 EXAMPLE_PATH           = 
93 EXAMPLE_PATTERNS       = 
94 EXAMPLE_RECURSIVE      = NO
95 IMAGE_PATH             = 
96 INPUT_FILTER           = 
97 FILTER_PATTERNS        = 
98 FILTER_SOURCE_FILES    = NO
99 #---------------------------------------------------------------------------
100 # configuration options related to source browsing
101 #---------------------------------------------------------------------------
102 SOURCE_BROWSER         = YES
103 INLINE_SOURCES         = NO
104 STRIP_CODE_COMMENTS    = YES
105 REFERENCED_BY_RELATION = YES
106 REFERENCES_RELATION    = YES
107 REFERENCES_LINK_SOURCE = YES
108 USE_HTAGS              = NO
109 VERBATIM_HEADERS       = YES
110 #---------------------------------------------------------------------------
111 # configuration options related to the alphabetical class index
112 #---------------------------------------------------------------------------
113 ALPHABETICAL_INDEX     = YES
114 COLS_IN_ALPHA_INDEX    = 2
115 IGNORE_PREFIX          = 
116 #---------------------------------------------------------------------------
117 # configuration options related to the HTML output
118 #---------------------------------------------------------------------------
119 GENERATE_HTML          = YES
120 HTML_OUTPUT            = html
121 HTML_FILE_EXTENSION    = .html
122 HTML_HEADER            = doxy/header.html
123 HTML_FOOTER            = doxy/footer.html
124 HTML_STYLESHEET        = doxy/doxygen.css
125 HTML_ALIGN_MEMBERS     = YES
126 GENERATE_HTMLHELP      = NO
127 GENERATE_DOCSET        = NO
128 DOCSET_FEEDNAME        = "Doxygen generated docs"
129 DOCSET_BUNDLE_ID       = org.doxygen.Project
130 HTML_DYNAMIC_SECTIONS  = YES
131 CHM_FILE               = 
132 HHC_LOCATION           = 
133 GENERATE_CHI           = NO
134 BINARY_TOC             = NO
135 TOC_EXPAND             = NO
136 DISABLE_INDEX          = YES
137 ENUM_VALUES_PER_LINE   = 4
138 GENERATE_TREEVIEW      = NO
139 TREEVIEW_WIDTH         = 250
140 #---------------------------------------------------------------------------
141 # configuration options related to the LaTeX output
142 #---------------------------------------------------------------------------
143 GENERATE_LATEX         = NO
144 LATEX_OUTPUT           = latex
145 LATEX_CMD_NAME         = latex
146 MAKEINDEX_CMD_NAME     = makeindex
147 COMPACT_LATEX          = NO
148 PAPER_TYPE             = a4wide
149 EXTRA_PACKAGES         = 
150 LATEX_HEADER           = 
151 PDF_HYPERLINKS         = NO
152 USE_PDFLATEX           = NO
153 LATEX_BATCHMODE        = NO
154 LATEX_HIDE_INDICES     = NO
155 #---------------------------------------------------------------------------
156 # configuration options related to the RTF output
157 #---------------------------------------------------------------------------
158 GENERATE_RTF           = NO
159 RTF_OUTPUT             = rtf
160 COMPACT_RTF            = NO
161 RTF_HYPERLINKS         = NO
162 RTF_STYLESHEET_FILE    = 
163 RTF_EXTENSIONS_FILE    = 
164 #---------------------------------------------------------------------------
165 # configuration options related to the man page output
166 #---------------------------------------------------------------------------
167 GENERATE_MAN           = NO
168 MAN_OUTPUT             = man
169 MAN_EXTENSION          = .3
170 MAN_LINKS              = NO
171 #---------------------------------------------------------------------------
172 # configuration options related to the XML output
173 #---------------------------------------------------------------------------
174 GENERATE_XML           = NO
175 XML_OUTPUT             = xml
176 XML_SCHEMA             = 
177 XML_DTD                = 
178 XML_PROGRAMLISTING     = YES
179 #---------------------------------------------------------------------------
180 # configuration options for the AutoGen Definitions output
181 #---------------------------------------------------------------------------
182 GENERATE_AUTOGEN_DEF   = NO
183 #---------------------------------------------------------------------------
184 # configuration options related to the Perl module output
185 #---------------------------------------------------------------------------
186 GENERATE_PERLMOD       = NO
187 PERLMOD_LATEX          = NO
188 PERLMOD_PRETTY         = YES
189 PERLMOD_MAKEVAR_PREFIX = 
190 #---------------------------------------------------------------------------
191 # Configuration options related to the preprocessor   
192 #---------------------------------------------------------------------------
193 ENABLE_PREPROCESSING   = YES
194 MACRO_EXPANSION        = NO
195 EXPAND_ONLY_PREDEF     = NO
196 SEARCH_INCLUDES        = YES
197 INCLUDE_PATH           = 
198 INCLUDE_FILE_PATTERNS  = 
199 PREDEFINED             = 
200 EXPAND_AS_DEFINED      = 
201 SKIP_FUNCTION_MACROS   = YES
202 #---------------------------------------------------------------------------
203 # Configuration::additions related to external references   
204 #---------------------------------------------------------------------------
205 TAGFILES               = 
206 GENERATE_TAGFILE       = 
207 ALLEXTERNALS           = NO
208 EXTERNAL_GROUPS        = YES
209 PERL_PATH              = /usr/bin/perl
210 #---------------------------------------------------------------------------
211 # Configuration options related to the dot tool   
212 #---------------------------------------------------------------------------
213 CLASS_DIAGRAMS         = YES
214 MSCGEN_PATH            = 
215 HIDE_UNDOC_RELATIONS   = NO
216 HAVE_DOT               = YES
217 CLASS_GRAPH            = YES
218 COLLABORATION_GRAPH    = YES
219 GROUP_GRAPHS           = YES
220 UML_LOOK               = NO
221 TEMPLATE_RELATIONS     = YES
222 INCLUDE_GRAPH          = YES
223 INCLUDED_BY_GRAPH      = YES
224 CALL_GRAPH             = YES
225 CALLER_GRAPH           = YES
226 GRAPHICAL_HIERARCHY    = YES
227 DIRECTORY_GRAPH        = YES
228 DOT_IMAGE_FORMAT       = png
229 DOT_PATH               = 
230 DOTFILE_DIRS           = 
231 DOT_GRAPH_MAX_NODES    = 50
232 MAX_DOT_GRAPH_DEPTH    = 0
233 DOT_TRANSPARENT        = NO
234 DOT_MULTI_TARGETS      = YES
235 GENERATE_LEGEND        = YES
236 DOT_CLEANUP            = YES
237 #---------------------------------------------------------------------------
238 # Configuration::additions related to the search engine   
239 #---------------------------------------------------------------------------
240 SEARCHENGINE           = NO