~alan-griffiths/mir/0.28.1-to-ubuntu : revision 264.2.1

1

# Doxyfile 1.8.1.2

2

3

# This file describes the settings to be used by the documentation system

4

# doxygen (www.doxygen.org) for a project

5

#

6

# All text after a hash (#) is considered a comment and will be ignored

7

# The format is:

8

# TAG = value [value, ...]

9

# For lists items can also be appended using:

10

# TAG += value [value, ...]

11

# Values that contain spaces should be placed between quotes (" ")

12

13

#---------------------------------------------------------------------------

14

# Project related configuration options

15

#---------------------------------------------------------------------------

16

17

# This tag specifies the encoding used for all characters in the config file

18

# that follow. The default is UTF-8 which is also the encoding used for all

19

# text before the first occurrence of this tag. Doxygen uses libiconv (or the

20

# iconv built into libc) for the transcoding. See

21

# http://www.gnu.org/software/libiconv for the list of possible encodings.

22

23

DOXYFILE_ENCODING = UTF-8

24

25

# The PROJECT_NAME tag is a single word (or sequence of words) that should

26

# identify the project. Note that if you do not use Doxywizard you need

27

# to put quotes around the project name if it contains spaces.

28

29

PROJECT_NAME = Mir

30

31

# The PROJECT_NUMBER tag can be used to enter a project or revision number.

32

# This could be handy for archiving the generated documentation or

33

# if some version control system is used.

34

35

PROJECT_NUMBER =

36

37

# Using the PROJECT_BRIEF tag one can provide an optional one line description

38

# for a project that appears at the top of each page and should give viewer

39

# a quick idea about the purpose of the project. Keep the description short.

40

41

PROJECT_BRIEF =

42

43

# With the PROJECT_LOGO tag one can specify an logo or icon that is

44

# included in the documentation. The maximum height of the logo should not

45

# exceed 55 pixels and the maximum width should not exceed 200 pixels.

46

# Doxygen will copy the logo to the output directory.

47

48

PROJECT_LOGO =

49

50

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)

51

# base path where the generated documentation will be put.

52

# If a relative path is entered, it will be relative to the location

53

# where doxygen was started. If left blank the current directory will be used.

54

55

OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc

56

57

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create

58

# 4096 sub-directories (in 2 levels) under the output directory of each output

59

# format and will distribute the generated files over these directories.

60

# Enabling this option can be useful when feeding doxygen a huge amount of

61

# source files, where putting all generated files in the same directory would

62

# otherwise cause performance problems for the file system.

63

64

CREATE_SUBDIRS = NO

65

66

# The OUTPUT_LANGUAGE tag is used to specify the language in which all

67

# documentation generated by doxygen is written. Doxygen will use this

68

# information to generate all constant output in the proper language.

69

# The default language is English, other supported languages are:

70

# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,

71

# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,

72

# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English

73

# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,

74

# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,

75

# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.

76

77

OUTPUT_LANGUAGE = English

78

79

# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will

80

# include brief member descriptions after the members that are listed in

81

# the file and class documentation (similar to JavaDoc).

82

# Set to NO to disable this.

83

84

BRIEF_MEMBER_DESC = YES

85

86

# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend

87

# the brief description of a member or function before the detailed description.

88

# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the

89

# brief descriptions will be completely suppressed.

90

91

REPEAT_BRIEF = YES

92

93

# This tag implements a quasi-intelligent brief description abbreviator

94

# that is used to form the text in various listings. Each string

95

# in this list, if found as the leading text of the brief description, will be

96

# stripped from the text and the result after processing the whole list, is

97

# used as the annotated text. Otherwise, the brief description is used as-is.

98

# If left blank, the following values are used ("$name" is automatically

99

# replaced with the name of the entity): "The $name class" "The $name widget"

100

# "The $name file" "is" "provides" "specifies" "contains"

101

# "represents" "a" "an" "the"

102

103

ABBREVIATE_BRIEF = "The $name class" \

104

"The $name widget" \

105

"The $name file" \

106

is \

107

provides \

108

specifies \

109

contains \

110

represents \

111

a \

112

an \

113

the

114

115

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then

116

# Doxygen will generate a detailed section even if there is only a brief

117

# description.

118

119

ALWAYS_DETAILED_SEC = YES

120

121

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all

122

# inherited members of a class in the documentation of that class as if those

123

# members were ordinary class members. Constructors, destructors and assignment

124

# operators of the base classes will not be shown.

125

126

INLINE_INHERITED_MEMB = NO

127

128

# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full

129

# path before files name in the file list and in the header files. If set

130

# to NO the shortest path that makes the file name unique will be used.

131

132

FULL_PATH_NAMES = YES

133

134

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag

135

# can be used to strip a user-defined part of the path. Stripping is

136

# only done if one of the specified strings matches the left-hand part of

137

# the path. The tag can be used to show relative paths in the file list.

138

# If left blank the directory from which doxygen is run is used as the

139

# path to strip.

140

141

STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@

142

143

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of

144

# the path mentioned in the documentation of a class, which tells

145

# the reader which header file to include in order to use a class.

146

# If left blank only the name of the header file containing the class

147

# definition is used. Otherwise one should specify the include paths that

148

# are normally passed to the compiler using the -I flag.

149

150

STRIP_FROM_INC_PATH =

151

152

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter

153

# (but less readable) file names. This can be useful if your file system

154

# doesn't support long names like on DOS, Mac, or CD-ROM.

155

156

SHORT_NAMES = NO

157

158

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen

159

# will interpret the first line (until the first dot) of a JavaDoc-style

160

# comment as the brief description. If set to NO, the JavaDoc

161

# comments will behave just like regular Qt-style comments

162

# (thus requiring an explicit @brief command for a brief description.)

163

164

JAVADOC_AUTOBRIEF = YES

165

166

# If the QT_AUTOBRIEF tag is set to YES then Doxygen will

167

# interpret the first line (until the first dot) of a Qt-style

168

# comment as the brief description. If set to NO, the comments

169

# will behave just like regular Qt-style comments (thus requiring

170

# an explicit \brief command for a brief description.)

171

172

QT_AUTOBRIEF = NO

173

174

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen

175

# treat a multi-line C++ special comment block (i.e. a block of //! or ///

176

# comments) as a brief description. This used to be the default behaviour.

177

# The new default is to treat a multi-line C++ comment block as a detailed

178

# description. Set this tag to YES if you prefer the old behaviour instead.

179

180

MULTILINE_CPP_IS_BRIEF = YES

181

182

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented

183

# member inherits the documentation from any documented member that it

184

# re-implements.

185

186

INHERIT_DOCS = YES

187

188

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce

189

# a new page for each member. If set to NO, the documentation of a member will

190

# be part of the file/class/namespace that contains it.

191

192

SEPARATE_MEMBER_PAGES = NO

193

194

# The TAB_SIZE tag can be used to set the number of spaces in a tab.

195

# Doxygen uses this value to replace tabs by spaces in code fragments.

196

197

TAB_SIZE = 4

198

199

# This tag can be used to specify a number of aliases that acts

200

# as commands in the documentation. An alias has the form "name=value".

201

# For example adding "sideeffect=\par Side Effects:\n" will allow you to

202

# put the command \sideeffect (or @sideeffect) in the documentation, which

203

# will result in a user-defined paragraph with heading "Side Effects:".

204

# You can put \n's in the value part of an alias to insert newlines.

205

206

ALIASES =

207

208

# This tag can be used to specify a number of word-keyword mappings (TCL only).

209

# A mapping has the form "name=value". For example adding

210

# "class=itcl::class" will allow you to use the command class in the

211

# itcl::class meaning.

212

213

TCL_SUBST =

214

215

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C

216

# sources only. Doxygen will then generate output that is more tailored for C.

217

# For instance, some of the names that are used will be different. The list

218

# of all members will be omitted, etc.

219

220

OPTIMIZE_OUTPUT_FOR_C = NO

221

222

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java

223

# sources only. Doxygen will then generate output that is more tailored for

224

# Java. For instance, namespaces will be presented as packages, qualified

225

# scopes will look different, etc.

226

227

OPTIMIZE_OUTPUT_JAVA = NO

228

229

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran

230

# sources only. Doxygen will then generate output that is more tailored for

231

# Fortran.

232

233

OPTIMIZE_FOR_FORTRAN = NO

234

235

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL

