~chasedouglas/frame/ubuntu-upstream-xi : revision 40

1

# Doxyfile 1.7.4

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 a sequence of words surrounded

26

# by quotes) that should identify the project.

27

28

PROJECT_NAME = uTouch-Frame

29

30

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

31

# This could be handy for archiving the generated documentation or

32

# if some version control system is used.

33

34

PROJECT_NUMBER = 2.0

35

36

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

37

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

38

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

39

40

PROJECT_BRIEF = "A library to encapsulate touch events"

41

42

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

43

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

44

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

45

# Doxygen will copy the logo to the output directory.

46

47

PROJECT_LOGO =

48

49

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

50

# base path where the generated documentation will be put.

51

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

52

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

53

54

OUTPUT_DIRECTORY = api

55

56

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

57

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

58

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

59

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

60

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

61

# otherwise cause performance problems for the file system.

62

63

CREATE_SUBDIRS = NO

64

65

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

66

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

67

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

68

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

69

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

70

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

71

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

72

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

73

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

74

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

75

76

OUTPUT_LANGUAGE = English

77

78

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

79

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

80

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

81

# Set to NO to disable this.

82

83

BRIEF_MEMBER_DESC = YES

84

85

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

86

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

87

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

88

# brief descriptions will be completely suppressed.

89

90

REPEAT_BRIEF = YES

91

92

# This tag implements a quasi-intelligent brief description abbreviator

93

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

94

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

95

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

96

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

97

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

98

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

99

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

100

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

101

102

ABBREVIATE_BRIEF = "The $name class" \

103

"The $name widget" \

104

"The $name file" \

105

is \

106

provides \

107

specifies \

108

contains \

109

represents \

110

a \

111

an \

112

the

113

114

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

115

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

116

# description.

117

118

ALWAYS_DETAILED_SEC = NO

119

120

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

121

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

122

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

123

# operators of the base classes will not be shown.

124

125

INLINE_INHERITED_MEMB = NO

126

127

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

128

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

129

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

130

131

FULL_PATH_NAMES = NO

132

133

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

134

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

135

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

136

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

137

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

138

# path to strip.

139

140

STRIP_FROM_PATH =

141

142

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

143

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

144

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

145

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

146

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

147

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

148

149

STRIP_FROM_INC_PATH =

150

151

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

152

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

153

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

154

155

SHORT_NAMES = NO

156

157

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen

158

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

159

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

160

# comments will behave just like regular Qt-style comments

161

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

162

163

JAVADOC_AUTOBRIEF = YES

164

165

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

166

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

167

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

168

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

169

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

170

171

QT_AUTOBRIEF = NO

172

173

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

174

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

175

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

176

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

177

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

178

179

MULTILINE_CPP_IS_BRIEF = NO

180

181

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

182

# member inherits the documentation from any documented member that it

183

# re-implements.

184

185

INHERIT_DOCS = YES

186

187

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

188

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

189

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

190

191

SEPARATE_MEMBER_PAGES = NO

192

193

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

194

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

195

196

TAB_SIZE = 8

197

198

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

199

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

200

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

201

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

202

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

203

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

204

205

ALIASES =

206

207

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

208

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

209

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

210

# of all members will be omitted, etc.

211

212

OPTIMIZE_OUTPUT_FOR_C = YES

213

214

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

215

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

216

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

217

# scopes will look different, etc.

218

219

OPTIMIZE_OUTPUT_JAVA = NO

220

221

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

222

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

223

# Fortran.

224

225

OPTIMIZE_FOR_FORTRAN = NO

226

227

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

228

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

229

# VHDL.

230

231

OPTIMIZE_OUTPUT_VHDL = NO

232

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

243

EXTENSION_MAPPING =

244

245

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

246

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

247

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

248

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

249

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

250

# diagrams that involve STL classes more complete and accurate.

251

252

BUILTIN_STL_SUPPORT = NO

253

254

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

255

# enable parsing support.

256

257

CPP_CLI_SUPPORT = NO

258

259

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

260

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

261

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

262

263

SIP_SUPPORT = NO

264

265

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

266

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

267

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

268

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

269

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

270

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

271

272

