Rename a pipe method, add docs
[carla.git] / source / bridges-ui / CarlaBridge.doxygen
blob63a23fc32f8b9a1bc1ac2fa16ad3e911d4916d16
1 # Doxyfile 1.7.6.1
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           = "Carla Bridge"
8 PROJECT_NUMBER         =
9 PROJECT_BRIEF          =
10 PROJECT_LOGO           =
11 OUTPUT_DIRECTORY       = ../../doc/carla-bridge
12 CREATE_SUBDIRS         = NO
13 OUTPUT_LANGUAGE        = English
14 BRIEF_MEMBER_DESC      = YES
15 REPEAT_BRIEF           = YES
16 ABBREVIATE_BRIEF       =
17 ALWAYS_DETAILED_SEC    = NO
18 INLINE_INHERITED_MEMB  = NO
19 FULL_PATH_NAMES        = YES
20 STRIP_FROM_PATH        =
21 STRIP_FROM_INC_PATH    =
22 SHORT_NAMES            = NO
23 JAVADOC_AUTOBRIEF      = NO
24 QT_AUTOBRIEF           = NO
25 MULTILINE_CPP_IS_BRIEF = NO
26 INHERIT_DOCS           = YES
27 SEPARATE_MEMBER_PAGES  = NO
28 TAB_SIZE               = 4
29 ALIASES                =
30 TCL_SUBST              =
31 OPTIMIZE_OUTPUT_FOR_C  = NO
32 OPTIMIZE_OUTPUT_JAVA   = NO
33 OPTIMIZE_FOR_FORTRAN   = NO
34 OPTIMIZE_OUTPUT_VHDL   = NO
35 EXTENSION_MAPPING      =
36 BUILTIN_STL_SUPPORT    = NO
37 CPP_CLI_SUPPORT        = NO
38 SIP_SUPPORT            = NO
39 IDL_PROPERTY_SUPPORT   = YES
40 DISTRIBUTE_GROUP_DOC   = NO
41 SUBGROUPING            = YES
42 INLINE_GROUPED_CLASSES = NO
43 INLINE_SIMPLE_STRUCTS  = NO
44 TYPEDEF_HIDES_STRUCT   = NO
45 SYMBOL_CACHE_SIZE      = 0
46 LOOKUP_CACHE_SIZE      = 0
47 #---------------------------------------------------------------------------
48 # Build related configuration options
49 #---------------------------------------------------------------------------
50 EXTRACT_ALL            = YES
51 EXTRACT_PRIVATE        = NO
52 EXTRACT_STATIC         = NO
53 EXTRACT_LOCAL_CLASSES  = YES
54 EXTRACT_LOCAL_METHODS  = NO
55 EXTRACT_ANON_NSPACES   = NO
56 HIDE_UNDOC_MEMBERS     = NO
57 HIDE_UNDOC_CLASSES     = NO
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 FORCE_LOCAL_INCLUDES   = NO
65 INLINE_INFO            = YES
66 SORT_MEMBER_DOCS       = NO
67 SORT_BRIEF_DOCS        = NO
68 SORT_MEMBERS_CTORS_1ST = NO
69 SORT_GROUP_NAMES       = NO
70 SORT_BY_SCOPE_NAME     = NO
71 STRICT_PROTO_MATCHING  = NO
72 GENERATE_TODOLIST      = YES
73 GENERATE_TESTLIST      = YES
74 GENERATE_BUGLIST       = YES
75 GENERATE_DEPRECATEDLIST= YES
76 ENABLED_SECTIONS       =
77 MAX_INITIALIZER_LINES  = 30
78 SHOW_USED_FILES        = YES
79 SHOW_DIRECTORIES       = NO
80 SHOW_FILES             = YES
81 SHOW_NAMESPACES        = YES
82 FILE_VERSION_FILTER    =
83 LAYOUT_FILE            =
84 CITE_BIB_FILES         =
85 #---------------------------------------------------------------------------
86 # configuration options related to warning and progress messages
87 #---------------------------------------------------------------------------
88 QUIET                  = NO
89 WARNINGS               = YES
90 WARN_IF_UNDOCUMENTED   = YES
91 WARN_IF_DOC_ERROR      = YES
92 WARN_NO_PARAMDOC       = NO
93 WARN_FORMAT            = "$file:$line: $text"
94 WARN_LOGFILE           =
95 #---------------------------------------------------------------------------
96 # configuration options related to the input files
97 #---------------------------------------------------------------------------
98 INPUT                  =
99 INPUT_ENCODING         = UTF-8
100 FILE_PATTERNS          =
101 RECURSIVE              = NO
102 EXCLUDE                = carla_bridge_osc.hpp carla_bridge_osc.cpp carla_bridge_plugin.cpp
103 EXCLUDE_SYMLINKS       = NO
104 EXCLUDE_PATTERNS       =
105 EXCLUDE_SYMBOLS        =
106 EXAMPLE_PATH           =
107 EXAMPLE_PATTERNS       =
108 EXAMPLE_RECURSIVE      = NO
109 IMAGE_PATH             =
110 INPUT_FILTER           =
111 FILTER_PATTERNS        =
112 FILTER_SOURCE_FILES    = NO
113 FILTER_SOURCE_PATTERNS =
114 #---------------------------------------------------------------------------
115 # configuration options related to source browsing
116 #---------------------------------------------------------------------------
117 SOURCE_BROWSER         = NO
118 INLINE_SOURCES         = NO
119 STRIP_CODE_COMMENTS    = YES
120 REFERENCED_BY_RELATION = NO
121 REFERENCES_RELATION    = NO
122 REFERENCES_LINK_SOURCE = YES
123 USE_HTAGS              = NO
124 VERBATIM_HEADERS       = YES
125 #---------------------------------------------------------------------------
126 # configuration options related to the alphabetical class index
127 #---------------------------------------------------------------------------
128 ALPHABETICAL_INDEX     = YES
129 COLS_IN_ALPHA_INDEX    = 5
130 IGNORE_PREFIX          =
131 #---------------------------------------------------------------------------
132 # configuration options related to the HTML output
133 #---------------------------------------------------------------------------
134 GENERATE_HTML          = YES
135 HTML_OUTPUT            = .
136 HTML_FILE_EXTENSION    = .html
137 HTML_HEADER            =
138 HTML_FOOTER            =
139 HTML_STYLESHEET        =
140 HTML_EXTRA_FILES       =
141 HTML_COLORSTYLE_HUE    = 220
142 HTML_COLORSTYLE_SAT    = 100
143 HTML_COLORSTYLE_GAMMA  = 80
144 HTML_TIMESTAMP         = YES
145 HTML_ALIGN_MEMBERS     = YES
146 HTML_DYNAMIC_SECTIONS  = NO
147 GENERATE_DOCSET        = NO
148 DOCSET_FEEDNAME        = "Doxygen generated docs"
149 DOCSET_BUNDLE_ID       = org.doxygen.Project
150 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
151 DOCSET_PUBLISHER_NAME  = Publisher
152 GENERATE_HTMLHELP      = NO
153 CHM_FILE               =
154 HHC_LOCATION           =
155 GENERATE_CHI           = NO
156 CHM_INDEX_ENCODING     =
157 BINARY_TOC             = NO
158 TOC_EXPAND             = NO
159 GENERATE_QHP           = NO
160 QCH_FILE               =
161 QHP_NAMESPACE          = org.doxygen.Project
162 QHP_VIRTUAL_FOLDER     = doc
163 QHP_CUST_FILTER_NAME   =
164 QHP_CUST_FILTER_ATTRS  =
165 QHP_SECT_FILTER_ATTRS  =
166 QHG_LOCATION           =
167 GENERATE_ECLIPSEHELP   = NO
168 ECLIPSE_DOC_ID         = org.doxygen.Project
169 DISABLE_INDEX          = NO
170 GENERATE_TREEVIEW      = NO
171 ENUM_VALUES_PER_LINE   = 4
172 USE_INLINE_TREES       = NO
173 TREEVIEW_WIDTH         = 250
174 EXT_LINKS_IN_WINDOW    = NO
175 FORMULA_FONTSIZE       = 10
176 FORMULA_TRANSPARENT    = YES
177 USE_MATHJAX            = NO
178 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
179 MATHJAX_EXTENSIONS     =
180 SEARCHENGINE           = YES
181 SERVER_BASED_SEARCH    = NO
182 #---------------------------------------------------------------------------
183 # configuration options related to the LaTeX output
184 #---------------------------------------------------------------------------
185 GENERATE_LATEX         = NO
186 LATEX_OUTPUT           = latex
187 LATEX_CMD_NAME         = latex
188 MAKEINDEX_CMD_NAME     = makeindex
189 COMPACT_LATEX          = NO
190 PAPER_TYPE             = a4
191 EXTRA_PACKAGES         =
192 LATEX_HEADER           =
193 LATEX_FOOTER           =
194 PDF_HYPERLINKS         = YES
195 USE_PDFLATEX           = YES
196 LATEX_BATCHMODE        = NO
197 LATEX_HIDE_INDICES     = NO
198 LATEX_SOURCE_CODE      = NO
199 LATEX_BIB_STYLE        = plain
200 #---------------------------------------------------------------------------
201 # configuration options related to the RTF output
202 #---------------------------------------------------------------------------
203 GENERATE_RTF           = NO
204 RTF_OUTPUT             = rtf
205 COMPACT_RTF            = NO
206 RTF_HYPERLINKS         = NO
207 RTF_STYLESHEET_FILE    =
208 RTF_EXTENSIONS_FILE    =
209 #---------------------------------------------------------------------------
210 # configuration options related to the man page output
211 #---------------------------------------------------------------------------
212 GENERATE_MAN           = NO
213 MAN_OUTPUT             = man
214 MAN_EXTENSION          = .3
215 MAN_LINKS              = NO
216 #---------------------------------------------------------------------------
217 # configuration options related to the XML output
218 #---------------------------------------------------------------------------
219 GENERATE_XML           = NO
220 XML_OUTPUT             = xml
221 XML_SCHEMA             =
222 XML_DTD                =
223 XML_PROGRAMLISTING     = YES
224 #---------------------------------------------------------------------------
225 # configuration options for the AutoGen Definitions output
226 #---------------------------------------------------------------------------
227 GENERATE_AUTOGEN_DEF   = NO
228 #---------------------------------------------------------------------------
229 # configuration options related to the Perl module output
230 #---------------------------------------------------------------------------
231 GENERATE_PERLMOD       = NO
232 PERLMOD_LATEX          = NO
233 PERLMOD_PRETTY         = YES
234 PERLMOD_MAKEVAR_PREFIX =
235 #---------------------------------------------------------------------------
236 # Configuration options related to the preprocessor
237 #---------------------------------------------------------------------------
238 ENABLE_PREPROCESSING   = YES
239 MACRO_EXPANSION        = NO
240 EXPAND_ONLY_PREDEF     = NO
241 SEARCH_INCLUDES        = YES
242 INCLUDE_PATH           =
243 INCLUDE_FILE_PATTERNS  =
244 PREDEFINED             = DOXYGEN BUILD_BRIDGE BUILD_BRIDGE_PLUGIN BUILD_BRIDGE_UI BRIDGE_GTK2 BRIDGE_GTK3 BRIDGE_QT4 BRIDGE_X11
245 EXPAND_AS_DEFINED      =
246 SKIP_FUNCTION_MACROS   = YES
247 #---------------------------------------------------------------------------
248 # Configuration::additions related to external references
249 #---------------------------------------------------------------------------
250 TAGFILES               =
251 GENERATE_TAGFILE       =
252 ALLEXTERNALS           = NO
253 EXTERNAL_GROUPS        = YES
254 PERL_PATH              = /usr/bin/perl
255 #---------------------------------------------------------------------------
256 # Configuration options related to the dot tool
257 #---------------------------------------------------------------------------
258 CLASS_DIAGRAMS         = YES
259 MSCGEN_PATH            =
260 HIDE_UNDOC_RELATIONS   = YES
261 HAVE_DOT               = NO
262 DOT_NUM_THREADS        = 0
263 DOT_FONTNAME           = Helvetica
264 DOT_FONTSIZE           = 10
265 DOT_FONTPATH           =
266 CLASS_GRAPH            = YES
267 COLLABORATION_GRAPH    = YES
268 GROUP_GRAPHS           = YES
269 UML_LOOK               = NO
270 TEMPLATE_RELATIONS     = NO
271 INCLUDE_GRAPH          = YES
272 INCLUDED_BY_GRAPH      = YES
273 CALL_GRAPH             = NO
274 CALLER_GRAPH           = NO
275 GRAPHICAL_HIERARCHY    = YES
276 DIRECTORY_GRAPH        = YES
277 DOT_IMAGE_FORMAT       = png
278 INTERACTIVE_SVG        = NO
279 DOT_PATH               =
280 DOTFILE_DIRS           =
281 MSCFILE_DIRS           =
282 DOT_GRAPH_MAX_NODES    = 50
283 MAX_DOT_GRAPH_DEPTH    = 0
284 DOT_TRANSPARENT        = NO
285 DOT_MULTI_TARGETS      = YES
286 GENERATE_LEGEND        = YES
287 DOT_CLEANUP            = YES