236

# sources. Doxygen will then generate output that is tailored for

237

# VHDL.

238

239

OPTIMIZE_OUTPUT_VHDL = NO

240

241

# Doxygen selects the parser to use depending on the extension of the files it

242

# parses. With this tag you can assign which parser to use for a given extension.

243

# Doxygen has a built-in mapping, but you can override or extend it using this

244

# tag. The format is ext=language, where ext is a file extension, and language

245

# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,

246

# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make

247

# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C

248

# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions

249

# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.

250

251

EXTENSION_MAPPING =

252

253

# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all

254

# comments according to the Markdown format, which allows for more readable

255

# documentation. See http://daringfireball.net/projects/markdown/ for details.

256

# The output of markdown processing is further processed by doxygen, so you

257

# can mix doxygen, HTML, and XML commands with Markdown formatting.

258

# Disable only in case of backward compatibilities issues.

259

260

MARKDOWN_SUPPORT = YES

261

262

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want

263

# to include (a tag file for) the STL sources as input, then you should

264

# set this tag to YES in order to let doxygen match functions declarations and

265

# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.

266

# func(std::string) {}). This also makes the inheritance and collaboration

267

# diagrams that involve STL classes more complete and accurate.

268

269

BUILTIN_STL_SUPPORT = YES

270

271

# If you use Microsoft's C++/CLI language, you should set this option to YES to

272

# enable parsing support.

273

274

CPP_CLI_SUPPORT = NO

275

276

# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.

277

# Doxygen will parse them like normal C++ but will assume all classes use public

278

# instead of private inheritance when no explicit protection keyword is present.

279

280

SIP_SUPPORT = NO

281

282

# For Microsoft's IDL there are propget and propput attributes to indicate getter

283

# and setter methods for a property. Setting this option to YES (the default)

284

# will make doxygen replace the get and set methods by a property in the

285

# documentation. This will only work if the methods are indeed getting or

286

# setting a simple type. If this is not the case, or you want to show the

287

# methods anyway, you should set this option to NO.

288

289

IDL_PROPERTY_SUPPORT = YES

290

291

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC

292

# tag is set to YES, then doxygen will reuse the documentation of the first

293

# member in the group (if any) for the other members of the group. By default

294

# all members of a group must be documented explicitly.

295

296

DISTRIBUTE_GROUP_DOC = NO

297

298

# Set the SUBGROUPING tag to YES (the default) to allow class member groups of

299

# the same type (for instance a group of public functions) to be put as a

300

# subgroup of that type (e.g. under the Public Functions section). Set it to

301

# NO to prevent subgrouping. Alternatively, this can be done per class using

302

# the \nosubgrouping command.

303

304

SUBGROUPING = YES

305

306

# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and

307

# unions are shown inside the group in which they are included (e.g. using

308

# @ingroup) instead of on a separate page (for HTML and Man pages) or

309

# section (for LaTeX and RTF).

310

311

INLINE_GROUPED_CLASSES = NO

312

313

# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and

314

# unions with only public data fields will be shown inline in the documentation

315

# of the scope in which they are defined (i.e. file, namespace, or group

316

# documentation), provided this scope is documented. If set to NO (the default),

317

# structs, classes, and unions are shown on a separate page (for HTML and Man

318

# pages) or section (for LaTeX and RTF).

319

320

INLINE_SIMPLE_STRUCTS = NO

321

322

# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum

323

# is documented as struct, union, or enum with the name of the typedef. So

324

# typedef struct TypeS {} TypeT, will appear in the documentation as a struct

325

# with name TypeT. When disabled the typedef will appear as a member of a file,

326

# namespace, or class. And the struct will be named TypeS. This can typically

327

# be useful for C code in case the coding convention dictates that all compound

328

# types are typedef'ed and only the typedef is referenced, never the tag name.

329

330

TYPEDEF_HIDES_STRUCT = NO

331

332

# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to

333

# determine which symbols to keep in memory and which to flush to disk.

334

# When the cache is full, less often used symbols will be written to disk.

335

# For small to medium size projects (<1000 input files) the default value is

336

# probably good enough. For larger projects a too small cache size can cause

337

# doxygen to be busy swapping symbols to and from disk most of the time

338

# causing a significant performance penalty.

339

# If the system has enough physical memory increasing the cache will improve the

340

# performance by keeping more symbols in memory. Note that the value works on

341

# a logarithmic scale so increasing the size by one will roughly double the

342

# memory usage. The cache size is given by this formula:

343

# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,

344

# corresponding to a cache size of 2^16 = 65536 symbols.

345

346

SYMBOL_CACHE_SIZE = 0

347

348

# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be

349

# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given

350

# their name and scope. Since this can be an expensive process and often the

351

# same symbol appear multiple times in the code, doxygen keeps a cache of

352

# pre-resolved symbols. If the cache is too small doxygen will become slower.

353

# If the cache is too large, memory is wasted. The cache size is given by this

354

# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,

355

# corresponding to a cache size of 2^16 = 65536 symbols.

356

357

LOOKUP_CACHE_SIZE = 0

358

359

#---------------------------------------------------------------------------

360

# Build related configuration options

361

#---------------------------------------------------------------------------

362

363

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in

364

# documentation are documented, even if no documentation was available.

365

# Private class members and static file members will be hidden unless

366

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

367

368

EXTRACT_ALL = YES

369

370

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class

371

# will be included in the documentation.

372

373

EXTRACT_PRIVATE = NO

374

375

# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal

376

# scope will be included in the documentation.

377

378

EXTRACT_PACKAGE = NO

379

380

# If the EXTRACT_STATIC tag is set to YES all static members of a file

381

# will be included in the documentation.

382

383

EXTRACT_STATIC = NO

384

385

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)

386

# defined locally in source files will be included in the documentation.

387

# If set to NO only classes defined in header files are included.

388

389

EXTRACT_LOCAL_CLASSES = YES

390

391

# This flag is only useful for Objective-C code. When set to YES local

392

# methods, which are defined in the implementation section but not in

393

# the interface are included in the documentation.

394

# If set to NO (the default) only methods in the interface are included.

395

396

EXTRACT_LOCAL_METHODS = NO

397

398

# If this flag is set to YES, the members of anonymous namespaces will be

399

# extracted and appear in the documentation as a namespace called

400

# 'anonymous_namespace{file}', where file will be replaced with the base

401

# name of the file that contains the anonymous namespace. By default

402

# anonymous namespaces are hidden.

403

404

EXTRACT_ANON_NSPACES = NO

405

406

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all

407

# undocumented members of documented classes, files or namespaces.

408

# If set to NO (the default) these members will be included in the

409

# various overviews, but no documentation section is generated.

410

# This option has no effect if EXTRACT_ALL is enabled.

411

412

HIDE_UNDOC_MEMBERS = NO

413

414

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all

415

# undocumented classes that are normally visible in the class hierarchy.

416

# If set to NO (the default) these classes will be included in the various

417

# overviews. This option has no effect if EXTRACT_ALL is enabled.

418

419

HIDE_UNDOC_CLASSES = NO

420

421

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all

422

# friend (class|struct|union) declarations.

423

# If set to NO (the default) these declarations will be included in the

424

# documentation.

425

426

HIDE_FRIEND_COMPOUNDS = NO

427

428

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any

429

# documentation blocks found inside the body of a function.

430

# If set to NO (the default) these blocks will be appended to the

431

# function's detailed documentation block.

432

433

HIDE_IN_BODY_DOCS = NO

434

435

# The INTERNAL_DOCS tag determines if documentation

436

# that is typed after a \internal command is included. If the tag is set

437

# to NO (the default) then the documentation will be excluded.

438

# Set it to YES to include the internal documentation.

439

440

INTERNAL_DOCS = NO

441

442

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate

443

# file names in lower-case letters. If set to YES upper-case letters are also

444

# allowed. This is useful if you have classes or files whose names only differ

445

# in case and if your file system supports case sensitive file names. Windows

446

# and Mac users are advised to set this option to NO.

447

448

CASE_SENSE_NAMES = NO

449

450

# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen

451

# will show members with their full class and namespace scopes in the

452

# documentation. If set to YES the scope will be hidden.

453

454

HIDE_SCOPE_NAMES = NO

455

456

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen

457

# will put a list of the files that are included by a file in the documentation

458

# of that file.

459

460

SHOW_INCLUDE_FILES = YES