IDL_PROPERTY_SUPPORT = YES

273

274

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

275

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

276

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

277

# all members of a group must be documented explicitly.

278

279

DISTRIBUTE_GROUP_DOC = NO

280

281

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

282

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

283

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

284

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

285

# the \nosubgrouping command.

286

287

SUBGROUPING = YES

288

289

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

290

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

291

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

292

# section (for LaTeX and RTF).

293

294

INLINE_GROUPED_CLASSES = YES

295

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

304

TYPEDEF_HIDES_STRUCT = YES

305

306

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

307

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

308

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

309

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

310

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

311

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

312

# causing a significant performance penalty.

313

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

314

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

315

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

316

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

317

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

318

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

319

320

SYMBOL_CACHE_SIZE = 0

321

322

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

323

# Build related configuration options

324

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

325

326

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

327

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

328

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

329

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

330

331

EXTRACT_ALL = YES

332

333

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

334

# will be included in the documentation.

335

336

EXTRACT_PRIVATE = NO

337

338

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

339

# will be included in the documentation.

340

341

EXTRACT_STATIC = NO

342

343

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

344

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

345

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

346

347

EXTRACT_LOCAL_CLASSES = YES

348

349

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

350

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

351

# the interface are included in the documentation.

352

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

353

354

EXTRACT_LOCAL_METHODS = NO

355

356

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

357

# extracted and appear in the documentation as a namespace called

358

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

359

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

360

# anonymous namespaces are hidden.

361

362

EXTRACT_ANON_NSPACES = NO

363

364

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

365

# undocumented members of documented classes, files or namespaces.

366

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

367

# various overviews, but no documentation section is generated.

368

# This option has no effect if EXTRACT_ALL is enabled.

369

370

HIDE_UNDOC_MEMBERS = NO

371

372

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

373

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

374

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

375

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

376

377

HIDE_UNDOC_CLASSES = NO

378

379

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

380

# friend (class|struct|union) declarations.

381

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

382

# documentation.

383

384

HIDE_FRIEND_COMPOUNDS = NO

385

386

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

387

# documentation blocks found inside the body of a function.

388

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

389

# function's detailed documentation block.

390

391

HIDE_IN_BODY_DOCS = NO

392

393

# The INTERNAL_DOCS tag determines if documentation

394

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

395

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

396

# Set it to YES to include the internal documentation.

397

398

INTERNAL_DOCS = NO

399

400

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

401

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

402

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

403

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

404

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

405

406

CASE_SENSE_NAMES = NO

407

408

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

409

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

410

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

411

412

HIDE_SCOPE_NAMES = YES

413

414

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

415

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

416

# of that file.

417

418

SHOW_INCLUDE_FILES = NO

419

420

# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen

421

# will list include files with double quotes in the documentation

422

# rather than with sharp brackets.

423

424

FORCE_LOCAL_INCLUDES = NO

425

426

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

427

# is inserted in the documentation for inline members.

428

429

INLINE_INFO = YES

430

431

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

432

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

433

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

434

# declaration order.

435

436

SORT_MEMBER_DOCS = NO

437

438

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

439

# brief documentation of file, namespace and class members alphabetically

440

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

441

# declaration order.

442

443

SORT_BRIEF_DOCS = NO

444

445

# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen

446

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

447

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

448

# the constructors will appear in the respective orders defined by

449

# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.

450

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

451

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

452

453

SORT_MEMBERS_CTORS_1ST = NO

454

455

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

456

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

457

# the group names will appear in their defined order.

458

459

SORT_GROUP_NAMES = NO

460

461

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

462

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

463

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

464

# not including the namespace part.

465

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

466

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

467

# alphabetical list.

468

469

SORT_BY_SCOPE_NAME = NO

470

471

# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to

472

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

473

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

474

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

475

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

476

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

477

478

STRICT_PROTO_MATCHING = NO

479

480

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

481

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

482

# commands in the documentation.

483

484

GENERATE_TODOLIST = YES

485

486

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

487

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

488

# commands in the documentation.

489

490

GENERATE_TESTLIST = YES

491

492

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

493

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

494

# commands in the documentation.

495

496

GENERATE_BUGLIST = YES

