Doxyfile 12.8 KB
Newer Older
1
# Doxyfile 1.8.17
pixhawk's avatar
pixhawk committed
2 3 4 5 6

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING      = UTF-8
7
PROJECT_NAME           = QGroundControl
pixhawk's avatar
pixhawk committed
8
PROJECT_NUMBER         =
9 10 11 12 13
PROJECT_BRIEF          =
PROJECT_LOGO           = ./qgroundcontrol.png
OUTPUT_DIRECTORY       = .
CREATE_SUBDIRS         = YES
ALLOW_UNICODE_NAMES    = NO
pixhawk's avatar
pixhawk committed
14
OUTPUT_LANGUAGE        = English
15
OUTPUT_TEXT_DIRECTION  = None
pixhawk's avatar
pixhawk committed
16 17
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
18 19 20 21 22 23 24 25 26 27 28
ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the
pixhawk's avatar
pixhawk committed
29 30
ALWAYS_DETAILED_SEC    = NO
INLINE_INHERITED_MEMB  = NO
31 32 33
FULL_PATH_NAMES        = YES
STRIP_FROM_PATH        =  \
                         ..
pixhawk's avatar
pixhawk committed
34 35 36
STRIP_FROM_INC_PATH    =
SHORT_NAMES            = NO
JAVADOC_AUTOBRIEF      = NO
37
JAVADOC_BANNER         = NO
pixhawk's avatar
pixhawk committed
38 39 40 41
QT_AUTOBRIEF           = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
42 43 44
TAB_SIZE               = 4
ALIASES                = deprecated=@attention
TCL_SUBST              =
pixhawk's avatar
pixhawk committed
45 46 47 48
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
49
OPTIMIZE_OUTPUT_SLICE  = NO
Don Gagne's avatar
Don Gagne committed
50
EXTENSION_MAPPING      = qml=C++
51 52 53
MARKDOWN_SUPPORT       = YES
TOC_INCLUDE_HEADINGS   = 5
AUTOLINK_SUPPORT       = YES
pixhawk's avatar
pixhawk committed
54 55 56 57 58
BUILTIN_STL_SUPPORT    = YES
CPP_CLI_SUPPORT        = NO
SIP_SUPPORT            = NO
IDL_PROPERTY_SUPPORT   = YES
DISTRIBUTE_GROUP_DOC   = NO
59
GROUP_NESTED_COMPOUNDS = NO
pixhawk's avatar
pixhawk committed
60
SUBGROUPING            = YES
61 62
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS  = NO
pixhawk's avatar
pixhawk committed
63
TYPEDEF_HIDES_STRUCT   = NO
64
LOOKUP_CACHE_SIZE      = 0
pixhawk's avatar
pixhawk committed
65 66 67
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
pixhawk's avatar
pixhawk committed
68
EXTRACT_ALL            = YES
pixhawk's avatar
pixhawk committed
69
EXTRACT_PRIVATE        = NO
70 71
EXTRACT_PRIV_VIRTUAL   = NO
EXTRACT_PACKAGE        = NO
pixhawk's avatar
pixhawk committed
72 73 74 75 76 77 78 79 80
EXTRACT_STATIC         = NO
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
EXTRACT_ANON_NSPACES   = NO
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO
INTERNAL_DOCS          = NO
81
CASE_SENSE_NAMES       = NO
pixhawk's avatar
pixhawk committed
82
HIDE_SCOPE_NAMES       = NO
83
HIDE_COMPOUND_REFERENCE= NO
pixhawk's avatar
pixhawk committed
84
SHOW_INCLUDE_FILES     = YES
85 86
SHOW_GROUPED_MEMB_INC  = NO
FORCE_LOCAL_INCLUDES   = NO
pixhawk's avatar
pixhawk committed
87 88 89 90 91 92
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO
93
STRICT_PROTO_MATCHING  = NO
pixhawk's avatar
pixhawk committed
94 95 96 97 98 99 100 101
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS       =
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = YES
SHOW_FILES             = YES
102
SHOW_NAMESPACES        = NO
pixhawk's avatar
pixhawk committed
103 104
FILE_VERSION_FILTER    =
LAYOUT_FILE            =
105
CITE_BIB_FILES         =
pixhawk's avatar
pixhawk committed
106
#---------------------------------------------------------------------------
107
# Configuration options related to warning and progress messages
pixhawk's avatar
pixhawk committed
108
#---------------------------------------------------------------------------
109
QUIET                  = NO
pixhawk's avatar
pixhawk committed
110 111 112 113
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO
114
WARN_AS_ERROR          = NO
pixhawk's avatar
pixhawk committed
115
WARN_FORMAT            = "$file:$line: $text"
116
WARN_LOGFILE           =
pixhawk's avatar
pixhawk committed
117
#---------------------------------------------------------------------------
118
# Configuration options related to the input files
pixhawk's avatar
pixhawk committed
119
#---------------------------------------------------------------------------
120 121 122
INPUT                  =  \
                         ../src \
                         .