461

462

# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen

463

# will list include files with double quotes in the documentation

464

# rather than with sharp brackets.

465

466

FORCE_LOCAL_INCLUDES = NO

467

468

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]

469

# is inserted in the documentation for inline members.

470

471

INLINE_INFO = YES

472

473

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen

474

# will sort the (detailed) documentation of file and class members

475

# alphabetically by member name. If set to NO the members will appear in

476

# declaration order.

477

478

SORT_MEMBER_DOCS = YES

479

480

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the

481

# brief documentation of file, namespace and class members alphabetically

482

# by member name. If set to NO (the default) the members will appear in

483

# declaration order.

484

485

SORT_BRIEF_DOCS = NO

486

487

# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen

488

# will sort the (brief and detailed) documentation of class members so that

489

# constructors and destructors are listed first. If set to NO (the default)

490

# the constructors will appear in the respective orders defined by

491

# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.

492

# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO

493

# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

494

495

SORT_MEMBERS_CTORS_1ST = NO

496

497

# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the

498

# hierarchy of group names into alphabetical order. If set to NO (the default)

499

# the group names will appear in their defined order.

500

501

SORT_GROUP_NAMES = NO

502

503

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be

504

# sorted by fully-qualified names, including namespaces. If set to

505

# NO (the default), the class list will be sorted only by class name,

506

# not including the namespace part.

507

# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.

508

# Note: This option applies only to the class list, not to the

509

# alphabetical list.

510

511

SORT_BY_SCOPE_NAME = NO

512

513

# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to

514

# do proper type resolution of all parameters of a function it will reject a

515

# match between the prototype and the implementation of a member function even

516

# if there is only one candidate or it is obvious which candidate to choose

517

# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen

518

# will still accept a match between prototype and implementation in such cases.

519

520

STRICT_PROTO_MATCHING = NO

521

522

# The GENERATE_TODOLIST tag can be used to enable (YES) or

523

# disable (NO) the todo list. This list is created by putting \todo

524

# commands in the documentation.

525

526

GENERATE_TODOLIST = YES

527

528

# The GENERATE_TESTLIST tag can be used to enable (YES) or

529

# disable (NO) the test list. This list is created by putting \test

530

# commands in the documentation.

531

532

GENERATE_TESTLIST = YES

533

534

# The GENERATE_BUGLIST tag can be used to enable (YES) or

535

# disable (NO) the bug list. This list is created by putting \bug

536

# commands in the documentation.

537

538

GENERATE_BUGLIST = YES

539

540

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or

541

# disable (NO) the deprecated list. This list is created by putting

542

# \deprecated commands in the documentation.

543

544

GENERATE_DEPRECATEDLIST= YES

545

546

# The ENABLED_SECTIONS tag can be used to enable conditional

547

# documentation sections, marked by \if sectionname ... \endif.

548

549

ENABLED_SECTIONS =

550

551

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines

552

# the initial value of a variable or macro consists of for it to appear in

553

# the documentation. If the initializer consists of more lines than specified

554

# here it will be hidden. Use a value of 0 to hide initializers completely.

555

# The appearance of the initializer of individual variables and macros in the

556

# documentation can be controlled using \showinitializer or \hideinitializer

557

# command in the documentation regardless of this setting.

558

559

MAX_INITIALIZER_LINES = 30

560

561

# Set the SHOW_USED_FILES tag to NO to disable the list of files generated

562

# at the bottom of the documentation of classes and structs. If set to YES the

563

# list will mention the files that were used to generate the documentation.

564

565

SHOW_USED_FILES = YES

566

567

# Set the SHOW_FILES tag to NO to disable the generation of the Files page.

568

# This will remove the Files entry from the Quick Index and from the

569

# Folder Tree View (if specified). The default is YES.

570

571

SHOW_FILES = YES

572

573

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the

574

# Namespaces page. This will remove the Namespaces entry from the Quick Index

575

# and from the Folder Tree View (if specified). The default is YES.

576

577

SHOW_NAMESPACES = YES

578

579

# The FILE_VERSION_FILTER tag can be used to specify a program or script that

580

# doxygen should invoke to get the current version for each file (typically from

581

# the version control system). Doxygen will invoke the program by executing (via

582

# popen()) the command <command> <input-file>, where <command> is the value of

583

# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file

584

# provided by doxygen. Whatever the program writes to standard output

585

# is used as the file version. See the manual for examples.

586

587

FILE_VERSION_FILTER =

588

589

# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed

590

# by doxygen. The layout file controls the global structure of the generated

591

# output files in an output format independent way. To create the layout file

592

# that represents doxygen's defaults, run doxygen with the -l option.

593

# You can optionally specify a file name after the option, if omitted

594

# DoxygenLayout.xml will be used as the name of the layout file.

595

596

LAYOUT_FILE =

597

598

# The CITE_BIB_FILES tag can be used to specify one or more bib files

599

# containing the references data. This must be a list of .bib files. The

600

# .bib extension is automatically appended if omitted. Using this command

601

# requires the bibtex tool to be installed. See also

602

# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style

603

# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this

604

# feature you need bibtex and perl available in the search path.

605

606

CITE_BIB_FILES =

607

608

#---------------------------------------------------------------------------

609

# configuration options related to warning and progress messages

610

#---------------------------------------------------------------------------

611

612

# The QUIET tag can be used to turn on/off the messages that are generated

613

# by doxygen. Possible values are YES and NO. If left blank NO is used.

614

615

QUIET = NO

616

617

# The WARNINGS tag can be used to turn on/off the warning messages that are

618

# generated by doxygen. Possible values are YES and NO. If left blank

619

# NO is used.

620

621

WARNINGS = YES

622

623

# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings

624

# for undocumented members. If EXTRACT_ALL is set to YES then this flag will

625

# automatically be disabled.

626

627

WARN_IF_UNDOCUMENTED = YES

628

629

# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for

630

# potential errors in the documentation, such as not documenting some

631

# parameters in a documented function, or documenting parameters that

632

# don't exist or using markup commands wrongly.

633

634

WARN_IF_DOC_ERROR = YES

635

636

# The WARN_NO_PARAMDOC option can be enabled to get warnings for

637

# functions that are documented, but have no documentation for their parameters

638

# or return value. If set to NO (the default) doxygen will only warn about

639

# wrong or incomplete parameter documentation, but not about the absence of

640

# documentation.

641

642

WARN_NO_PARAMDOC = NO

643

644

# The WARN_FORMAT tag determines the format of the warning messages that

645

# doxygen can produce. The string should contain the $file, $line, and $text

646

# tags, which will be replaced by the file and line number from which the

647

# warning originated and the warning text. Optionally the format may contain

648

# $version, which will be replaced by the version of the file (if it could

649

# be obtained via FILE_VERSION_FILTER)

650

651

WARN_FORMAT = "$file:$line: $text"

652

653

# The WARN_LOGFILE tag can be used to specify a file to which warning

654

# and error messages should be written. If left blank the output is written

655

# to stderr.

656

657

WARN_LOGFILE =

658

659

#---------------------------------------------------------------------------

660

# configuration options related to the input files

661

#---------------------------------------------------------------------------

662

663

# The INPUT tag can be used to specify the files and/or directories that contain

664

# documented source files. You may enter file names like "myfile.cpp" or

665

# directories like "/usr/src/myproject". Separate the files or directories

666

# with spaces.

667

668

INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doc \

669

@CMAKE_CURRENT_SOURCE_DIR@/src \

670

@CMAKE_CURRENT_SOURCE_DIR@/include

671

672

# This tag can be used to specify the character encoding of the source files

673

# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

674

# also the default input encoding. Doxygen uses libiconv (or the iconv built

675

# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for

676

# the list of possible encodings.

677

678

INPUT_ENCODING = UTF-8

679

680

# If the value of the INPUT tag contains directories, you can use the

681

# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

682

# and *.h) to filter out the source-files in the directories. If left

683

# blank the following patterns are tested:

684

# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh

685

# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py

686

# *.f90 *.f *.for *.vhd *.vhdl

687

688

FILE_PATTERNS = *.c \

689

*.cc \

690

*.cxx \

691

*.cpp \

692

*.c++ \

693

*.d \

694

*.java \

695

*.ii \

696

*.ixx \

697

*.ipp \

698

*.i++ \

699

*.inl \

700

*.h \

701

*.hh \

702