497

498

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

499

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

500

# \deprecated commands in the documentation.

501

502

GENERATE_DEPRECATEDLIST= YES

503

504

# The ENABLED_SECTIONS tag can be used to enable conditional

505

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

506

507

ENABLED_SECTIONS =

508

509

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines

510

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

511

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

512

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

513

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

514

# documentation can be controlled using \showinitializer or \hideinitializer

515

# command in the documentation regardless of this setting.

516

517

MAX_INITIALIZER_LINES = 30

518

519

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

520

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

521

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

522

523

SHOW_USED_FILES = YES

524

525

# If the sources in your project are distributed over multiple directories

526

# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy

527

# in the documentation. The default is NO.

528

529

SHOW_DIRECTORIES = NO

530

531

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

532

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

533

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

534

535

SHOW_FILES = NO

536

537

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

538

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

539

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

540

541

SHOW_NAMESPACES = NO

542

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

551

FILE_VERSION_FILTER =

552

553

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

554

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

555

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

556

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

557

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

558

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

559

560

LAYOUT_FILE =

561

562

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

563

# configuration options related to warning and progress messages

564

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

565

566

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

567

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

568

569

QUIET = NO

570

571

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

572

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

573

# NO is used.

574

575

WARNINGS = YES

576

577

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

578

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

579

# automatically be disabled.

580

581

WARN_IF_UNDOCUMENTED = YES

582

583

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

584

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

585

# parameters in a documented function, or documenting parameters that

586

# don't exist or using markup commands wrongly.

587

588

WARN_IF_DOC_ERROR = YES

589

590

# The WARN_NO_PARAMDOC option can be enabled to get warnings for

591

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

592

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

593

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

594

# documentation.

595

596

WARN_NO_PARAMDOC = NO

597

598

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

599

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

600

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

601

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

602

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

603

# be obtained via FILE_VERSION_FILTER)

604

605

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

606

607

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

608

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

609

# to stderr.

610

611

WARN_LOGFILE =

612

613

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

614

# configuration options related to the input files

615

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

616

617

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

618

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

619

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

620

# with spaces.

621

622

INPUT = ../include/utouch

623

624

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

625

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

626

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

627

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

628

# the list of possible encodings.

629

630

INPUT_ENCODING = UTF-8

631

632

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

633

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

634

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

635

# blank the following patterns are tested:

636

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

637

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

638

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

639

640

FILE_PATTERNS = *.c \

641

*.cc \

642

*.cxx \

643

*.cpp \

644

*.c++ \

645

*.d \

646

*.java \

647

*.ii \

648

*.ixx \

649

*.ipp \

650

*.i++ \

651

*.inl \

652

*.h \

653

*.hh \

654

*.hxx \

655

*.hpp \

656

*.h++ \

657

*.idl \

658

*.odl \

659

*.cs \

660

*.php \

661

*.php3 \

662

*.inc \

663

*.m \

664

*.mm \

665

*.dox \

666

*.py \

667

*.f90 \

668

*.f \

669

*.for \

670

*.vhd \

671

*.vhdl

672

673

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

674

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

675

# If left blank NO is used.

676

677

RECURSIVE = NO

678

679

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

680

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

681

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

682

683

EXCLUDE =

684

685

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

686

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

687

# from the input.

688

689

EXCLUDE_SYMLINKS = NO

690

691

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

692

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

693

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

694

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

695

# for example use the pattern */test/*

696

697

EXCLUDE_PATTERNS =

698

699

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

700

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

701

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

702

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

703

# AClass::ANamespace, ANamespace::*Test

704

705

EXCLUDE_SYMBOLS =

706

707

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

708

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

709

# the \include command).

710

711

EXAMPLE_PATH =

712

713

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

714

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

715

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

716

# blank all files are included.

717

718

EXAMPLE_PATTERNS = *

719

720

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

721

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

722

# commands irrespective of the value of the RECURSIVE tag.

723

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

724

725

EXAMPLE_RECURSIVE = NO

726

727

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

728

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

729

# the \image command).

730

731

IMAGE_PATH =

732

733

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

734

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

735

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

736

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

737

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

738

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

739