pixhawk's avatar
pixhawk committed
123
INPUT_ENCODING         = UTF-8
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
FILE_PATTERNS          = *.c \
                         *.cc \
                         *.cxx \
                         *.cpp \
                         *.c++ \
                         *.java \
                         *.h \
                         *.hh \
                         *.hxx \
                         *.hpp \
                         *.h++ \
                         *.m \
                         *.markdown \
                         *.md \
                         *.mm \
                         *.dox \
                         *.doc \
                         *.txt \
                         *.py \
                         *.qml
pixhawk's avatar
pixhawk committed
144
RECURSIVE              = YES
145 146 147 148 149 150 151 152 153 154
EXCLUDE                = ../src/Airmap/QJsonWebToken \
                         ../src/PairingManager/NfcLibrary \
                         ../src/PairingManager/NfcTask \
                         ../src/PairingManager/TML \
                         ../src/GPS/Drivers \
                         ../src/GPS/RTCM \
                         ../src/Airmap/QJsonWebToken \
                         ../src/Airmap/README.md \
                         ../src/QtLocationPlugin/qtlocation/README.md \
                         ../src/VideoStreaming/README.md
pixhawk's avatar
pixhawk committed
155
EXCLUDE_SYMLINKS       = NO
156 157
EXCLUDE_PATTERNS       = *Test.*
EXCLUDE_SYMBOLS        = "UnitTest" "_*"
pixhawk's avatar
pixhawk committed
158
EXAMPLE_PATH           =
159 160
EXAMPLE_PATTERNS       = *
EXAMPLE_RECURSIVE      = NO
pixhawk's avatar
pixhawk committed
161 162
IMAGE_PATH             =
INPUT_FILTER           =
163
FILTER_PATTERNS        = *.qml=doxyqml
pixhawk's avatar
pixhawk committed
164
FILTER_SOURCE_FILES    = NO
165 166
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
pixhawk's avatar
pixhawk committed
167
#---------------------------------------------------------------------------
168
# Configuration options related to source browsing
pixhawk's avatar
pixhawk committed
169
#---------------------------------------------------------------------------
170
SOURCE_BROWSER         = NO
pixhawk's avatar
pixhawk committed
171 172 173 174 175
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION    = NO
REFERENCES_LINK_SOURCE = YES
176
SOURCE_TOOLTIPS        = YES
pixhawk's avatar
pixhawk committed
177 178
USE_HTAGS              = NO
VERBATIM_HEADERS       = YES
179 180 181
#CLANG_ASSISTED_PARSING = NO
#CLANG_OPTIONS          =
#CLANG_DATABASE_PATH    =
pixhawk's avatar
pixhawk committed
182
#---------------------------------------------------------------------------
183
# Configuration options related to the alphabetical class index
pixhawk's avatar
pixhawk committed
184
#---------------------------------------------------------------------------
185
ALPHABETICAL_INDEX     = YES
pixhawk's avatar
pixhawk committed
186 187 188
COLS_IN_ALPHA_INDEX    = 5
IGNORE_PREFIX          =
#---------------------------------------------------------------------------
189
# Configuration options related to the HTML output
pixhawk's avatar
pixhawk committed
190 191 192 193
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
Gus Grubba's avatar
Gus Grubba committed
194
HTML_HEADER            = ./header.html
pixhawk's avatar
pixhawk committed
195 196
HTML_FOOTER            =
HTML_STYLESHEET        =
197 198 199 200 201 202 203 204 205 206
HTML_EXTRA_STYLESHEET  =
HTML_EXTRA_FILES       =
HTML_COLORSTYLE_HUE    = 269
HTML_COLORSTYLE_SAT    = 60
HTML_COLORSTYLE_GAMMA  = 100
HTML_TIMESTAMP         = NO
HTML_DYNAMIC_MENUS     = YES
HTML_DYNAMIC_SECTIONS  = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET        = NO
pixhawk's avatar
pixhawk committed
207
DOCSET_FEEDNAME        = "Doxygen generated docs"
208 209 210
DOCSET_BUNDLE_ID       = org.doxygen.Project
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME  = Publisher
pixhawk's avatar
pixhawk committed
211 212 213 214 215 216 217 218 219
GENERATE_HTMLHELP      = NO
CHM_FILE               =
HHC_LOCATION           =
GENERATE_CHI           = NO
CHM_INDEX_ENCODING     =
BINARY_TOC             = NO
TOC_EXPAND             = NO
GENERATE_QHP           = NO
QCH_FILE               =
220
QHP_NAMESPACE          = org.doxygen.Project
pixhawk's avatar
pixhawk committed
221 222 223 224 225
QHP_VIRTUAL_FOLDER     = doc
QHP_CUST_FILTER_NAME   =
QHP_CUST_FILTER_ATTRS  =
QHP_SECT_FILTER_ATTRS  =
QHG_LOCATION           =
226 227
GENERATE_ECLIPSEHELP   = NO
ECLIPSE_DOC_ID         = org.doxygen.Project
pixhawk's avatar
pixhawk committed
228
DISABLE_INDEX          = NO
229
GENERATE_TREEVIEW      = NO
pixhawk's avatar
pixhawk committed
230 231
ENUM_VALUES_PER_LINE   = 4
TREEVIEW_WIDTH         = 250
232
EXT_LINKS_IN_WINDOW    = NO
pixhawk's avatar
pixhawk committed
233
FORMULA_FONTSIZE       = 10
234 235 236 237 238 239 240
FORMULA_TRANSPARENT    = YES
#FORMULA_MACROFILE      =
USE_MATHJAX            = NO
MATHJAX_FORMAT         = HTML-CSS
MATHJAX_RELPATH        = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
MATHJAX_EXTENSIONS     =
MATHJAX_CODEFILE       =
pixhawk's avatar
pixhawk committed
241
SEARCHENGINE           = YES
242 243 244 245 246 247
SERVER_BASED_SEARCH    = NO
EXTERNAL_SEARCH        = NO
SEARCHENGINE_URL       =
SEARCHDATA_FILE        = searchdata.xml
EXTERNAL_SEARCH_ID     =
EXTRA_SEARCH_MAPPINGS  =
pixhawk's avatar
pixhawk committed
248
#---------------------------------------------------------------------------
249
# Configuration options related to the LaTeX output
pixhawk's avatar
pixhawk committed
250
#---------------------------------------------------------------------------
251
GENERATE_LATEX         = NO
pixhawk's avatar
pixhawk committed
252
LATEX_OUTPUT           = latex
253
LATEX_CMD_NAME         =
pixhawk's avatar
pixhawk committed
254
MAKEINDEX_CMD_NAME     = makeindex
255
LATEX_MAKEINDEX_CMD    = makeindex
pixhawk's avatar
pixhawk committed
256
COMPACT_LATEX          = NO
257
PAPER_TYPE             = a4
pixhawk's avatar
pixhawk committed
258 259
EXTRA_PACKAGES         =
LATEX_HEADER           =
260 261 262 263 264
LATEX_FOOTER           =
LATEX_EXTRA_STYLESHEET =
LATEX_EXTRA_FILES      =
PDF_HYPERLINKS         = YES
USE_PDFLATEX           = YES
pixhawk's avatar
pixhawk committed
265 266 267
LATEX_BATCHMODE        = NO
LATEX_HIDE_INDICES     = NO
LATEX_SOURCE_CODE      = NO
268 269 270
LATEX_BIB_STYLE        = plain
LATEX_TIMESTAMP        = NO
LATEX_EMOJI_DIRECTORY  =
pixhawk's avatar
pixhawk committed
271
#---------------------------------------------------------------------------
272
# Configuration options related to the RTF output
pixhawk's avatar
pixhawk committed
273 274 275 276 277 278 279
#---------------------------------------------------------------------------
GENERATE_RTF           = NO
RTF_OUTPUT             = rtf
COMPACT_RTF            = NO
RTF_HYPERLINKS         = NO
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
280
RTF_SOURCE_CODE        = NO
pixhawk's avatar
pixhawk committed
281
#---------------------------------------------------------------------------
282
# Configuration options related to the man page output
pixhawk's avatar
pixhawk committed
283 284 285 286
#---------------------------------------------------------------------------
GENERATE_MAN           = NO
MAN_OUTPUT             = man
MAN_EXTENSION          = .3
287
MAN_SUBDIR             =
pixhawk's avatar
pixhawk committed
288 289
MAN_LINKS              = NO
#---------------------------------------------------------------------------
290
# Configuration options related to the XML output
pixhawk's avatar
pixhawk committed
291 292 293 294
#---------------------------------------------------------------------------
GENERATE_XML           = NO
XML_OUTPUT             = xml
XML_PROGRAMLISTING     = YES
295
XML_NS_MEMB_FILE_SCOPE = NO
pixhawk's avatar
pixhawk committed
296
#---------------------------------------------------------------------------
297 298 299 300 301 302 303
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK       = NO
DOCBOOK_OUTPUT         = docbook
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
pixhawk's avatar
pixhawk committed
304 305 306
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF   = NO
#---------------------------------------------------------------------------
307
# Configuration options related to the Perl module output
pixhawk's avatar
pixhawk committed
308 309 310 311 312 313 314 315 316
#---------------------------------------------------------------------------
GENERATE_PERLMOD       = NO
PERLMOD_LATEX          = NO
PERLMOD_PRETTY         = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
317
MACRO_EXPANSION        = YES
pixhawk's avatar
pixhawk committed
318 319 320 321 322 323 324 325
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  =
PREDEFINED             =
EXPAND_AS_DEFINED      =
SKIP_FUNCTION_MACROS   = YES
#---------------------------------------------------------------------------
326
# Configuration options related to external references
pixhawk's avatar
pixhawk committed
327 328 329 330 331
#---------------------------------------------------------------------------
TAGFILES               =
GENERATE_TAGFILE       =
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
332
EXTERNAL_PAGES         = YES
pixhawk's avatar
pixhawk committed
333 334 335 336
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS         = YES
337
DIA_PATH               =
pixhawk's avatar
pixhawk committed
338 339
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = YES
340 341 342
DOT_NUM_THREADS        = 0
DOT_FONTNAME           = Helvetica
DOT_FONTSIZE           = 8
pixhawk's avatar
pixhawk committed
343 344 345 346
DOT_FONTPATH           =
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
GROUP_GRAPHS           = YES
347 348 349
UML_LOOK               = YES
UML_LIMIT_NUM_FIELDS   = 50
TEMPLATE_RELATIONS     = YES
pixhawk's avatar
pixhawk committed
350 351
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
352 353
CALL_GRAPH             = YES
CALLER_GRAPH           = YES
pixhawk's avatar
pixhawk committed
354 355
GRAPHICAL_HIERARCHY    = YES
DIRECTORY_GRAPH        = YES
356 357
DOT_IMAGE_FORMAT       = svg
INTERACTIVE_SVG        = YES
358
DOT_PATH               = .
pixhawk's avatar
pixhawk committed
359
DOTFILE_DIRS           =
360 361 362 363 364
MSCFILE_DIRS           =
DIAFILE_DIRS           =
PLANTUML_JAR_PATH      =
PLANTUML_CFG_FILE      =
PLANTUML_INCLUDE_PATH  =
Gus Grubba's avatar
Gus Grubba committed
365
DOT_GRAPH_MAX_NODES    = 200
pixhawk's avatar
pixhawk committed
366 367
MAX_DOT_GRAPH_DEPTH    = 0
DOT_TRANSPARENT        = YES
pixhawk's avatar
pixhawk committed
368
DOT_MULTI_TARGETS      = YES
pixhawk's avatar
pixhawk committed
369 370
GENERATE_LEGEND        = YES
DOT_CLEANUP            = YES