*.hxx \

703

*.hpp \

704

*.h++ \

705

*.idl \

706

*.odl \

707

*.cs \

708

*.php \

709

*.php3 \

710

*.inc \

711

*.m \

712

*.markdown \

713

*.md \

714

*.mm \

715

*.dox \

716

*.py \

717

*.f90 \

718

*.f \

719

*.for \

720

*.vhd \

721

*.vhdl

722

723

# The RECURSIVE tag can be used to turn specify whether or not subdirectories

724

# should be searched for input files as well. Possible values are YES and NO.

725

# If left blank NO is used.

726

727

RECURSIVE = YES

728

729

# The EXCLUDE tag can be used to specify files and/or directories that should be

730

# excluded from the INPUT source files. This way you can easily exclude a

731

# subdirectory from a directory tree whose root is specified with the INPUT tag.

732

# Note that relative paths are relative to the directory from which doxygen is

733

# run.

734

735

EXCLUDE =

736

737

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or

738

# directories that are symbolic links (a Unix file system feature) are excluded

739

# from the input.

740

741

EXCLUDE_SYMLINKS = NO

742

743

# If the value of the INPUT tag contains directories, you can use the

744

# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude

745

# certain files from those directories. Note that the wildcards are matched

746

# against the file with absolute path, so to exclude all test directories

747

# for example use the pattern */test/*

748

749

EXCLUDE_PATTERNS = */include/mir_test*

750

751

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

752

# (namespaces, classes, functions, etc.) that should be excluded from the

753

# output. The symbol name can be a fully qualified name, a word, or if the

754

# wildcard * is used, a substring. Examples: ANamespace, AClass,

755

# AClass::ANamespace, ANamespace::*Test

756

757

EXCLUDE_SYMBOLS =

758

759

# The EXAMPLE_PATH tag can be used to specify one or more files or

760

# directories that contain example code fragments that are included (see

761

# the \include command).

762

763

EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@

764

765

# If the value of the EXAMPLE_PATH tag contains directories, you can use the

766

# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

767

# and *.h) to filter out the source-files in the directories. If left

768

# blank all files are included.

769

770

EXAMPLE_PATTERNS = *

771

772

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be

773

# searched for input files to be used with the \include or \dontinclude

774

# commands irrespective of the value of the RECURSIVE tag.

775

# Possible values are YES and NO. If left blank NO is used.

776

777

EXAMPLE_RECURSIVE = NO

778

779

# The IMAGE_PATH tag can be used to specify one or more files or

780

# directories that contain image that are included in the documentation (see

781

# the \image command).

782

783

IMAGE_PATH =

784

785

# The INPUT_FILTER tag can be used to specify a program that doxygen should

786

# invoke to filter for each input file. Doxygen will invoke the filter program

787

# by executing (via popen()) the command <filter> <input-file>, where <filter>

788

# is the value of the INPUT_FILTER tag, and <input-file> is the name of an

789

# input file. Doxygen will then use the output that the filter program writes

790

# to standard output. If FILTER_PATTERNS is specified, this tag will be

791

# ignored.

792

793

INPUT_FILTER =

794

795

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern

796

# basis. Doxygen will compare the file name with each pattern and apply the

797

# filter if there is a match. The filters are a list of the form:

798

# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further

799

# info on how filters are used. If FILTER_PATTERNS is empty or if

800

# non of the patterns match the file name, INPUT_FILTER is applied.

801

802

FILTER_PATTERNS =

803

804

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using

805

# INPUT_FILTER) will be used to filter the input files when producing source

806

# files to browse (i.e. when SOURCE_BROWSER is set to YES).

807

808

FILTER_SOURCE_FILES = NO

809

810

# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file

811

# pattern. A pattern will override the setting for FILTER_PATTERN (if any)

812

# and it is also possible to disable source filtering for a specific pattern

813

# using *.ext= (so without naming a filter). This option only has effect when

814

# FILTER_SOURCE_FILES is enabled.

815

816

FILTER_SOURCE_PATTERNS =

817

818

#---------------------------------------------------------------------------

819

# configuration options related to source browsing

820

#---------------------------------------------------------------------------

821

822

# If the SOURCE_BROWSER tag is set to YES then a list of source files will

823

# be generated. Documented entities will be cross-referenced with these sources.

824

# Note: To get rid of all source code in the generated output, make sure also

825

# VERBATIM_HEADERS is set to NO.

826

827

SOURCE_BROWSER = NO

828

829

# Setting the INLINE_SOURCES tag to YES will include the body

830

# of functions and classes directly in the documentation.

831

832

INLINE_SOURCES = NO

833

834

# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct

835

# doxygen to hide any special comment blocks from generated source code

836

# fragments. Normal C, C++ and Fortran comments will always remain visible.

837

838

STRIP_CODE_COMMENTS = YES

839

840

# If the REFERENCED_BY_RELATION tag is set to YES

841

# then for each documented function all documented

842

# functions referencing it will be listed.

843

844

REFERENCED_BY_RELATION = NO

845

846

# If the REFERENCES_RELATION tag is set to YES

847

# then for each documented function all documented entities

848

# called/used by that function will be listed.

849

850

REFERENCES_RELATION = NO

851

852

# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)

853

# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from

854

# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will

855

# link to the source code. Otherwise they will link to the documentation.

856

857

REFERENCES_LINK_SOURCE = YES

858

859

# If the USE_HTAGS tag is set to YES then the references to source code

860

# will point to the HTML generated by the htags(1) tool instead of doxygen

861

# built-in source browser. The htags tool is part of GNU's global source

862

# tagging system (see http://www.gnu.org/software/global/global.html). You

863

# will need version 4.8.6 or higher.

864

865

USE_HTAGS = NO

866

867

# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen

868

# will generate a verbatim copy of the header file for each class for

869

# which an include is specified. Set to NO to disable this.

870

871

VERBATIM_HEADERS = YES

872

873

#---------------------------------------------------------------------------

874

# configuration options related to the alphabetical class index

875

#---------------------------------------------------------------------------

876

877

# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index

878

# of all compounds will be generated. Enable this if the project

879

# contains a lot of classes, structs, unions or interfaces.

880

881

ALPHABETICAL_INDEX = YES

882

883

# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then

884

# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns

885

# in which this list will be split (can be a number in the range [1..20])

886

887

COLS_IN_ALPHA_INDEX = 5

888

889

# In case all classes in a project start with a common prefix, all

890

# classes will be put under the same header in the alphabetical index.

891

# The IGNORE_PREFIX tag can be used to specify one or more prefixes that

892

# should be ignored while generating the index headers.

893

894

IGNORE_PREFIX =

895

896

#---------------------------------------------------------------------------

897

# configuration options related to the HTML output

898

#---------------------------------------------------------------------------

899

900

# If the GENERATE_HTML tag is set to YES (the default) Doxygen will

901

# generate HTML output.

902

903

GENERATE_HTML = YES

904

905

# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.

906

# If a relative path is entered the value of OUTPUT_DIRECTORY will be

907

# put in front of it. If left blank `html' will be used as the default path.

908

909

HTML_OUTPUT = html

910

911

# The HTML_FILE_EXTENSION tag can be used to specify the file extension for

912

# each generated HTML page (for example: .htm,.php,.asp). If it is left blank

913

# doxygen will generate files with .html extension.

914

915

HTML_FILE_EXTENSION = .html

916

917

# The HTML_HEADER tag can be used to specify a personal HTML header for

918

# each generated HTML page. If it is left blank doxygen will generate a

919

# standard header. Note that when using a custom header you are responsible

920

# for the proper inclusion of any scripts and style sheets that doxygen

921

# needs, which is dependent on the configuration options used.

922

# It is advised to generate a default header using "doxygen -w html

923

# header.html footer.html stylesheet.css YourConfigFile" and then modify

924

# that header. Note that the header is subject to change so you typically

925

# have to redo this when upgrading to a newer version of doxygen or when

926

# changing the value of configuration settings such as GENERATE_TREEVIEW!

927

928

HTML_HEADER =

929

930

# The HTML_FOOTER tag can be used to specify a personal HTML footer for

931

# each generated HTML page. If it is left blank doxygen will generate a

932

# standard footer.

933

934

HTML_FOOTER =

935

936

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading

937

# style sheet that is used by each HTML page. It can be used to

938

# fine-tune the look of the HTML output. If the tag is left blank doxygen