# ignored.

740

741

INPUT_FILTER =

742

743

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

744

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

745

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

746

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

747

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

748

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

749

750

FILTER_PATTERNS =

751

752

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

753

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

754

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

755

756

FILTER_SOURCE_FILES = NO

757

758

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

759

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

760

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

761

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

762

# FILTER_SOURCE_FILES is enabled.

763

764

FILTER_SOURCE_PATTERNS =

765

766

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

767

# configuration options related to source browsing

768

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

769

770

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

771

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

772

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

773

# VERBATIM_HEADERS is set to NO.

774

775

SOURCE_BROWSER = NO

776

777

# Setting the INLINE_SOURCES tag to YES will include the body

778

# of functions and classes directly in the documentation.

779

780

INLINE_SOURCES = NO

781

782

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

783

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

784

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

785

786

STRIP_CODE_COMMENTS = YES

787

788

# If the REFERENCED_BY_RELATION tag is set to YES

789

# then for each documented function all documented

790

# functions referencing it will be listed.

791

792

REFERENCED_BY_RELATION = NO

793

794

# If the REFERENCES_RELATION tag is set to YES

795

# then for each documented function all documented entities

796

# called/used by that function will be listed.

797

798

REFERENCES_RELATION = NO

799

800

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

801

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

802

# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will

803

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

804

805

REFERENCES_LINK_SOURCE = YES

806

807

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

808

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

809

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

810

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

811

# will need version 4.8.6 or higher.

812

813

USE_HTAGS = NO

814

815

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

816

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

817

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

818

819

VERBATIM_HEADERS = NO

820

821

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

822

# configuration options related to the alphabetical class index

823

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

824

825

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

826

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

827

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

828

829

ALPHABETICAL_INDEX = NO

830

831

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

832

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

833

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

834

835

COLS_IN_ALPHA_INDEX = 5

836

837

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

838

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

839

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

840

# should be ignored while generating the index headers.

841

842

IGNORE_PREFIX =

843

844

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

845

# configuration options related to the HTML output

846

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

847

848

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

849

# generate HTML output.

850

851

GENERATE_HTML = YES

852

853

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

854

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

855

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

856

857

HTML_OUTPUT = html

858

859

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

860

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

861

# doxygen will generate files with .html extension.

862

863

HTML_FILE_EXTENSION = .html

864

865

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

866

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

867

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

868

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

869

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

870

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

871

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

872

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

873

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

874

# changing the value of configuration settings such as GENERATE_TREEVIEW!

875

876

HTML_HEADER =

877

878

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

879

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

880

# standard footer.

881

882

HTML_FOOTER =

883

884

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

885

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

886

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

887

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

888

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

889

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

890

891

HTML_STYLESHEET =

892

893

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

894

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

895

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

896

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

897

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

898

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

899

900

HTML_EXTRA_FILES =

901

902

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

903

# Doxygen will adjust the colors in the stylesheet and background images

904

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

905

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

906

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

907

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

908

# The allowed range is 0 to 359.

909

910

HTML_COLORSTYLE_HUE = 220

911

912

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

913

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

914

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

915

916

HTML_COLORSTYLE_SAT = 100

917

918

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to

919

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

920

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

921

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

922

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

923

# and 100 does not change the gamma.

924

925

HTML_COLORSTYLE_GAMMA = 80

926

927

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

928

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

929

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

930

931

HTML_TIMESTAMP = YES

932

933

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,

934

# files or namespaces will be aligned in HTML using tables. If set to

935

# NO a bullet list will be used.

936

937

HTML_ALIGN_MEMBERS = YES

938

939

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

940

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

941

# page has loaded. For this to work a browser that supports

942

# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox

943

# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

944

945

HTML_DYNAMIC_SECTIONS = NO

946

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

# it at startup.

955

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

956

# for more information.

957

958

GENERATE_DOCSET = NO

959

960

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

961

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

962

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

963

# can be grouped.

964

965

DOCSET_FEEDNAME = "Doxygen generated docs"

966

967

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

968

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

969

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

970

# will append .docset to the name.

971

972

DOCSET_BUNDLE_ID = org.doxygen.Project

973

974

# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify

975

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

976

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

977

978

DOCSET_PUBLISHER_ID = org.doxygen.Publisher

979

980

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

981

982

DOCSET_PUBLISHER_NAME = Publisher

983

984

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

985

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

986

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

987

# of the generated HTML documentation.

988

989

GENERATE_HTMLHELP = NO

990

991

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

992

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

993

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

994

# written to the html output directory.

995

996

CHM_FILE =

997

998

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

999

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

1000

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

1001

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

1002

1003

HHC_LOCATION =

1004

1005

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

1006

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

1007

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

1008

1009

GENERATE_CHI = NO

1010

1011

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

1012

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

1013

# content.

1014

1015

CHM_INDEX_ENCODING =

1016

1017

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

1018

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

1019

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

1020

1021

BINARY_TOC = NO

1022

1023

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

1024

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

1025

1026

TOC_EXPAND = NO

1027

1028

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

1029

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

1030

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

1031

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

1032

1033

GENERATE_QHP = NO

1034

1035

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

1036

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

1037

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

1038

1039

QCH_FILE =

1040

1041

# The QHP_NAMESPACE tag specifies the namespace to use when generating

1042

# Qt Help Project output. For more information please see

1043

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

1044

1045

QHP_NAMESPACE = org.doxygen.Project

1046

1047

# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating

1048

# Qt Help Project output. For more information please see

1049

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

1050

1051

QHP_VIRTUAL_FOLDER = doc

1052

1053

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

1054

# add. For more information please see

1055

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

1056

1057

QHP_CUST_FILTER_NAME =

1058

1059

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

1060

# custom filter to add. For more information please see

1061

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

1062

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

1063

1064

QHP_CUST_FILTER_ATTRS =

1065

1066

# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this

1067

# project's

1068

# filter section matches.

1069

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

1070

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

1071

1072

QHP_SECT_FILTER_ATTRS =

1073

1074

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

1075

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

1076

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

1077

# .qhp file.

1078

1079

QHG_LOCATION =

1080

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

# the help appears.

1089

1090

GENERATE_ECLIPSEHELP = NO

1091

1092

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

1093

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

1094

# this name.

1095

1096

ECLIPSE_DOC_ID = org.doxygen.Project

1097

1098

# The DISABLE_INDEX tag can be used to turn on/off the condensed index at

1099

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

1100

# the value YES disables it.

1101

1102

DISABLE_INDEX = NO

1103

1104

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

1105

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

1106

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

1107

# values from appearing in the overview section.

1108

1109

ENUM_VALUES_PER_LINE = 1

1110

1111

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

1112

# structure should be generated to display hierarchical information.

1113

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

1114

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

1115

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

1116

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

1117

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

1118

1119

GENERATE_TREEVIEW = YES

1120

1121

# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,

1122

# and Class Hierarchy pages using a tree view instead of an ordered list.

1123

1124

USE_INLINE_TREES = YES

1125

1126

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

1127

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

1128

# is shown.

1129

1130

TREEVIEW_WIDTH = 250

1131

1132

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

1133

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

1134

1135

EXT_LINKS_IN_WINDOW = NO

1136

1137

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

1138

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

1139

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

1140

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

1141

# to force them to be regenerated.

1142

1143

FORMULA_FONTSIZE = 10

1144

1145

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

1146

# generated for formulas are transparent PNGs. Transparent PNGs are

1147

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

1148

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

1149

# in the HTML output before the changes have effect.

1150

1151

FORMULA_TRANSPARENT = YES

1152

1153

# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax

1154

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

1155

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

1156

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

1157

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

1158

# configure the path to it using the MATHJAX_RELPATH option.

1159

1160

USE_MATHJAX = NO

1161

1162

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

1163

# HTML output directory using the MATHJAX_RELPATH option. The destination

1164

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

1165

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

1166

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

1167

# mathjax.org site, so you can quickly see the result without installing

1168

# MathJax, but it is strongly recommended to install a local copy of MathJax

1169

# before deployment.

1170

1171

MATHJAX_RELPATH = http://www.mathjax.org/mathjax

1172

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

1179

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

1180

1181

SEARCHENGINE = NO