939

# will generate a default style sheet. Note that doxygen will try to copy

940

# the style sheet file to the HTML output directory, so don't put your own

941

# style sheet in the HTML output directory as well, or it will be erased!

942

943

HTML_STYLESHEET =

944

945

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or

946

# other source files which should be copied to the HTML output directory. Note

947

# that these files will be copied to the base HTML output directory. Use the

948

# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these

949

# files. In the HTML_STYLESHEET file, use the file name only. Also note that

950

# the files will be copied as-is; there are no commands or markers available.

951

952

HTML_EXTRA_FILES =

953

954

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.

955

# Doxygen will adjust the colors in the style sheet and background images

956

# according to this color. Hue is specified as an angle on a colorwheel,

957

# see http://en.wikipedia.org/wiki/Hue for more information.

958

# For instance the value 0 represents red, 60 is yellow, 120 is green,

959

# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.

960

# The allowed range is 0 to 359.

961

962

HTML_COLORSTYLE_HUE = 220

963

964

# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of

965

# the colors in the HTML output. For a value of 0 the output will use

966

# grayscales only. A value of 255 will produce the most vivid colors.

967

968

HTML_COLORSTYLE_SAT = 100

969

970

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to

971

# the luminance component of the colors in the HTML output. Values below

972

# 100 gradually make the output lighter, whereas values above 100 make

973

# the output darker. The value divided by 100 is the actual gamma applied,

974

# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,

975

# and 100 does not change the gamma.

976

977

HTML_COLORSTYLE_GAMMA = 80

978

979

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML

980

# page will contain the date and time when the page was generated. Setting

981

# this to NO can help when comparing the output of multiple runs.

982

983

HTML_TIMESTAMP = YES

984

985

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML

986

# documentation will contain sections that can be hidden and shown after the

987

# page has loaded.

988

989

HTML_DYNAMIC_SECTIONS = NO

990

991

# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of

992

# entries shown in the various tree structured indices initially; the user

993

# can expand and collapse entries dynamically later on. Doxygen will expand

994

# the tree to such a level that at most the specified number of entries are

995

# visible (unless a fully collapsed tree already exceeds this amount).

996

# So setting the number of entries 1 will produce a full collapsed tree by

997

# default. 0 is a special value representing an infinite number of entries

998

# and will result in a full expanded tree by default.

999

1000

HTML_INDEX_NUM_ENTRIES = 100

1001

1002

# If the GENERATE_DOCSET tag is set to YES, additional index files

1003

# will be generated that can be used as input for Apple's Xcode 3

1004

# integrated development environment, introduced with OSX 10.5 (Leopard).

1005

# To create a documentation set, doxygen will generate a Makefile in the

1006

# HTML output directory. Running make will produce the docset in that

1007

# directory and running "make install" will install the docset in

1008

# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find

1009

# it at startup.

1010

# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html

1011

# for more information.

1012

1013

GENERATE_DOCSET = NO

1014

1015

# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the

1016

# feed. A documentation feed provides an umbrella under which multiple

1017

# documentation sets from a single provider (such as a company or product suite)

1018

# can be grouped.

1019

1020

DOCSET_FEEDNAME = "Doxygen generated docs"

1021

1022

# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that

1023

# should uniquely identify the documentation set bundle. This should be a

1024

# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen

1025

# will append .docset to the name.

1026

1027

DOCSET_BUNDLE_ID = org.doxygen.Project

1028

1029

# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify

1030

# the documentation publisher. This should be a reverse domain-name style

1031

# string, e.g. com.mycompany.MyDocSet.documentation.

1032

1033

DOCSET_PUBLISHER_ID = org.doxygen.Publisher

1034

1035

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

1036

1037

DOCSET_PUBLISHER_NAME = Publisher

1038

1039

# If the GENERATE_HTMLHELP tag is set to YES, additional index files

1040

# will be generated that can be used as input for tools like the

1041

# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)

1042

# of the generated HTML documentation.

1043

1044

GENERATE_HTMLHELP = NO

1045

1046

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can

1047

# be used to specify the file name of the resulting .chm file. You

1048

# can add a path in front of the file if the result should not be

1049

# written to the html output directory.

1050

1051

CHM_FILE =

1052

1053

# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can

1054

# be used to specify the location (absolute path including file name) of

1055

# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run

1056

# the HTML help compiler on the generated index.hhp.

1057

1058

HHC_LOCATION =

1059

1060

# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag

1061

# controls if a separate .chi index file is generated (YES) or that

1062

# it should be included in the master .chm file (NO).

1063

1064

GENERATE_CHI = NO

1065

1066

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING

1067

# is used to encode HtmlHelp index (hhk), content (hhc) and project file

1068

# content.

1069

1070

CHM_INDEX_ENCODING =

1071

1072

# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag

1073

# controls whether a binary table of contents is generated (YES) or a

1074

# normal table of contents (NO) in the .chm file.

1075

1076

BINARY_TOC = NO

1077

1078

# The TOC_EXPAND flag can be set to YES to add extra items for group members

1079

# to the contents of the HTML help documentation and to the tree view.

1080

1081

TOC_EXPAND = NO

1082

1083

# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and

1084

# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated

1085

# that can be used as input for Qt's qhelpgenerator to generate a

1086

# Qt Compressed Help (.qch) of the generated HTML documentation.

1087

1088

GENERATE_QHP = NO

1089

1090

# If the QHG_LOCATION tag is specified, the QCH_FILE tag can

1091

# be used to specify the file name of the resulting .qch file.

1092

# The path specified is relative to the HTML output folder.

1093

1094

QCH_FILE =

1095

1096

# The QHP_NAMESPACE tag specifies the namespace to use when generating

1097

# Qt Help Project output. For more information please see

1098

# http://doc.trolltech.com/qthelpproject.html#namespace

1099

1100

QHP_NAMESPACE = org.doxygen.Project

1101

1102

# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating

1103

# Qt Help Project output. For more information please see

1104

# http://doc.trolltech.com/qthelpproject.html#virtual-folders

1105

1106

QHP_VIRTUAL_FOLDER = doc

1107

1108

# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to

1109

# add. For more information please see

1110

# http://doc.trolltech.com/qthelpproject.html#custom-filters

1111

1112

QHP_CUST_FILTER_NAME =

1113

1114

# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the

1115

# custom filter to add. For more information please see

1116

# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">

1117

# Qt Help Project / Custom Filters</a>.

1118

1119

QHP_CUST_FILTER_ATTRS =

1120

1121

# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this

1122

# project's

1123

# filter section matches.

1124

# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">

1125

# Qt Help Project / Filter Attributes</a>.

1126

1127

QHP_SECT_FILTER_ATTRS =

1128

1129

# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can

1130

# be used to specify the location of Qt's qhelpgenerator.

1131

# If non-empty doxygen will try to run qhelpgenerator on the generated

1132

# .qhp file.

1133

1134

QHG_LOCATION =

1135

1136

# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files

1137

# will be generated, which together with the HTML files, form an Eclipse help

1138

# plugin. To install this plugin and make it available under the help contents

1139

# menu in Eclipse, the contents of the directory containing the HTML and XML

1140

# files needs to be copied into the plugins directory of eclipse. The name of

1141

# the directory within the plugins directory should be the same as

1142

# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before

1143

# the help appears.

1144

1145

GENERATE_ECLIPSEHELP = NO

1146

1147

# A unique identifier for the eclipse help plugin. When installing the plugin

1148

# the directory name containing the HTML and XML files should also have

1149

# this name.

1150

1151

ECLIPSE_DOC_ID = org.doxygen.Project

1152

1153

# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)

1154

# at top of each HTML page. The value NO (the default) enables the index and

1155

# the value YES disables it. Since the tabs have the same information as the

1156

# navigation tree you can set this option to NO if you already set

1157

# GENERATE_TREEVIEW to YES.

1158

1159

DISABLE_INDEX = NO

1160

1161

# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index

1162

# structure should be generated to display hierarchical information.

1163

# If the tag value is set to YES, a side panel will be generated

1164

# containing a tree-like index structure (just like the one that

1165

# is generated for HTML Help). For this to work a browser that supports

1166

# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).

1167

# Windows users are probably better off using the HTML help feature.

1168

# Since the tree basically has the same information as the tab index you

1169

# could consider to set DISABLE_INDEX to NO when enabling this option.

1170

1171

GENERATE_TREEVIEW = NO

1172

1173

# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values

1174

# (range [0,1..20]) that doxygen will group on one line in the generated HTML

1175

# documentation. Note that a value of 0 will completely suppress the enum

1176

# values from appearing in the overview section.

1177

1178

ENUM_VALUES_PER_LINE = 4

1179

1180

# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be

1181

# used to set the initial width (in pixels) of the frame in which the tree

1182

# is shown.

1183

1184

TREEVIEW_WIDTH = 250

1185

1186

# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open

1187

# links to external symbols imported via tag files in a separate window.

1188

1189

EXT_LINKS_IN_WINDOW = NO

1190

1191

# Use this tag to change the font size of Latex formulas included

1192

# as images in the HTML documentation. The default is 10. Note that

1193

# when you change the font size after a successful doxygen run you need

1194

# to manually remove any form_*.png images from the HTML output directory

1195

# to force them to be regenerated.

1196

1197

FORMULA_FONTSIZE = 10

1198

1199

# Use the FORMULA_TRANPARENT tag to determine whether or not the images

1200

# generated for formulas are transparent PNGs. Transparent PNGs are

1201

# not supported properly for IE 6.0, but are supported on all modern browsers.

1202

# Note that when changing this option you need to delete any form_*.png files

1203

# in the HTML output before the changes have effect.

1204

1205

FORMULA_TRANSPARENT = YES

1206

1207

# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax

1208

# (see http://www.mathjax.org) which uses client side Javascript for the

1209

# rendering instead of using prerendered bitmaps. Use this if you do not

1210

# have LaTeX installed or if you want to formulas look prettier in the HTML

1211

# output. When enabled you may also need to install MathJax separately and

1212

# configure the path to it using the MATHJAX_RELPATH option.

1213

1214

USE_MATHJAX = NO

1215

1216

# When MathJax is enabled you need to specify the location relative to the

1217

# HTML output directory using the MATHJAX_RELPATH option. The destination

1218

# directory should contain the MathJax.js script. For instance, if the mathjax

1219

# directory is located at the same level as the HTML output directory, then

1220

# MATHJAX_RELPATH should be ../mathjax. The default value points to

1221

# the MathJax Content Delivery Network so you can quickly see the result without

1222

# installing MathJax. However, it is strongly recommended to install a local

1223

# copy of MathJax from http://www.mathjax.org before deployment.

1224

1225

MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest

1226

1227

# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension

1228

# names that should be enabled during MathJax rendering.

1229

1230

MATHJAX_EXTENSIONS =

1231

1232

# When the SEARCHENGINE tag is enabled doxygen will generate a search box

1233

# for the HTML output. The underlying search engine uses javascript

1234

# and DHTML and should work on any modern browser. Note that when using

1235

# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets

1236

# (GENERATE_DOCSET) there is already a search function so this one should

1237

# typically be disabled. For large projects the javascript based search engine

1238

# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

1239

1240

SEARCHENGINE = YES

1241

1242

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be

1243

# implemented using a PHP enabled web server instead of at the web client

1244

# using Javascript. Doxygen will generate the search PHP script and index

1245

# file to put on the web server. The advantage of the server

1246

# based approach is that it scales better to large projects and allows

1247

# full text search. The disadvantages are that it is more difficult to setup

1248

# and does not have live searching capabilities.

1249

1250

SERVER_BASED_SEARCH = NO

1251

1252

#---------------------------------------------------------------------------

1253

# configuration options related to the LaTeX output

1254

#---------------------------------------------------------------------------

1255

1256

# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will

1257

# generate Latex output.

1258

1259

GENERATE_LATEX = NO

1260

1261

# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.

1262

# If a relative path is entered the value of OUTPUT_DIRECTORY will be

1263

# put in front of it. If left blank `latex' will be used as the default path.

1264

1265

LATEX_OUTPUT = latex

1266

1267

# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be

1268

# invoked. If left blank `latex' will be used as the default command name.

1269

# Note that when enabling USE_PDFLATEX this option is only used for

1270

# generating bitmaps for formulas in the HTML output, but not in the

1271

# Makefile that is written to the output directory.

1272

1273

LATEX_CMD_NAME = latex

1274

1275

# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to

1276

# generate index for LaTeX. If left blank `makeindex' will be used as the

1277

# default command name.

1278

1279

MAKEINDEX_CMD_NAME = makeindex

1280

1281

# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact

1282

# LaTeX documents. This may be useful for small projects and may help to

1283

# save some trees in general.

1284

1285

COMPACT_LATEX = NO

1286

1287

# The PAPER_TYPE tag can be used to set the paper type that is used

1288

# by the printer. Possible values are: a4, letter, legal and

1289

# executive. If left blank a4wide will be used.

1290

1291

PAPER_TYPE = a4

1292

1293

# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX

1294

# packages that should be included in the LaTeX output.

1295

1296

EXTRA_PACKAGES =

1297

1298

# The LATEX_HEADER tag can be used to specify a personal LaTeX header for

1299

# the generated latex document. The header should contain everything until

1300

# the first chapter. If it is left blank doxygen will generate a

1301

# standard header. Notice: only use this tag if you know what you are doing!

1302

1303

LATEX_HEADER =

1304

1305

# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for

1306

# the generated latex document. The footer should contain everything after

1307

# the last chapter. If it is left blank doxygen will generate a

1308

# standard footer. Notice: only use this tag if you know what you are doing!

1309

1310

LATEX_FOOTER =

1311

1312

# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated

1313

# is prepared for conversion to pdf (using ps2pdf). The pdf file will

1314

# contain links (just like the HTML output) instead of page references

1315

# This makes the output suitable for online browsing using a pdf viewer.

1316

1317

PDF_HYPERLINKS = YES

1318

1319

# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of

1320

# plain latex in the generated Makefile. Set this option to YES to get a

1321

# higher quality PDF documentation.

1322

1323

USE_PDFLATEX = YES

1324

1325

# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.

1326

# command to the generated LaTeX files. This will instruct LaTeX to keep

1327

# running if errors occur, instead of asking the user for help.

1328

# This option is also used when generating formulas in HTML.

1329

1330

LATEX_BATCHMODE = NO

1331

1332

# If LATEX_HIDE_INDICES is set to YES then doxygen will not

1333

# include the index chapters (such as File Index, Compound Index, etc.)

1334

# in the output.

1335

1336

LATEX_HIDE_INDICES = NO

1337

1338

# If LATEX_SOURCE_CODE is set to YES then doxygen will include

1339

# source code with syntax highlighting in the LaTeX output.

1340

# Note that which sources are shown also depends on other settings

1341

# such as SOURCE_BROWSER.

1342

1343

LATEX_SOURCE_CODE = NO

1344

1345

# The LATEX_BIB_STYLE tag can be used to specify the style to use for the

1346

# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See

1347

# http://en.wikipedia.org/wiki/BibTeX for more info.

1348

1349

LATEX_BIB_STYLE = plain

1350

1351

#---------------------------------------------------------------------------

1352

# configuration options related to the RTF output

1353

#---------------------------------------------------------------------------

1354

1355

# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output

1356

# The RTF output is optimized for Word 97 and may not look very pretty with

1357

# other RTF readers or editors.

1358

1359

GENERATE_RTF = NO

1360

1361

# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.

1362

# If a relative path is entered the value of OUTPUT_DIRECTORY will be

1363

# put in front of it. If left blank `rtf' will be used as the default path.

1364

1365

RTF_OUTPUT = rtf

1366

1367

# If the COMPACT_RTF tag is set to YES Doxygen generates more compact

1368

# RTF documents. This may be useful for small projects and may help to

1369

# save some trees in general.

1370

1371

COMPACT_RTF = NO

1372

1373

# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated

1374

# will contain hyperlink fields. The RTF file will

1375

# contain links (just like the HTML output) instead of page references.

1376

# This makes the output suitable for online browsing using WORD or other

1377

# programs which support those fields.

1378

# Note: wordpad (write) and others do not support links.

1379

1380

RTF_HYPERLINKS = NO

1381

1382

# Load style sheet definitions from file. Syntax is similar to doxygen's

1383

# config file, i.e. a series of assignments. You only have to provide

1384

# replacements, missing definitions are set to their default value.

1385

1386

RTF_STYLESHEET_FILE =

1387

1388

# Set optional variables used in the generation of an rtf document.