1182

1183

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

1184

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

1185

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

1186

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

1187

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

1188

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

1189

# and does not have live searching capabilities.

1190

1191

SERVER_BASED_SEARCH = NO

1192

1193

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

1194

# configuration options related to the LaTeX output

1195

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

1196

1197

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

1198

# generate Latex output.

1199

1200

GENERATE_LATEX = NO

1201

1202

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

1203

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

1204

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

1205

1206

LATEX_OUTPUT = latex

1207

1208

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

1209

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

1210

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

1211

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

1212

# Makefile that is written to the output directory.

1213

1214

LATEX_CMD_NAME = latex

1215

1216

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

1217

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

1218

# default command name.

1219

1220

MAKEINDEX_CMD_NAME = makeindex

1221

1222

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

1223

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

1224

# save some trees in general.

1225

1226

COMPACT_LATEX = NO

1227

1228

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

1229

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

1230

# executive. If left blank a4wide will be used.

1231

1232

PAPER_TYPE = a4

1233

1234

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

1235

# packages that should be included in the LaTeX output.

1236

1237

EXTRA_PACKAGES =

1238

1239

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

1240

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

1241

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

1242

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

1243

1244

LATEX_HEADER =

1245

1246

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

1247

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

1248

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

1249

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

1250

1251

LATEX_FOOTER =

1252

1253

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

1254

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

1255

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

1256

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

1257

1258

PDF_HYPERLINKS = YES

1259

1260

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

1261

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

1262

# higher quality PDF documentation.

1263

1264

USE_PDFLATEX = YES

1265

1266

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

1267

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

1268

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

1269

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

1270

1271

LATEX_BATCHMODE = NO

1272

1273

# If LATEX_HIDE_INDICES is set to YES then doxygen will not

1274

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

1275

# in the output.

1276

1277

LATEX_HIDE_INDICES = NO

1278

1279

# If LATEX_SOURCE_CODE is set to YES then doxygen will include

1280

# source code with syntax highlighting in the LaTeX output.

1281

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

1282

# such as SOURCE_BROWSER.

1283

1284

LATEX_SOURCE_CODE = NO

1285

1286

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

1287

# configuration options related to the RTF output

1288

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

1289

1290

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

1291

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

1292

# other RTF readers or editors.

1293

1294

GENERATE_RTF = NO

1295

1296

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

1297

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

1298

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

1299

1300

RTF_OUTPUT = rtf

1301

1302

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

1303

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

1304

# save some trees in general.

1305

1306

COMPACT_RTF = NO

1307

1308

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

1309

# will contain hyperlink fields. The RTF file will

1310

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

1311

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

1312

# programs which support those fields.

1313

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

1314

1315

RTF_HYPERLINKS = NO

1316

1317

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

1318

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

1319

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

1320

1321

RTF_STYLESHEET_FILE =

1322

1323

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

1324

# Syntax is similar to doxygen's config file.

1325

1326

RTF_EXTENSIONS_FILE =

1327

1328

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

1329

# configuration options related to the man page output

1330

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

1331

1332

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

1333

# generate man pages

1334

1335

GENERATE_MAN = YES

1336

1337

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

1338

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

1339

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

1340

1341

MAN_OUTPUT = man

1342

1343

# The MAN_EXTENSION tag determines the extension that is added to

1344

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

1345

1346

MAN_EXTENSION = .3

1347

1348

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

1349

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

1350

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

1351

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

1352

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

1353

1354

MAN_LINKS = NO

1355

1356

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

1357

# configuration options related to the XML output

1358

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

1359

1360

# If the GENERATE_XML tag is set to YES Doxygen will

1361

# generate an XML file that captures the structure of

1362

# the code including all documentation.

1363

1364

GENERATE_XML = NO

1365

1366

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

1367

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

1368

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

1369

1370

XML_OUTPUT = xml

1371

1372

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

1373

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

1374

# syntax of the XML files.

1375

1376

XML_SCHEMA =

1377

1378

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

1379

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

1380

# syntax of the XML files.

1381

1382

XML_DTD =

1383

1384

# If the XML_PROGRAMLISTING tag is set to YES Doxygen will

1385

# dump the program listings (including syntax highlighting

1386

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

1387

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

1388

1389

XML_PROGRAMLISTING = YES

1390

1391

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

1392

# configuration options for the AutoGen Definitions output

1393

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

1394

1395

# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will

1396

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

1397

# that captures the structure of the code including all

1398

# documentation. Note that this feature is still experimental

1399

# and incomplete at the moment.

1400

1401

GENERATE_AUTOGEN_DEF = NO

1402

1403

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

1404

# configuration options related to the Perl module output

1405

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

1406

1407

# If the GENERATE_PERLMOD tag is set to YES Doxygen will

1408

# generate a Perl module file that captures the structure of

1409

# the code including all documentation. Note that this

1410

# feature is still experimental and incomplete at the

1411

# moment.

1412

1413

GENERATE_PERLMOD = NO

1414

1415

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

1416

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

1417

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

1418

1419

PERLMOD_LATEX = NO

1420

1421

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

1422

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

1423

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

1424

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

1425

# and Perl will parse it just the same.

1426

1427

PERLMOD_PRETTY = YES

1428

1429

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

1430

# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.

1431

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

1432

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

1433

1434

PERLMOD_MAKEVAR_PREFIX =

1435

1436

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

1437

# Configuration options related to the preprocessor

1438

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

1439

1440

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

1441

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

1442

# files.

1443

1444

ENABLE_PREPROCESSING = YES

1445

1446

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

1447

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

1448

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

1449

# way by setting EXPAND_ONLY_PREDEF to YES.

1450

1451

MACRO_EXPANSION = NO

1452

1453

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

1454

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

1455

# PREDEFINED and EXPAND_AS_DEFINED tags.

1456

1457

EXPAND_ONLY_PREDEF = NO

1458

1459

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

1460

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

1461

1462

SEARCH_INCLUDES = YES

1463

1464

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

1465

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

1466

# the preprocessor.

1467

1468

INCLUDE_PATH =

1469

1470

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

1471

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

1472

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

1473

# be used.

1474

1475

INCLUDE_FILE_PATTERNS =

1476

1477

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

1478

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

1479

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

1480

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

1481

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

1482

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

1483

# instead of the = operator.

1484

1485

PREDEFINED =

1486

1487

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

1488

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

1489

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

1490

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

1491

# overrules the definition found in the source code.

1492

1493

EXPAND_AS_DEFINED =

1494

1495

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

1496

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

1497

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

1498

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

1499

1500

SKIP_FUNCTION_MACROS = YES

1501

1502

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

1503

# Configuration::additions related to external references

1504

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

1505

1506

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

1507

# Optionally an initial location of the external documentation

1508

# can be added for each tagfile. The format of a tag file without

1509

# this location is as follows:

1510

# TAGFILES = file1 file2 ...

1511

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

1512

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

1513

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

1514

# URLs. If a location is present for each tag, the installdox tool

1515

# does not have to be run to correct the links.

1516

# Note that each tag file must have a unique name

1517

# (where the name does NOT include the path)

1518

# If a tag file is not located in the directory in which doxygen

1519

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

1520

1521

TAGFILES =

1522

1523

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

1524

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

1525

1526

GENERATE_TAGFILE =

1527

1528

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

1529

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

1530

# will be listed.

1531

1532

ALLEXTERNALS = NO

1533

1534

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

1535

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

1536

# be listed.

1537

1538

EXTERNAL_GROUPS = YES

1539

1540

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

1541

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

1542

1543

PERL_PATH = /usr/bin/perl

1544

1545

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

1546

# Configuration options related to the dot tool

1547

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

1548

1549

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

1550

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

1551

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

1552

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

1553

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

1554

1555

CLASS_DIAGRAMS = NO

1556

1557

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

1558

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

1559

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

1560

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

1561

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

1562

# default search path.

1563

1564

MSCGEN_PATH =

1565

1566

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

1567

# inheritance and usage relations if the target is undocumented

1568

# or is not a class.

1569

1570

HIDE_UNDOC_RELATIONS = YES

1571

1572

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

1573

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

1574

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

1575

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

1576

1577

HAVE_DOT = NO

1578