1389

# Syntax is similar to doxygen's config file.

1390

1391

RTF_EXTENSIONS_FILE =

1392

1393

#---------------------------------------------------------------------------

1394

# configuration options related to the man page output

1395

#---------------------------------------------------------------------------

1396

1397

# If the GENERATE_MAN tag is set to YES (the default) Doxygen will

1398

# generate man pages

1399

1400

GENERATE_MAN = NO

1401

1402

# The MAN_OUTPUT tag is used to specify where the man pages will be put.

1403

# If a relative path is entered the value of OUTPUT_DIRECTORY will be

1404

# put in front of it. If left blank `man' will be used as the default path.

1405

1406

MAN_OUTPUT = man

1407

1408

# The MAN_EXTENSION tag determines the extension that is added to

1409

# the generated man pages (default is the subroutine's section .3)

1410

1411

MAN_EXTENSION = .3

1412

1413

# If the MAN_LINKS tag is set to YES and Doxygen generates man output,

1414

# then it will generate one additional man file for each entity

1415

# documented in the real man page(s). These additional files

1416

# only source the real man page, but without them the man command

1417

# would be unable to find the correct page. The default is NO.

1418

1419

MAN_LINKS = NO

1420

1421

#---------------------------------------------------------------------------

1422

# configuration options related to the XML output

1423

#---------------------------------------------------------------------------

1424

1425

# If the GENERATE_XML tag is set to YES Doxygen will

1426

# generate an XML file that captures the structure of

1427

# the code including all documentation.

1428

1429

GENERATE_XML = NO

1430

1431

# The XML_OUTPUT tag is used to specify where the XML pages will be put.

1432

# If a relative path is entered the value of OUTPUT_DIRECTORY will be

1433

# put in front of it. If left blank `xml' will be used as the default path.

1434

1435

XML_OUTPUT = xml

1436

1437

# The XML_SCHEMA tag can be used to specify an XML schema,

1438

# which can be used by a validating XML parser to check the

1439

# syntax of the XML files.

1440

1441

XML_SCHEMA =

1442

1443

# The XML_DTD tag can be used to specify an XML DTD,

1444

# which can be used by a validating XML parser to check the

1445

# syntax of the XML files.

1446

1447

XML_DTD =

1448

1449

# If the XML_PROGRAMLISTING tag is set to YES Doxygen will

1450

# dump the program listings (including syntax highlighting

1451

# and cross-referencing information) to the XML output. Note that

1452

# enabling this will significantly increase the size of the XML output.

1453

1454

XML_PROGRAMLISTING = YES

1455

1456

#---------------------------------------------------------------------------

1457

# configuration options for the AutoGen Definitions output

1458

#---------------------------------------------------------------------------

1459

1460

# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will

1461

# generate an AutoGen Definitions (see autogen.sf.net) file

1462

# that captures the structure of the code including all

1463

# documentation. Note that this feature is still experimental

1464

# and incomplete at the moment.

1465

1466

GENERATE_AUTOGEN_DEF = NO

1467

1468

#---------------------------------------------------------------------------

1469

# configuration options related to the Perl module output

1470

#---------------------------------------------------------------------------

1471

1472

# If the GENERATE_PERLMOD tag is set to YES Doxygen will

1473

# generate a Perl module file that captures the structure of

1474

# the code including all documentation. Note that this

1475

# feature is still experimental and incomplete at the

1476

# moment.

1477

1478

GENERATE_PERLMOD = NO

1479

1480

# If the PERLMOD_LATEX tag is set to YES Doxygen will generate

1481

# the necessary Makefile rules, Perl scripts and LaTeX code to be able

1482

# to generate PDF and DVI output from the Perl module output.

1483

1484

PERLMOD_LATEX = NO

1485

1486

# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be

1487

# nicely formatted so it can be parsed by a human reader. This is useful

1488

# if you want to understand what is going on. On the other hand, if this

1489

# tag is set to NO the size of the Perl module output will be much smaller

1490

# and Perl will parse it just the same.

1491

1492

PERLMOD_PRETTY = YES

1493

1494

# The names of the make variables in the generated doxyrules.make file

1495

# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.

1496

# This is useful so different doxyrules.make files included by the same

1497

# Makefile don't overwrite each other's variables.

1498

1499

PERLMOD_MAKEVAR_PREFIX =

1500

1501

#---------------------------------------------------------------------------

1502

# Configuration options related to the preprocessor

1503

#---------------------------------------------------------------------------

1504

1505

# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will

1506

# evaluate all C-preprocessor directives found in the sources and include

1507

# files.

1508

1509

ENABLE_PREPROCESSING = YES

1510

1511

# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro

1512

# names in the source code. If set to NO (the default) only conditional

1513

# compilation will be performed. Macro expansion can be done in a controlled

1514

# way by setting EXPAND_ONLY_PREDEF to YES.

1515

1516

MACRO_EXPANSION = NO

1517

1518

# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES

1519

# then the macro expansion is limited to the macros specified with the

1520

# PREDEFINED and EXPAND_AS_DEFINED tags.

1521

1522

EXPAND_ONLY_PREDEF = NO

1523

1524

# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files

1525

# pointed to by INCLUDE_PATH will be searched when a #include is found.

1526

1527

SEARCH_INCLUDES = YES

1528

1529

# The INCLUDE_PATH tag can be used to specify one or more directories that

1530

# contain include files that are not input files but should be processed by

1531

# the preprocessor.

1532

1533

INCLUDE_PATH =

1534

1535

# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard

1536

# patterns (like *.h and *.hpp) to filter out the header-files in the

1537

# directories. If left blank, the patterns specified with FILE_PATTERNS will

1538

# be used.

1539

1540

INCLUDE_FILE_PATTERNS =

1541

1542

# The PREDEFINED tag can be used to specify one or more macro names that

1543

# are defined before the preprocessor is started (similar to the -D option of

1544

# gcc). The argument of the tag is a list of macros of the form: name

1545

# or name=definition (no spaces). If the definition and the = are

1546

# omitted =1 is assumed. To prevent a macro definition from being

1547

# undefined via #undef or recursively expanded use the := operator

1548

# instead of the = operator.

1549

1550

PREDEFINED =

1551

1552

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then

1553

# this tag can be used to specify a list of macro names that should be expanded.

1554

# The macro definition that is found in the sources will be used.

1555

# Use the PREDEFINED tag if you want to use a different macro definition that

1556

# overrules the definition found in the source code.

1557

1558

EXPAND_AS_DEFINED =

1559

1560

# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then

1561

# doxygen's preprocessor will remove all references to function-like macros

1562

# that are alone on a line, have an all uppercase name, and do not end with a

1563

# semicolon, because these will confuse the parser if not removed.

1564

1565

SKIP_FUNCTION_MACROS = YES

1566

1567

#---------------------------------------------------------------------------

1568

# Configuration::additions related to external references

1569

#---------------------------------------------------------------------------

1570

1571

# The TAGFILES option can be used to specify one or more tagfiles. For each

1572

# tag file the location of the external documentation should be added. The

1573

# format of a tag file without this location is as follows:

1574

# TAGFILES = file1 file2 ...

1575

# Adding location for the tag files is done as follows:

1576

# TAGFILES = file1=loc1 "file2 = loc2" ...

1577

# where "loc1" and "loc2" can be relative or absolute paths

1578

# or URLs. Note that each tag file must have a unique name (where the name does

1579

# NOT include the path). If a tag file is not located in the directory in which

1580

# doxygen is run, you must also specify the path to the tagfile here.

1581

1582

TAGFILES =

1583

1584

# When a file name is specified after GENERATE_TAGFILE, doxygen will create

1585

# a tag file that is based on the input files it reads.

1586

1587

GENERATE_TAGFILE =

1588

1589

# If the ALLEXTERNALS tag is set to YES all external classes will be listed

1590

# in the class index. If set to NO only the inherited external classes

1591

# will be listed.

1592

1593

ALLEXTERNALS = NO

1594

1595

# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed

1596

# in the modules index. If set to NO, only the current project's groups will

1597

# be listed.

1598

1599

EXTERNAL_GROUPS = YES

1600

1601

# The PERL_PATH should be the absolute path and name of the perl script

1602

# interpreter (i.e. the result of `which perl').

1603

1604

PERL_PATH = /usr/bin/perl

1605

1606