1579

# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is

1580

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

1581

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

1582

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

1583

# between CPU load and processing speed.

1584

1585

DOT_NUM_THREADS = 0

1586

1587

# By default doxygen will write a font called Helvetica to the output

1588

# directory and reference it in all dot files that doxygen generates.

1589

# When you want a differently looking font you can specify the font name

1590

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

1591

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

1592

# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory

1593

# containing the font.

1594

1595

DOT_FONTNAME = Helvetica

1596

1597

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

1598

# The default size is 10pt.

1599

1600

DOT_FONTSIZE = 10

1601

1602

# By default doxygen will tell dot to use the output directory to look for the

1603

# FreeSans.ttf font (which doxygen will put there itself). If you specify a

1604

# different font using DOT_FONTNAME you can set the path where dot

1605

# can find it using this tag.

1606

1607

DOT_FONTPATH =

1608

1609

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

1610

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

1611

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

1612

# the CLASS_DIAGRAMS tag to NO.

1613

1614

CLASS_GRAPH = YES

1615

1616

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

1617

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

1618

# indirect implementation dependencies (inheritance, containment, and

1619

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

1620

1621

COLLABORATION_GRAPH = YES

1622

1623

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

1624

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

1625

1626

GROUP_GRAPHS = YES

1627

1628

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

1629

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

1630

# Language.

1631

1632

UML_LOOK = NO

1633

1634

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

1635

# relations between templates and their instances.

1636

1637

TEMPLATE_RELATIONS = NO

1638

1639

# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT

1640

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

1641

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

1642

# other documented files.

1643

1644

INCLUDE_GRAPH = YES

1645

1646

# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and

1647

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

1648

# documented header file showing the documented files that directly or

1649

# indirectly include this file.

1650

1651

INCLUDED_BY_GRAPH = YES

1652

1653

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

1654

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

1655

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

1656

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

1657

# for selected functions only using the \callgraph command.

1658

1659

CALL_GRAPH = NO

1660

1661

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

1662

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

1663

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

1664

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

1665

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

1666

1667

CALLER_GRAPH = NO

1668

1669

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

1670

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

1671

1672

GRAPHICAL_HIERARCHY = YES

1673

1674

# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES

1675

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

1676

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

1677

# relations between the files in the directories.

1678

1679

DIRECTORY_GRAPH = YES

1680

1681

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

1682

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

1683

# If left blank png will be used.

1684

1685

DOT_IMAGE_FORMAT = png

1686

1687

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

1688

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

1689

1690

DOT_PATH =

1691

1692

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

1693

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

1694

# \dotfile command).

1695

1696

DOTFILE_DIRS =

1697

1698

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

1699

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

1700

# \mscfile command).

1701

1702

MSCFILE_DIRS =

1703

1704

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

1705

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

1706

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

1707

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

1708

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

1709

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

1710

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

1711

1712

DOT_GRAPH_MAX_NODES = 50

1713

1714

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

1715

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

1716

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

1717

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

1718

# option to 1 or 2 may greatly reduce the computation time needed for large

1719

# code bases. Also note that the size of a graph can be further restricted by

1720

# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.

1721

1722

MAX_DOT_GRAPH_DEPTH = 0

1723

1724

# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent

1725

# background. This is disabled by default, because dot on Windows does not

1726

# seem to support this out of the box. Warning: Depending on the platform used,

1727

# enabling this option may lead to badly anti-aliased labels on the edges of

1728

# a graph (i.e. they become hard to read).

1729

1730

DOT_TRANSPARENT = NO

1731

1732

# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output

1733

# files in one run (i.e. multiple -o and -T options on the command line). This

1734

# makes dot run faster, but since only newer versions of dot (>1.8.10)

1735

# support this, this feature is disabled by default.

1736

1737

DOT_MULTI_TARGETS = NO

1738

1739

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

1740

# generate a legend page explaining the meaning of the various boxes and

1741

# arrows in the dot generated graphs.

1742

1743

GENERATE_LEGEND = YES

1744

1745

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

1746

# remove the intermediate dot files that are used to generate

1747

# the various graphs.

1748

1749

DOT_CLEANUP = YES