#---------------------------------------------------------------------------

1607

# Configuration options related to the dot tool

1608

#---------------------------------------------------------------------------

1609

1610

# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will

1611

# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base

1612

# or super classes. Setting the tag to NO turns the diagrams off. Note that

1613

# this option also works with HAVE_DOT disabled, but it is recommended to

1614

# install and use dot, since it yields more powerful graphs.

1615

1616

CLASS_DIAGRAMS = YES

1617

1618

# You can define message sequence charts within doxygen comments using the \msc

1619

# command. Doxygen will then run the mscgen tool (see

1620

# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the

1621

# documentation. The MSCGEN_PATH tag allows you to specify the directory where

1622

# the mscgen tool resides. If left empty the tool is assumed to be found in the

1623

# default search path.

1624

1625

MSCGEN_PATH =

1626

1627

# If set to YES, the inheritance and collaboration graphs will hide

1628

# inheritance and usage relations if the target is undocumented

1629

# or is not a class.

1630

1631

HIDE_UNDOC_RELATIONS = YES

1632

1633

# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is

1634

# available from the path. This tool is part of Graphviz, a graph visualization

1635

# toolkit from AT&T and Lucent Bell Labs. The other options in this section

1636

# have no effect if this option is set to NO (the default)

1637

1638

HAVE_DOT = NO

1639

1640

# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is

1641

# allowed to run in parallel. When set to 0 (the default) doxygen will

1642

# base this on the number of processors available in the system. You can set it

1643

# explicitly to a value larger than 0 to get control over the balance

1644

# between CPU load and processing speed.

1645

1646

DOT_NUM_THREADS = 0

1647

1648

# By default doxygen will use the Helvetica font for all dot files that

1649

# doxygen generates. When you want a differently looking font you can specify

1650

# the font name using DOT_FONTNAME. You need to make sure dot is able to find

1651

# the font, which can be done by putting it in a standard location or by setting

1652

# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the

1653

# directory containing the font.

1654

1655

DOT_FONTNAME = Helvetica

1656

1657

# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.

1658

# The default size is 10pt.

1659

1660

DOT_FONTSIZE = 10

1661

1662

# By default doxygen will tell dot to use the Helvetica font.

1663

# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to

1664

# set the path where dot can find it.

1665

1666

DOT_FONTPATH =

1667

1668

# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen

1669

# will generate a graph for each documented class showing the direct and

1670

# indirect inheritance relations. Setting this tag to YES will force the

1671

# CLASS_DIAGRAMS tag to NO.

1672

1673

CLASS_GRAPH = YES

1674

1675

# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen

1676

# will generate a graph for each documented class showing the direct and

1677

# indirect implementation dependencies (inheritance, containment, and

1678

# class references variables) of the class with other documented classes.

1679

1680

COLLABORATION_GRAPH = YES

1681

1682

# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen

1683

# will generate a graph for groups, showing the direct groups dependencies

1684

1685

GROUP_GRAPHS = YES

1686

1687

# If the UML_LOOK tag is set to YES doxygen will generate inheritance and

1688

# collaboration diagrams in a style similar to the OMG's Unified Modeling

1689

# Language.

1690

1691

UML_LOOK = NO

1692

1693

# If the UML_LOOK tag is enabled, the fields and methods are shown inside

1694

# the class node. If there are many fields or methods and many nodes the

1695

# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS

1696

# threshold limits the number of items for each type to make the size more

1697

# managable. Set this to 0 for no limit. Note that the threshold may be

1698

# exceeded by 50% before the limit is enforced.

1699

1700

UML_LIMIT_NUM_FIELDS = 10

1701

1702

# If set to YES, the inheritance and collaboration graphs will show the

1703

# relations between templates and their instances.

1704

1705

TEMPLATE_RELATIONS = NO

1706

1707

# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT

1708

# tags are set to YES then doxygen will generate a graph for each documented

1709

# file showing the direct and indirect include dependencies of the file with

1710

# other documented files.

1711

1712

INCLUDE_GRAPH = YES

1713

1714

# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and

1715

# HAVE_DOT tags are set to YES then doxygen will generate a graph for each

1716

# documented header file showing the documented files that directly or

1717

# indirectly include this file.

1718

1719

INCLUDED_BY_GRAPH = YES

1720

1721

# If the CALL_GRAPH and HAVE_DOT options are set to YES then

1722

# doxygen will generate a call dependency graph for every global function

1723

# or class method. Note that enabling this option will significantly increase

1724

# the time of a run. So in most cases it will be better to enable call graphs

1725

# for selected functions only using the \callgraph command.

1726

1727

CALL_GRAPH = NO

1728

1729

# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then

1730

# doxygen will generate a caller dependency graph for every global function

1731

# or class method. Note that enabling this option will significantly increase

1732

# the time of a run. So in most cases it will be better to enable caller

1733

# graphs for selected functions only using the \callergraph command.

1734

1735

CALLER_GRAPH = NO

1736

1737

# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen

1738

# will generate a graphical hierarchy of all classes instead of a textual one.

1739

1740

GRAPHICAL_HIERARCHY = YES

1741

1742

# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES

1743

# then doxygen will show the dependencies a directory has on other directories

1744

# in a graphical way. The dependency relations are determined by the #include

1745

# relations between the files in the directories.

1746

1747

DIRECTORY_GRAPH = YES

1748

1749

# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images

1750

# generated by dot. Possible values are svg, png, jpg, or gif.

1751

# If left blank png will be used. If you choose svg you need to set

1752

# HTML_FILE_EXTENSION to xhtml in order to make the SVG files

1753

# visible in IE 9+ (other browsers do not have this requirement).

1754

1755

DOT_IMAGE_FORMAT = png

1756

1757

# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to

1758

# enable generation of interactive SVG images that allow zooming and panning.

1759

# Note that this requires a modern browser other than Internet Explorer.

1760

# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you

1761

# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files

1762

# visible. Older versions of IE do not have SVG support.

1763

1764

INTERACTIVE_SVG = NO

1765

1766

# The tag DOT_PATH can be used to specify the path where the dot tool can be

1767

# found. If left blank, it is assumed the dot tool can be found in the path.

1768

1769

DOT_PATH =

1770

1771

# The DOTFILE_DIRS tag can be used to specify one or more directories that

1772

# contain dot files that are included in the documentation (see the

1773

# \dotfile command).

1774

1775

DOTFILE_DIRS =

1776

1777

# The MSCFILE_DIRS tag can be used to specify one or more directories that

1778

# contain msc files that are included in the documentation (see the

1779

# \mscfile command).

1780

1781

MSCFILE_DIRS =

1782

1783

# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of

1784

# nodes that will be shown in the graph. If the number of nodes in a graph

1785

# becomes larger than this value, doxygen will truncate the graph, which is

1786

# visualized by representing a node as a red box. Note that doxygen if the

1787

# number of direct children of the root node in a graph is already larger than

1788

# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note

1789

# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.

1790

1791

DOT_GRAPH_MAX_NODES = 50

1792

1793

# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the

1794

# graphs generated by dot. A depth value of 3 means that only nodes reachable

1795

# from the root by following a path via at most 3 edges will be shown. Nodes

1796

# that lay further from the root node will be omitted. Note that setting this

1797

# option to 1 or 2 may greatly reduce the computation time needed for large

1798

# code bases. Also note that the size of a graph can be further restricted by

1799

# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.

1800

1801

MAX_DOT_GRAPH_DEPTH = 0

1802

1803

# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent

1804

# background. This is disabled by default, because dot on Windows does not

1805

# seem to support this out of the box. Warning: Depending on the platform used,

1806

# enabling this option may lead to badly anti-aliased labels on the edges of

1807

# a graph (i.e. they become hard to read).

1808

1809

DOT_TRANSPARENT = NO

1810

1811

# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output

1812

# files in one run (i.e. multiple -o and -T options on the command line). This

1813

# makes dot run faster, but since only newer versions of dot (>1.8.10)

1814

# support this, this feature is disabled by default.

1815

1816

DOT_MULTI_TARGETS = NO

1817

1818

# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will

1819

# generate a legend page explaining the meaning of the various boxes and

1820

# arrows in the dot generated graphs.

1821

1822

GENERATE_LEGEND = YES

1823

1824

# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will

1825

# remove the intermediate dot files that are used to generate

1826

# the various graphs.

1827

1828

DOT_CLEANUP = YES