WebSVN – BadVPN – Blame – Rev 1 – /lwip/doc/doxygen/lwip.Doxyfile

1

office

1

# Doxyfile 1.8.11

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 double hash (##) is considered a comment and is placed in

7

# front of the TAG it is preceding.

8

#

9

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

10

# The format is:

11

# TAG = value [value, ...]

12

# For lists, items can also be appended using:

13

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

14

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

15

16

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

17

# Project related configuration options

18

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

19

20

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

21

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

22

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

23

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

24

# for the list of possible encodings.

25

# The default value is: UTF-8.

26

27

DOXYFILE_ENCODING = UTF-8

28

29

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by

30

# double-quotes, unless you are using Doxywizard) that should identify the

31

# project for which the documentation is generated. This name is used in the

32

# title of most generated pages and in a few other places.

33

# The default value is: My Project.

34

35

PROJECT_NAME = "lwIP"

36

37

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

38

# could be handy for archiving the generated documentation or if some version

39

# control system is used.

40

41

PROJECT_NUMBER = "2.0.3"

42

43

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

44

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

45

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

46

47

PROJECT_BRIEF = "Lightweight IP stack"

48

49

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

50

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

51

# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy

52

# the logo to the output directory.

PROJECT_LOGO =

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

57

# into which the generated documentation will be written. If a relative path is

58

# entered, it will be relative to the location where doxygen was started. If

59

# left blank the current directory will be used.

60

61

OUTPUT_DIRECTORY = output

62

63

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-

64

# directories (in 2 levels) under the output directory of each output format and

65

# will distribute the generated files over these directories. Enabling this

66

# option can be useful when feeding doxygen a huge amount of source files, where

67

# putting all generated files in the same directory would otherwise causes

68

# performance problems for the file system.

69

# The default value is: NO.

70

71

CREATE_SUBDIRS = NO

72

73

# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII

74

# characters to appear in the names of generated files. If set to NO, non-ASCII

75

# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode

76

# U+3044.

77

# The default value is: NO.

78

79

ALLOW_UNICODE_NAMES = NO

80

81

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

82

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

83

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

84

# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,

85

# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),

86

# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,

87

# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),

88

# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,

89

# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,

90

# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,

91

# Ukrainian and Vietnamese.

92

# The default value is: English.

93

94

OUTPUT_LANGUAGE = English

95

96

# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member

97

# descriptions after the members that are listed in the file and class

98

# documentation (similar to Javadoc). Set to NO to disable this.

99

# The default value is: YES.

100

101

BRIEF_MEMBER_DESC = YES

102

103

# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief

104

# description of a member or function before the detailed description

105

#

106

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

107

# brief descriptions will be completely suppressed.

108

# The default value is: YES.

REPEAT_BRIEF = YES

# This tag implements a quasi-intelligent brief description abbreviator that is

113

# used to form the text in various listings. Each string in this list, if found

114

# as the leading text of the brief description, will be stripped from the text

115

# and the result, after processing the whole list, is used as the annotated

116

# text. Otherwise, the brief description is used as-is. If left blank, the

117

# following values are used ($name is automatically replaced with the name of

118

# the entity):The $name class, The $name widget, The $name file, is, provides,

119

# specifies, contains, represents, a, an and the.

120

121

ABBREVIATE_BRIEF = "The $name class " \

122

"The $name widget " \

123

"The $name file " \

is \

provides \

specifies \

contains \

represents \

a \

an \

the

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

134

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

135

# description.

136

# The default value is: NO.

137

138

ALWAYS_DETAILED_SEC = NO

139

140

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

141

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

142

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

143

# operators of the base classes will not be shown.

144

# The default value is: NO.

145

146

INLINE_INHERITED_MEMB = NO

147

148

# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path

149

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

150

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

151

# The default value is: YES.

152

153

FULL_PATH_NAMES = YES

154

155

# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.

156

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

157

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

158

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

159

# strip.

160

#

161

# Note that you can specify absolute paths here, but also relative paths, which

162

# will be relative from the directory where doxygen is started.

163

# This tag requires that the tag FULL_PATH_NAMES is set to YES.

164

165

STRIP_FROM_PATH = ../../

166

167

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

168

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

169

# header file to include in order to use a class. If left blank only the name of

170

# the header file containing the class definition is used. Otherwise one should

171

# specify the list of include paths that are normally passed to the compiler

172

# using the -I flag.

173

174

STRIP_FROM_INC_PATH =

175

176

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

177

# less readable) file names. This can be useful is your file systems doesn't

178

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

179

# The default value is: NO.

SHORT_NAMES = NO

# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the

184

# first line (until the first dot) of a Javadoc-style comment as the brief

185

# description. If set to NO, the Javadoc-style will behave just like regular Qt-

186

# style comments (thus requiring an explicit @brief command for a brief

187

# description.)

188

# The default value is: NO.

189

190

JAVADOC_AUTOBRIEF = NO

191

192

# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first

193

# line (until the first dot) of a Qt-style comment as the brief description. If

194

# set to NO, the Qt-style will behave just like regular Qt-style comments (thus

195

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

196

# The default value is: NO.

QT_AUTOBRIEF = NO

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a

201

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

202

# a brief description. This used to be the default behavior. The new default is

203

# to treat a multi-line C++ comment block as a detailed description. Set this

204

# tag to YES if you prefer the old behavior instead.

205

#

206

# Note that setting this tag to YES also means that rational rose comments are

207

# not recognized any more.

208

# The default value is: NO.

209

210

MULTILINE_CPP_IS_BRIEF = NO

211

212

# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the

213

# documentation from any documented member that it re-implements.

214

# The default value is: YES.

INHERIT_DOCS = YES

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

219

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

220

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

221

# The default value is: NO.

222

223

SEPARATE_MEMBER_PAGES = NO

224

225

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

226

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

227

# Minimum value: 1, maximum value: 16, default value: 4.

TAB_SIZE = 8

# This tag can be used to specify a number of aliases that act as commands in

232

# the documentation. An alias has the form:

233

# name=value

234

# For example adding

235

# "sideeffect=@par Side Effects:\n"

236

# will allow you to put the command \sideeffect (or @sideeffect) in the

237

# documentation, which will result in a user-defined paragraph with heading

238

# "Side Effects:". You can put \n's in the value part of an alias to insert

# newlines.

ALIASES =

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

244

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

245

# will allow you to use the command class in the itcl::class meaning.

TCL_SUBST =

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

250

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

251

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

252

# members will be omitted, etc.

253

# The default value is: NO.

254

255

OPTIMIZE_OUTPUT_FOR_C = YES

256

257

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

258

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

259

# for that language. For instance, namespaces will be presented as packages,

260

# qualified scopes will look different, etc.

261

# The default value is: NO.

262

263

OPTIMIZE_OUTPUT_JAVA = NO

264

265

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

266

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

267

# The default value is: NO.

268

269

OPTIMIZE_FOR_FORTRAN = NO

270

271

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

272

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

273

# The default value is: NO.

274

275

OPTIMIZE_OUTPUT_VHDL = NO

276

277

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

278

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

279

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

280

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

281

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

282

# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:

283

# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:

284

# Fortran. In the later case the parser tries to guess whether the code is fixed

285

# or free formatted code, this is the default for Fortran type files), VHDL. For

286

# instance to make doxygen treat .inc files as Fortran files (default is PHP),

287

# and .f files as C (default is Fortran), use: inc=Fortran f=C.

288

#

289

# Note: For files without extension you can use no_extension as a placeholder.

290

#

291

# Note that for custom extensions you also need to set FILE_PATTERNS otherwise

292

# the files are not read by doxygen.

293

294

EXTENSION_MAPPING =

295

296

# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments

297

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

298

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

299

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

300

# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in

301

# case of backward compatibilities issues.

302

# The default value is: YES.

303

304

MARKDOWN_SUPPORT = YES

305

306

# When enabled doxygen tries to link words that correspond to documented

307

# classes, or namespaces to their corresponding documentation. Such a link can

308

# be prevented in individual cases by putting a % sign in front of the word or

309

# globally by setting AUTOLINK_SUPPORT to NO.

310

# The default value is: YES.

311

312

AUTOLINK_SUPPORT = YES

313

314

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

315

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

316

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

317

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

318

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

319

# diagrams that involve STL classes more complete and accurate.

320

# The default value is: NO.

321

322

BUILTIN_STL_SUPPORT = NO

323

324

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

325

# enable parsing support.

326

# The default value is: NO.

327

328

CPP_CLI_SUPPORT = NO

329

330

# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:

331

# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen

332

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

333

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

334

# The default value is: NO.

SIP_SUPPORT = NO

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

339

# getter and setter methods for a property. Setting this option to YES will make

340

# doxygen to replace the get and set methods by a property in the documentation.

341

# This will only work if the methods are indeed getting or setting a simple

342

# type. If this is not the case, or you want to show the methods anyway, you

343

# should set this option to NO.

344

# The default value is: YES.

345

346

IDL_PROPERTY_SUPPORT = YES

347

348

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

349

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

350

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

351

# all members of a group must be documented explicitly.

352

# The default value is: NO.

353

354

DISTRIBUTE_GROUP_DOC = NO

355

356

# If one adds a struct or class to a group and this option is enabled, then also

357

# any nested class or struct is added to the same group. By default this option

358

# is disabled and one has to add nested compounds explicitly via \ingroup.

359

# The default value is: NO.

360

361

GROUP_NESTED_COMPOUNDS = NO

362

363

# Set the SUBGROUPING tag to YES to allow class member groups of the same type

364

# (for instance a group of public functions) to be put as a subgroup of that

365

# type (e.g. under the Public Functions section). Set it to NO to prevent

366

# subgrouping. Alternatively, this can be done per class using the

367

# \nosubgrouping command.

368

# The default value is: YES.

SUBGROUPING = YES

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

373

# are shown inside the group in which they are included (e.g. using \ingroup)

374

# instead of on a separate page (for HTML and Man pages) or section (for LaTeX

375

# and RTF).

376

#

377

# Note that this feature does not work in combination with

378

# SEPARATE_MEMBER_PAGES.

379

# The default value is: NO.

380

381

INLINE_GROUPED_CLASSES = NO

382

383

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

384

# with only public data fields or simple typedef fields will be shown inline in

385

# the documentation of the scope in which they are defined (i.e. file,

386

# namespace, or group documentation), provided this scope is documented. If set

387

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

388

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

389

# The default value is: NO.

390

391

INLINE_SIMPLE_STRUCTS = NO

392

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

# The default value is: NO.

401

402

TYPEDEF_HIDES_STRUCT = NO

403

404

# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This

405

# cache is used to resolve symbols given their name and scope. Since this can be

406

# an expensive process and often the same symbol appears multiple times in the

407

# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small

408

# doxygen will become slower. If the cache is too large, memory is wasted. The

409

# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range

410

# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536

411

# symbols. At the end of a run doxygen will report the cache usage and suggest

412

# the optimal cache size from a speed point of view.

413

# Minimum value: 0, maximum value: 9, default value: 0.

414

415

LOOKUP_CACHE_SIZE = 0

416

417

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

418

# Build related configuration options

419

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

420

421

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

422

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

423

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

424

# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.

425

# Note: This will also disable the warnings about undocumented members that are

426

# normally produced when WARNINGS is set to YES.

427

# The default value is: NO.

EXTRACT_ALL = NO

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

432

# be included in the documentation.

433

# The default value is: NO.

434

435

EXTRACT_PRIVATE = NO

436

437

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

438

# scope will be included in the documentation.

439

# The default value is: NO.

440

441

EXTRACT_PACKAGE = NO

442

443

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

444

# included in the documentation.

445

# The default value is: NO.

446

447

EXTRACT_STATIC = NO

448

449

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

450

# locally in source files will be included in the documentation. If set to NO,

451

# only classes defined in header files are included. Does not have any effect

452

# for Java sources.

453

# The default value is: YES.

454

455

EXTRACT_LOCAL_CLASSES = YES

456

457

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

458

# which are defined in the implementation section but not in the interface are

459

# included in the documentation. If set to NO, only methods in the interface are

460

# included.

461

# The default value is: NO.

462

463

EXTRACT_LOCAL_METHODS = NO

464

465

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

466

# extracted and appear in the documentation as a namespace called

467

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

468

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

469

# are hidden.

470

# The default value is: NO.

471

472

EXTRACT_ANON_NSPACES = NO

473

474

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

475

# undocumented members inside documented classes or files. If set to NO these

476

# members will be included in the various overviews, but no documentation

477

# section is generated. This option has no effect if EXTRACT_ALL is enabled.

478

# The default value is: NO.

479

480

HIDE_UNDOC_MEMBERS = YES

481

482

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

483

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

484

# to NO, these classes will be included in the various overviews. This option

485

# has no effect if EXTRACT_ALL is enabled.

486

# The default value is: NO.

487

488

HIDE_UNDOC_CLASSES = YES

489

490

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

491

# (class|struct|union) declarations. If set to NO, these declarations will be

492

# included in the documentation.

493

# The default value is: NO.

494

495

HIDE_FRIEND_COMPOUNDS = NO

496

497

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

498

# documentation blocks found inside the body of a function. If set to NO, these

499

# blocks will be appended to the function's detailed documentation block.

500

# The default value is: NO.

501

502

HIDE_IN_BODY_DOCS = NO

503

504

# The INTERNAL_DOCS tag determines if documentation that is typed after a

505

# \internal command is included. If the tag is set to NO then the documentation

506

# will be excluded. Set it to YES to include the internal documentation.

507

# The default value is: NO.

INTERNAL_DOCS = NO

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

512

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

513

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

514

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

515

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

516

# The default value is: system dependent.

517

518

CASE_SENSE_NAMES = NO

519

520

# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with

521

# their full class and namespace scopes in the documentation. If set to YES, the

522

# scope will be hidden.

523

# The default value is: NO.

524

525

HIDE_SCOPE_NAMES = NO

526

527

# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will

528

# append additional text to a page's title, such as Class Reference. If set to

529

# YES the compound reference will be hidden.

530

# The default value is: NO.

531

532

HIDE_COMPOUND_REFERENCE= NO

533

534

# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of

535

# the files that are included by a file in the documentation of that file.

536

# The default value is: YES.

537

538

SHOW_INCLUDE_FILES = YES

539

540

# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each

541

# grouped member an include statement to the documentation, telling the reader

542

# which file to include in order to use the member.

543

# The default value is: NO.

544

545

SHOW_GROUPED_MEMB_INC = NO

546

547

# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include

548

# files with double quotes in the documentation rather than with sharp brackets.

549

# The default value is: NO.

550

551

FORCE_LOCAL_INCLUDES = NO

552

553

# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the

554

# documentation for inline members.

555

# The default value is: YES.

INLINE_INFO = YES

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

560

# (detailed) documentation of file and class members alphabetically by member

561

# name. If set to NO, the members will appear in declaration order.

562

# The default value is: YES.

563

564

SORT_MEMBER_DOCS = YES

565

566

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

567

# descriptions of file, namespace and class members alphabetically by member

568

# name. If set to NO, the members will appear in declaration order. Note that

569

# this will also influence the order of the classes in the class list.

570

# The default value is: NO.

571

572

SORT_BRIEF_DOCS = NO

573

574

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

575

# (brief and detailed) documentation of class members so that constructors and

576

# destructors are listed first. If set to NO the constructors will appear in the

577

# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.

578

# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief

579

# member documentation.

580

# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting

581

# detailed member documentation.

582

# The default value is: NO.

583

584

SORT_MEMBERS_CTORS_1ST = NO

585

586

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

587

# of group names into alphabetical order. If set to NO the group names will

588

# appear in their defined order.

589

# The default value is: NO.

590

591

SORT_GROUP_NAMES = NO

592

593

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

594

# fully-qualified names, including namespaces. If set to NO, the class list will

595

# be sorted only by class name, not including the namespace part.

596

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

597

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

598

# list.

599

# The default value is: NO.

600

601

SORT_BY_SCOPE_NAME = NO

602

603

# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper

604

# type resolution of all parameters of a function it will reject a match between

605

# the prototype and the implementation of a member function even if there is

606

# only one candidate or it is obvious which candidate to choose by doing a

607

# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still

608

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

609

# The default value is: NO.

610

611

STRICT_PROTO_MATCHING = NO

612

613

# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo

614

# list. This list is created by putting \todo commands in the documentation.

615

# The default value is: YES.

616

617

GENERATE_TODOLIST = NO

618

619

# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test

620

# list. This list is created by putting \test commands in the documentation.

621

# The default value is: YES.

622

623

GENERATE_TESTLIST = YES

624

625

# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug

626

# list. This list is created by putting \bug commands in the documentation.

627

# The default value is: YES.

628

629

GENERATE_BUGLIST = YES

630

631

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

632

# the deprecated list. This list is created by putting \deprecated commands in

633

# the documentation.

634

# The default value is: YES.

635

636

GENERATE_DEPRECATEDLIST= YES

637

638

# The ENABLED_SECTIONS tag can be used to enable conditional documentation

639

# sections, marked by \if <section_label> ... \endif and \cond <section_label>

640

# ... \endcond blocks.

ENABLED_SECTIONS =

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the

645

# initial value of a variable or macro / define can have for it to appear in the

646

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

647

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

648

# appearance of the value of individual variables and macros / defines can be

649

# controlled using \showinitializer or \hideinitializer command in the

650

# documentation regardless of this setting.

651

# Minimum value: 0, maximum value: 10000, default value: 30.

652

653

MAX_INITIALIZER_LINES = 30

654

655

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

656

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

657

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

658

# The default value is: YES.

659

660

SHOW_USED_FILES = YES

661

662

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

663

# will remove the Files entry from the Quick Index and from the Folder Tree View

664

# (if specified).

665

# The default value is: YES.

SHOW_FILES = YES

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

670

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

671

# Folder Tree View (if specified).

672

# The default value is: YES.

673

674

SHOW_NAMESPACES = YES

675

676

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

677

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

678

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

679

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

680

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

681

# by doxygen. Whatever the program writes to standard output is used as the file

682

# version. For an example see the documentation.

683

684

FILE_VERSION_FILTER =

685

686

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

687

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

688

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

689

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

690

# optionally specify a file name after the option, if omitted DoxygenLayout.xml

691

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

692

#

693

# Note that if you run doxygen from a directory containing a file called

694

# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE

695

# tag is left empty.

LAYOUT_FILE =

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

700

# the reference definitions. This must be a list of .bib files. The .bib

701

# extension is automatically appended if omitted. This requires the bibtex tool

702

# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.

703

# For LaTeX the style of the bibliography can be controlled using

704

# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the

705

# search path. See also \cite for info how to create references.

CITE_BIB_FILES =

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

710

# Configuration options related to warning and progress messages

711

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

712

713

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

714

# standard output by doxygen. If QUIET is set to YES this implies that the

715

# messages are off.

716

# The default value is: NO.

QUIET = NO

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

721

# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES

722

# this implies that the warnings are on.

723

#

724

# Tip: Turn warnings on while writing the documentation.

725

# The default value is: YES.

WARNINGS = YES

# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate

730

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

731

# will automatically be disabled.

732

# The default value is: YES.

733

734

WARN_IF_UNDOCUMENTED = YES

735

736

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

737

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

738

# in a documented function, or documenting parameters that don't exist or using

739

# markup commands wrongly.

740

# The default value is: YES.

741

742

WARN_IF_DOC_ERROR = YES

743

744

# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that

745

# are documented, but have no documentation for their parameters or return

746

# value. If set to NO, doxygen will only warn about wrong or incomplete

747

# parameter documentation, but not about the absence of documentation.

748

# The default value is: NO.

749

750

WARN_NO_PARAMDOC = NO

751

752

# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when

753

# a warning is encountered.

754

# The default value is: NO.

WARN_AS_ERROR = NO

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

759

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

760

# will be replaced by the file and line number from which the warning originated

761

# and the warning text. Optionally the format may contain $version, which will

762

# be replaced by the version of the file (if it could be obtained via

763

# FILE_VERSION_FILTER)

764

# The default value is: $file:$line: $text.

765

766

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

767

768

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

769

# messages should be written. If left blank the output is written to standard

# error (stderr).

WARN_LOGFILE =

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

775

# Configuration options related to the input files

776

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

777

778

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

779

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

780

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

781

# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING

782

# Note: If this tag is empty the current directory is searched.

783

784

INPUT = main_page.h ../../src

785

786

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

787

# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

788

# libiconv (or the iconv built into libc) for the transcoding. See the libiconv

789

# documentation (see: http://www.gnu.org/software/libiconv) for the list of

790

# possible encodings.

791

# The default value is: UTF-8.

792

793

INPUT_ENCODING = UTF-8

794

795

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

796

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

797

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

798

#

799

# Note that for custom extensions or not directly supported extensions you also

800

# need to set EXTENSION_MAPPING for the extension otherwise the files are not

801

# read by doxygen.

802

#

803

# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,

804

# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,

805

# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,

806

# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,

807

# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.

808

809

FILE_PATTERNS = *.c \

*.cc \

*.cxx \

*.cpp \

*.c++ \

*.java \

*.ii \

*.ixx \

*.ipp \

*.i++ \

*.inl \

*.h \

*.hh \

*.hxx \

*.hpp \

*.h++ \

*.idl \

*.odl \

*.inc \

*.m \

*.mm \

*.dox

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

833

# be searched for input files as well.

834

# The default value is: NO.

RECURSIVE = YES

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

839

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

840

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

841

#

842

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

843

# run.

844

845

EXCLUDE = ../../src/include/netif/ppp/polarssl

846

847

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

848

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

849

# from the input.

850

# The default value is: NO.

851

852

EXCLUDE_SYMLINKS = NO

853

854

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

855

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

856

# certain files from those directories.

857

#

858

# Note that the wildcards are matched against the file with absolute path, so to

859

# exclude all test directories for example use the pattern */test/*

EXCLUDE_PATTERNS =

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

864

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

865

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

866

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

867

# AClass::ANamespace, ANamespace::*Test

868

#

869

# Note that the wildcards are matched against the file with absolute path, so to

870

# exclude all test directories use the pattern */test/*

EXCLUDE_SYMBOLS =

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

875

# that contain example code fragments that are included (see the \include

876

# command).

877

878

EXAMPLE_PATH = ../ ../../

879

880

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

881

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

882

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

883

# files are included.

884

885

EXAMPLE_PATTERNS = *

886

887

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

888

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

889

# irrespective of the value of the RECURSIVE tag.

890

# The default value is: NO.

891

892

EXAMPLE_RECURSIVE = NO

893

894

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

895

# that contain images that are to be included in the documentation (see the

# \image command).

IMAGE_PATH =

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

901

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

902

# by executing (via popen()) the command:

903

#

904

# <filter> <input-file>

905

#

906

# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the

907

# name of an input file. Doxygen will then use the output that the filter

908

# program writes to standard output. If FILTER_PATTERNS is specified, this tag

909

# will be ignored.

910

#

911

# Note that the filter must not add or remove lines; it is applied before the

912

# code is scanned, but not when the output code is generated. If lines are added

913

# or removed, the anchors will not be placed correctly.

914

#

915

# Note that for custom extensions or not directly supported extensions you also

916

# need to set EXTENSION_MAPPING for the extension otherwise the files are not

917

# properly processed by doxygen.

INPUT_FILTER =

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

922

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

923

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

924

# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how

925

# filters are used. If the FILTER_PATTERNS tag is empty or if none of the

926

# patterns match the file name, INPUT_FILTER is applied.

927

#

928

# Note that for custom extensions or not directly supported extensions you also

929

# need to set EXTENSION_MAPPING for the extension otherwise the files are not

930

# properly processed by doxygen.

FILTER_PATTERNS =

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

935

# INPUT_FILTER) will also be used to filter the input files that are used for

936

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

937

# The default value is: NO.

938

939

FILTER_SOURCE_FILES = NO

940

941

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

942

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

943

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

944

# *.ext= (so without naming a filter).

945

# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.

946

947

FILTER_SOURCE_PATTERNS =

948

949

# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that

950

# is part of the input, its contents will be placed on the main page

951

# (index.html). This can be useful if you have a project on for instance GitHub

952

# and want to reuse the introduction page also for the doxygen output.

953

954

USE_MDFILE_AS_MAINPAGE = main_page.h

955

956

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

957

# Configuration options related to source browsing

958

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

959

960

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

961

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

962

#

963

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

964

# also VERBATIM_HEADERS is set to NO.

965

# The default value is: NO.

966

967

SOURCE_BROWSER = NO

968

969

# Setting the INLINE_SOURCES tag to YES will include the body of functions,

970

# classes and enums directly into the documentation.

971

# The default value is: NO.

972

973

INLINE_SOURCES = NO

974

975

# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any

976

# special comment blocks from generated source code fragments. Normal C, C++ and

977

# Fortran comments will always remain visible.

978

# The default value is: YES.

979

980

STRIP_CODE_COMMENTS = YES

981

982

# If the REFERENCED_BY_RELATION tag is set to YES then for each documented

983

# function all documented functions referencing it will be listed.

984

# The default value is: NO.

985

986

REFERENCED_BY_RELATION = NO

987

988

# If the REFERENCES_RELATION tag is set to YES then for each documented function

989

# all documented entities called/used by that function will be listed.

990

# The default value is: NO.

991

992

REFERENCES_RELATION = NO

993

994

# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set

995

# to YES then the hyperlinks from functions in REFERENCES_RELATION and

996

# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will

997

# link to the documentation.

998

# The default value is: YES.

999

1000

REFERENCES_LINK_SOURCE = YES

1001

1002

# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the

1003

# source code will show a tooltip with additional information such as prototype,

1004

# brief description and links to the definition and documentation. Since this

1005

# will make the HTML file larger and loading of large files a bit slower, you

1006

# can opt to disable this feature.

1007

# The default value is: YES.

1008

# This tag requires that the tag SOURCE_BROWSER is set to YES.

1009

1010

SOURCE_TOOLTIPS = YES

1011

1012

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

1013

# point to the HTML generated by the htags(1) tool instead of doxygen built-in

1014

# source browser. The htags tool is part of GNU's global source tagging system

1015

# (see http://www.gnu.org/software/global/global.html). You will need version

1016

# 4.8.6 or higher.

1017

#

1018

# To use it do the following:

1019

# - Install the latest version of global

1020

# - Enable SOURCE_BROWSER and USE_HTAGS in the config file

1021

# - Make sure the INPUT points to the root of the source tree

1022

# - Run doxygen as normal

1023

#

1024

# Doxygen will invoke htags (and that will in turn invoke gtags), so these

1025

# tools must be available from the command line (i.e. in the search path).

1026

#

1027

# The result: instead of the source browser generated by doxygen, the links to

1028

# source code will now point to the output of htags.

1029

# The default value is: NO.

1030

# This tag requires that the tag SOURCE_BROWSER is set to YES.

USE_HTAGS = NO

# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a

1035

# verbatim copy of the header file for each class for which an include is

1036

# specified. Set to NO to disable this.

1037

# See also: Section \class.

1038

# The default value is: YES.

1039

1040

VERBATIM_HEADERS = NO

1041

1042

# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the

1043

# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the

1044

# cost of reduced performance. This can be particularly helpful with template

1045

# rich C++ code for which doxygen's built-in parser lacks the necessary type

1046

# information.

1047

# Note: The availability of this option depends on whether or not doxygen was

1048

# generated with the -Duse-libclang=ON option for CMake.

1049

# The default value is: NO.

1050

1051

CLANG_ASSISTED_PARSING = NO

1052

1053

# If clang assisted parsing is enabled you can provide the compiler with command

1054

# line options that you would normally use when invoking the compiler. Note that

1055

# the include paths will already be set by doxygen for the files and directories

1056

# specified with INPUT and INCLUDE_PATH.

1057

# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.

CLANG_OPTIONS =

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

1062

# Configuration options related to the alphabetical class index

1063

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

1064

1065

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

1066

# compounds will be generated. Enable this if the project contains a lot of

1067

# classes, structs, unions or interfaces.

1068

# The default value is: YES.

1069

1070

ALPHABETICAL_INDEX = NO

1071

1072

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

1073

# which the alphabetical index list will be split.

1074

# Minimum value: 1, maximum value: 20, default value: 5.

1075

# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.

1076

1077

COLS_IN_ALPHA_INDEX = 5

1078

1079

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

1080

# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag

1081

# can be used to specify a prefix (or a list of prefixes) that should be ignored

1082

# while generating the index headers.

1083

# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.

IGNORE_PREFIX =

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

1088

# Configuration options related to the HTML output

1089

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

1090

1091

# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output

1092

# The default value is: YES.

1093

1094

GENERATE_HTML = YES

1095

1096

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

1097

# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

1098

# it.

1099

# The default directory is: html.

1100

# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_OUTPUT = html

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

1105

# generated HTML page (for example: .htm, .php, .asp).

1106

# The default value is: .html.

1107

# This tag requires that the tag GENERATE_HTML is set to YES.

1108

1109

HTML_FILE_EXTENSION = .html

1110

1111

# The HTML_HEADER tag can be used to specify a user-defined HTML header file for

1112

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

1113

# standard header.

1114

#

1115

# To get valid HTML the header file that includes any scripts and style sheets

1116

# that doxygen needs, which is dependent on the configuration options used (e.g.

1117

# the setting GENERATE_TREEVIEW). It is highly recommended to start with a

1118

# default header using

1119

# doxygen -w html new_header.html new_footer.html new_stylesheet.css

1120

# YourConfigFile

1121

# and then modify the file new_header.html. See also section "Doxygen usage"

1122

# for information on how to generate the default header that doxygen normally

1123

# uses.

1124

# Note: The header is subject to change so you typically have to regenerate the

1125

# default header when upgrading to a newer version of doxygen. For a description

1126

# of the possible markers and block names see the documentation.

1127

# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_HEADER =

# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each

1132

# generated HTML page. If the tag is left blank doxygen will generate a standard

1133

# footer. See HTML_HEADER for more information on how to generate a default

1134

# footer and what special commands can be used inside the footer. See also

1135

# section "Doxygen usage" for information on how to generate the default footer

1136

# that doxygen normally uses.

1137

# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_FOOTER =

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

1142

# sheet that is used by each HTML page. It can be used to fine-tune the look of

1143

# the HTML output. If left blank doxygen will generate a default style sheet.

1144

# See also section "Doxygen usage" for information on how to generate the style

1145

# sheet that doxygen normally uses.

1146

# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as

1147

# it is more robust and this tag (HTML_STYLESHEET) will in the future become

1148

# obsolete.

1149

# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_STYLESHEET =

# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined

1154

# cascading style sheets that are included after the standard style sheets

1155

# created by doxygen. Using this option one can overrule certain style aspects.

1156

# This is preferred over using HTML_STYLESHEET since it does not replace the

1157

# standard style sheet and is therefore more robust against future updates.

1158

# Doxygen will copy the style sheet files to the output directory.

1159

# Note: The order of the extra style sheet files is of importance (e.g. the last

1160

# style sheet in the list overrules the setting of the previous ones in the

1161

# list). For an example see the documentation.

1162

# This tag requires that the tag GENERATE_HTML is set to YES.

1163

1164

HTML_EXTRA_STYLESHEET =

1165

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES =

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

1177

# will adjust the colors in the style sheet and background images according to

1178

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

1179

# http://en.wikipedia.org/wiki/Hue for more information. For instance the value

1180

# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300

1181

# purple, and 360 is red again.

1182

# Minimum value: 0, maximum value: 359, default value: 220.

1183

# This tag requires that the tag GENERATE_HTML is set to YES.

1184

1185

HTML_COLORSTYLE_HUE = 220

1186

1187

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

1188

# in the HTML output. For a value of 0 the output will use grayscales only. A

1189

# value of 255 will produce the most vivid colors.

1190

# Minimum value: 0, maximum value: 255, default value: 100.

1191

# This tag requires that the tag GENERATE_HTML is set to YES.

1192

1193

HTML_COLORSTYLE_SAT = 100

1194

1195

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the

1196

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

1197

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

1198

# darker. The value divided by 100 is the actual gamma applied, so 80 represents

1199

# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not

1200

# change the gamma.

1201

# Minimum value: 40, maximum value: 240, default value: 80.

1202

# This tag requires that the tag GENERATE_HTML is set to YES.

1203

1204

HTML_COLORSTYLE_GAMMA = 80

1205

1206

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

1207

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

1208

# to YES can help to show when doxygen was last run and thus if the

1209

# documentation is up to date.

1210

# The default value is: NO.

1211

# This tag requires that the tag GENERATE_HTML is set to YES.

1212

1213

HTML_TIMESTAMP = NO

1214

1215

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

1216

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

1217

# page has loaded.

1218

# The default value is: NO.

1219

# This tag requires that the tag GENERATE_HTML is set to YES.

1220

1221

HTML_DYNAMIC_SECTIONS = NO

1222

1223

# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries

1224

# shown in the various tree structured indices initially; the user can expand

1225

# and collapse entries dynamically later on. Doxygen will expand the tree to

1226

# such a level that at most the specified number of entries are visible (unless

1227

# a fully collapsed tree already exceeds this amount). So setting the number of

1228

# entries 1 will produce a full collapsed tree by default. 0 is a special value

1229

# representing an infinite number of entries and will result in a full expanded

1230

# tree by default.

1231

# Minimum value: 0, maximum value: 9999, default value: 100.

1232

# This tag requires that the tag GENERATE_HTML is set to YES.

1233

1234

HTML_INDEX_NUM_ENTRIES = 100

1235

1236

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

1237

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

1238

# environment (see: http://developer.apple.com/tools/xcode/), introduced with

1239

# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a

1240

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

1241

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

1242

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

1243

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

1244

# for more information.

1245

# The default value is: NO.

1246

# This tag requires that the tag GENERATE_HTML is set to YES.

1247

1248

GENERATE_DOCSET = NO

1249

1250

# This tag determines the name of the docset feed. A documentation feed provides

1251

# an umbrella under which multiple documentation sets from a single provider

1252

# (such as a company or product suite) can be grouped.

1253

# The default value is: Doxygen generated docs.

1254

# This tag requires that the tag GENERATE_DOCSET is set to YES.

1255

1256

DOCSET_FEEDNAME = "Doxygen generated docs"

1257

1258

# This tag specifies a string that should uniquely identify the documentation

1259

# set bundle. This should be a reverse domain-name style string, e.g.

1260

# com.mycompany.MyDocSet. Doxygen will append .docset to the name.

1261

# The default value is: org.doxygen.Project.

1262

# This tag requires that the tag GENERATE_DOCSET is set to YES.

1263

1264

DOCSET_BUNDLE_ID = org.doxygen.Project

1265

1266

# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify

1267

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

1268

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

1269

# The default value is: org.doxygen.Publisher.

1270

# This tag requires that the tag GENERATE_DOCSET is set to YES.

1271

1272

DOCSET_PUBLISHER_ID = org.doxygen.Publisher

1273

1274

# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.

1275

# The default value is: Publisher.

1276

# This tag requires that the tag GENERATE_DOCSET is set to YES.

1277

1278

DOCSET_PUBLISHER_NAME = Publisher

1279

1280

# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three

1281

# additional HTML index files: index.hhp, index.hhc, and index.hhk. The

1282

# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop

1283

# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on

1284

# Windows.

1285

#

1286

# The HTML Help Workshop contains a compiler that can convert all HTML output

1287

# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML

1288

# files are now used as the Windows 98 help format, and will replace the old

1289

# Windows help format (.hlp) on all Windows platforms in the future. Compressed

1290

# HTML files also contain an index, a table of contents, and you can search for

1291

# words in the documentation. The HTML workshop also contains a viewer for

1292

# compressed HTML files.

1293

# The default value is: NO.

1294

# This tag requires that the tag GENERATE_HTML is set to YES.

1295

1296

GENERATE_HTMLHELP = NO

1297

1298

# The CHM_FILE tag can be used to specify the file name of the resulting .chm

1299

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

1300

# written to the html output directory.

1301

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

1302

1303

CHM_FILE = lwip.chm

1304

1305

# The HHC_LOCATION tag can be used to specify the location (absolute path

1306

# including file name) of the HTML help compiler (hhc.exe). If non-empty,

1307

# doxygen will try to run the HTML help compiler on the generated index.hhp.

1308

# The file has to be specified with full path.

1309

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

HHC_LOCATION =

# The GENERATE_CHI flag controls if a separate .chi index file is generated

1314

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

1315

# The default value is: NO.

1316

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

GENERATE_CHI = NO

# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)

1321

# and project file content.

1322

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

1323

1324

CHM_INDEX_ENCODING =

1325

1326

# The BINARY_TOC flag controls whether a binary table of contents is generated

1327

# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it

1328

# enables the Previous and Next buttons.

1329

# The default value is: NO.

1330

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

BINARY_TOC = NO

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

1335

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

1336

# The default value is: NO.

1337

# This tag requires that the tag GENERATE_HTMLHELP is set to YES.

TOC_EXPAND = NO

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

1342

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

1343

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

1344

# (.qch) of the generated HTML documentation.

1345

# The default value is: NO.

1346

# This tag requires that the tag GENERATE_HTML is set to YES.

GENERATE_QHP = NO

# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify

1351

# the file name of the resulting .qch file. The path specified is relative to

1352

# the HTML output folder.

1353

# This tag requires that the tag GENERATE_QHP is set to YES.

QCH_FILE =

# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help

1358

# Project output. For more information please see Qt Help Project / Namespace

1359

# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).

1360

# The default value is: org.doxygen.Project.

1361

# This tag requires that the tag GENERATE_QHP is set to YES.

1362

1363

QHP_NAMESPACE = org.doxygen.Project

1364

1365

# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt

1366

# Help Project output. For more information please see Qt Help Project / Virtual

1367

# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-

1368

# folders).

1369

# The default value is: doc.

1370

# This tag requires that the tag GENERATE_QHP is set to YES.

1371

1372

QHP_VIRTUAL_FOLDER = doc

1373

1374

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

1375

# filter to add. For more information please see Qt Help Project / Custom

1376

# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-

1377

# filters).

1378

# This tag requires that the tag GENERATE_QHP is set to YES.

1379

1380

QHP_CUST_FILTER_NAME =

1381

1382

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

1383

# custom filter to add. For more information please see Qt Help Project / Custom

1384

# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-

1385

# filters).

1386

# This tag requires that the tag GENERATE_QHP is set to YES.

1387

1388

QHP_CUST_FILTER_ATTRS =

1389

1390

# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this

1391

# project's filter section matches. Qt Help Project / Filter Attributes (see:

1392

# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).

1393

# This tag requires that the tag GENERATE_QHP is set to YES.

1394

1395

QHP_SECT_FILTER_ATTRS =

1396

1397

# The QHG_LOCATION tag can be used to specify the location of Qt's

1398

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

1399

# generated .qhp file.

1400

# This tag requires that the tag GENERATE_QHP is set to YES.

QHG_LOCATION =

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

1405

# generated, together with the HTML files, they form an Eclipse help plugin. To

1406

# install this plugin and make it available under the help contents menu in

1407

# Eclipse, the contents of the directory containing the HTML and XML files needs

1408

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

1409

# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.

1410

# After copying Eclipse needs to be restarted before the help appears.

1411

# The default value is: NO.

1412

# This tag requires that the tag GENERATE_HTML is set to YES.

1413

1414

GENERATE_ECLIPSEHELP = NO

1415

1416

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

1417

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

1418

# name. Each documentation set should have its own identifier.

1419

# The default value is: org.doxygen.Project.

1420

# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.

1421

1422

ECLIPSE_DOC_ID = org.doxygen.Project

1423

1424

# If you want full control over the layout of the generated HTML pages it might

1425

# be necessary to disable the index and replace it with your own. The

1426

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

1427

# of each HTML page. A value of NO enables the index and the value YES disables

1428

# it. Since the tabs in the index contain the same information as the navigation

1429

# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.

1430

# The default value is: NO.

1431

# This tag requires that the tag GENERATE_HTML is set to YES.

DISABLE_INDEX = NO

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

1436

# structure should be generated to display hierarchical information. If the tag

1437

# value is set to YES, a side panel will be generated containing a tree-like

1438

# index structure (just like the one that is generated for HTML Help). For this

1439

# to work a browser that supports JavaScript, DHTML, CSS and frames is required

1440

# (i.e. any modern browser). Windows users are probably better off using the

1441

# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can

1442

# further fine-tune the look of the index. As an example, the default style

1443

# sheet generated by doxygen has an example that shows how to put an image at

1444

# the root of the tree instead of the PROJECT_NAME. Since the tree basically has

1445

# the same information as the tab index, you could consider setting

1446

# DISABLE_INDEX to YES when enabling this option.

1447

# The default value is: NO.

1448

# This tag requires that the tag GENERATE_HTML is set to YES.

1449

1450

GENERATE_TREEVIEW = YES

1451

1452

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

1453

# doxygen will group on one line in the generated HTML documentation.

1454

#

1455

# Note that a value of 0 will completely suppress the enum values from appearing

1456

# in the overview section.

1457

# Minimum value: 0, maximum value: 20, default value: 4.

1458

# This tag requires that the tag GENERATE_HTML is set to YES.

1459

1460

ENUM_VALUES_PER_LINE = 4

1461

1462

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

1463

# to set the initial width (in pixels) of the frame in which the tree is shown.

1464

# Minimum value: 0, maximum value: 1500, default value: 250.

1465

# This tag requires that the tag GENERATE_HTML is set to YES.

1466

1467

TREEVIEW_WIDTH = 250

1468

1469

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to

1470

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

1471

# The default value is: NO.

1472

# This tag requires that the tag GENERATE_HTML is set to YES.

1473

1474

EXT_LINKS_IN_WINDOW = NO

1475

1476

# Use this tag to change the font size of LaTeX formulas included as images in

1477

# the HTML documentation. When you change the font size after a successful

1478

# doxygen run you need to manually remove any form_*.png images from the HTML

1479

# output directory to force them to be regenerated.

1480

# Minimum value: 8, maximum value: 50, default value: 10.

1481

# This tag requires that the tag GENERATE_HTML is set to YES.

1482

1483

FORMULA_FONTSIZE = 10

1484

1485

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

1486

# generated for formulas are transparent PNGs. Transparent PNGs are not

1487

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

1488

#

1489

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

1490

# the HTML output directory before the changes have effect.

1491

# The default value is: YES.

1492

# This tag requires that the tag GENERATE_HTML is set to YES.

1493

1494

FORMULA_TRANSPARENT = YES

1495

1496

# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see

1497

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

1498

# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX

1499

# installed or if you want to formulas look prettier in the HTML output. When

1500

# enabled you may also need to install MathJax separately and configure the path

1501

# to it using the MATHJAX_RELPATH option.

1502

# The default value is: NO.

1503

# This tag requires that the tag GENERATE_HTML is set to YES.

USE_MATHJAX = NO

# When MathJax is enabled you can set the default output format to be used for

1508

# the MathJax output. See the MathJax site (see:

1509

# http://docs.mathjax.org/en/latest/output.html) for more details.

1510

# Possible values are: HTML-CSS (which is slower, but has the best

1511

# compatibility), NativeMML (i.e. MathML) and SVG.

1512

# The default value is: HTML-CSS.

1513

# This tag requires that the tag USE_MATHJAX is set to YES.

1514

1515

MATHJAX_FORMAT = HTML-CSS

1516

1517

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

1518

# output directory using the MATHJAX_RELPATH option. The destination directory

1519

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

1520

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

1521

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

1522

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

1523

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

1524

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

1525

# The default value is: http://cdn.mathjax.org/mathjax/latest.

1526

# This tag requires that the tag USE_MATHJAX is set to YES.

1527

1528

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

1529

1530

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

1531

# extension names that should be enabled during MathJax rendering. For example

1532

# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols

1533

# This tag requires that the tag USE_MATHJAX is set to YES.

1534

1535

MATHJAX_EXTENSIONS =

1536

1537

# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces

1538

# of code that will be used on startup of the MathJax code. See the MathJax site

1539

# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an

1540

# example see the documentation.

1541

# This tag requires that the tag USE_MATHJAX is set to YES.

MATHJAX_CODEFILE =

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

1546

# the HTML output. The underlying search engine uses javascript and DHTML and

1547

# should work on any modern browser. Note that when using HTML help

1548

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

1549

# there is already a search function so this one should typically be disabled.

1550

# For large projects the javascript based search engine can be slow, then

1551

# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to

1552

# search using the keyboard; to jump to the search box use <access key> + S

1553

# (what the <access key> is depends on the OS and browser, but it is typically

1554

# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down

1555

# key> to jump into the search results window, the results can be navigated

1556

# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel

1557

# the search. The filter options can be selected when the cursor is inside the

1558

# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>

1559

# to select a filter and <Enter> or <escape> to activate or cancel the filter

1560

# option.

1561

# The default value is: YES.

1562

# This tag requires that the tag GENERATE_HTML is set to YES.

SEARCHENGINE = YES

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

1567

# implemented using a web server instead of a web client using Javascript. There

1568

# are two flavors of web server based searching depending on the EXTERNAL_SEARCH

1569

# setting. When disabled, doxygen will generate a PHP script for searching and

1570

# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing

1571

# and searching needs to be provided by external tools. See the section

1572

# "External Indexing and Searching" for details.

1573

# The default value is: NO.

1574

# This tag requires that the tag SEARCHENGINE is set to YES.

1575

1576

SERVER_BASED_SEARCH = NO

1577

1578

# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP

1579

# script for searching. Instead the search results are written to an XML file

1580

# which needs to be processed by an external indexer. Doxygen will invoke an

1581

# external search engine pointed to by the SEARCHENGINE_URL option to obtain the

1582

# search results.

1583

#

1584

# Doxygen ships with an example indexer (doxyindexer) and search engine

1585

# (doxysearch.cgi) which are based on the open source search engine library

1586

# Xapian (see: http://xapian.org/).

1587

#

1588

# See the section "External Indexing and Searching" for details.

1589

# The default value is: NO.

1590

# This tag requires that the tag SEARCHENGINE is set to YES.

1591

1592

EXTERNAL_SEARCH = NO

1593

1594

# The SEARCHENGINE_URL should point to a search engine hosted by a web server

1595

# which will return the search results when EXTERNAL_SEARCH is enabled.

1596

#

1597

# Doxygen ships with an example indexer (doxyindexer) and search engine

1598

# (doxysearch.cgi) which are based on the open source search engine library

1599

# Xapian (see: http://xapian.org/). See the section "External Indexing and

1600

# Searching" for details.

1601

# This tag requires that the tag SEARCHENGINE is set to YES.

SEARCHENGINE_URL =

# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed

1606

# search data is written to a file for indexing by an external tool. With the

1607

# SEARCHDATA_FILE tag the name of this file can be specified.

1608

# The default file is: searchdata.xml.

1609

# This tag requires that the tag SEARCHENGINE is set to YES.

1610

1611

SEARCHDATA_FILE = searchdata.xml

1612

1613

# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the

1614

# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is

1615

# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple

1616

# projects and redirect the results back to the right project.

1617

# This tag requires that the tag SEARCHENGINE is set to YES.

1618

1619

EXTERNAL_SEARCH_ID =

1620

1621

# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen

1622

# projects other than the one defined by this configuration file, but that are

1623

# all added to the same external search index. Each project needs to have a

1624

# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of

1625

# to a relative location where the documentation can be found. The format is:

1626

# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...

1627

# This tag requires that the tag SEARCHENGINE is set to YES.

1628

1629

EXTRA_SEARCH_MAPPINGS =

1630

1631

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

1632

# Configuration options related to the LaTeX output

1633

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

1634

1635

# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.

1636

# The default value is: YES.

1637

1638

GENERATE_LATEX = NO

1639

1640

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

1641

# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

1642

# it.

1643

# The default directory is: latex.

1644

# This tag requires that the tag GENERATE_LATEX is set to YES.

1645

1646

LATEX_OUTPUT = latex

1647

1648

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

1649

# invoked.

1650

#

1651

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

1652

# bitmaps for formulas in the HTML output, but not in the Makefile that is

1653

# written to the output directory.

1654

# The default file is: latex.

1655

# This tag requires that the tag GENERATE_LATEX is set to YES.

1656

1657

LATEX_CMD_NAME = latex

1658

1659

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

1660

# index for LaTeX.

1661

# The default file is: makeindex.

1662

# This tag requires that the tag GENERATE_LATEX is set to YES.

1663

1664

MAKEINDEX_CMD_NAME = makeindex

1665

1666

# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX

1667

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

1668

# trees in general.

1669

# The default value is: NO.

1670

# This tag requires that the tag GENERATE_LATEX is set to YES.

COMPACT_LATEX = NO

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

1675

# printer.

1676

# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x

1677

# 14 inches) and executive (7.25 x 10.5 inches).

1678

# The default value is: a4.

1679

# This tag requires that the tag GENERATE_LATEX is set to YES.

1680

1681

PAPER_TYPE = a4wide

1682

1683

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

1684

# that should be included in the LaTeX output. The package can be specified just

1685

# by its name or with the correct syntax as to be used with the LaTeX

1686

# \usepackage command. To get the times font for instance you can specify :

1687

# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}

1688

# To use the option intlimits with the amsmath package you can specify:

1689

# EXTRA_PACKAGES=[intlimits]{amsmath}

1690

# If left blank no extra packages will be included.

1691

# This tag requires that the tag GENERATE_LATEX is set to YES.

EXTRA_PACKAGES =

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

1696

# generated LaTeX document. The header should contain everything until the first

1697

# chapter. If it is left blank doxygen will generate a standard header. See

1698

# section "Doxygen usage" for information on how to let doxygen write the

1699

# default header to a separate file.

1700

#

1701

# Note: Only use a user-defined header if you know what you are doing! The

1702

# following commands have a special meaning inside the header: $title,

1703

# $datetime, $date, $doxygenversion, $projectname, $projectnumber,

1704

# $projectbrief, $projectlogo. Doxygen will replace $title with the empty

1705

# string, for the replacement values of the other commands the user is referred

1706

# to HTML_HEADER.

1707

# This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_HEADER =

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

1712

# generated LaTeX document. The footer should contain everything after the last

1713

# chapter. If it is left blank doxygen will generate a standard footer. See

1714

# LATEX_HEADER for more information on how to generate a default footer and what

1715

# special commands can be used inside the footer.

1716

#

1717

# Note: Only use a user-defined footer if you know what you are doing!

1718

# This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_FOOTER =

# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined

1723

# LaTeX style sheets that are included after the standard style sheets created

1724

# by doxygen. Using this option one can overrule certain style aspects. Doxygen

1725

# will copy the style sheet files to the output directory.

1726

# Note: The order of the extra style sheet files is of importance (e.g. the last

1727

# style sheet in the list overrules the setting of the previous ones in the

1728

# list).

1729

# This tag requires that the tag GENERATE_LATEX is set to YES.

1730

1731

LATEX_EXTRA_STYLESHEET =

1732

1733

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

1734

# other source files which should be copied to the LATEX_OUTPUT output

1735

# directory. Note that the files will be copied as-is; there are no commands or

1736

# markers available.

1737

# This tag requires that the tag GENERATE_LATEX is set to YES.

1738

1739

LATEX_EXTRA_FILES =

1740

1741

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

1742

# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will

1743

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

1744

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

1745

# The default value is: YES.

1746

# This tag requires that the tag GENERATE_LATEX is set to YES.

1747

1748

PDF_HYPERLINKS = NO

1749

1750

# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate

1751

# the PDF file directly from the LaTeX files. Set this option to YES, to get a

1752

# higher quality PDF documentation.

1753

# The default value is: YES.

1754

# This tag requires that the tag GENERATE_LATEX is set to YES.

USE_PDFLATEX = NO

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

1759

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

1760

# if errors occur, instead of asking the user for help. This option is also used

1761

# when generating formulas in HTML.

1762

# The default value is: NO.

1763

# This tag requires that the tag GENERATE_LATEX is set to YES.

1764

1765

LATEX_BATCHMODE = NO

1766

1767

# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the

1768

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

1769

# The default value is: NO.

1770

# This tag requires that the tag GENERATE_LATEX is set to YES.

1771

1772

LATEX_HIDE_INDICES = NO

1773

1774

# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source

1775

# code with syntax highlighting in the LaTeX output.

1776

#

1777

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

1778

# SOURCE_BROWSER.

1779

# The default value is: NO.

1780

# This tag requires that the tag GENERATE_LATEX is set to YES.

1781

1782

LATEX_SOURCE_CODE = NO

1783

1784

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

1785

# bibliography, e.g. plainnat, or ieeetr. See

1786

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

1787

# The default value is: plain.

1788

# This tag requires that the tag GENERATE_LATEX is set to YES.

1789

1790

LATEX_BIB_STYLE = plain

1791

1792

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

1793

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

1794

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

1795

# The default value is: NO.

1796

# This tag requires that the tag GENERATE_LATEX is set to YES.

1797

1798

LATEX_TIMESTAMP = NO

1799

1800

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

1801

# Configuration options related to the RTF output

1802

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

1803

1804

# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The

1805

# RTF output is optimized for Word 97 and may not look too pretty with other RTF

1806

# readers/editors.

1807

# The default value is: NO.

GENERATE_RTF = NO

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

1812

# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

1813

# it.

1814

# The default directory is: rtf.

1815

# This tag requires that the tag GENERATE_RTF is set to YES.

RTF_OUTPUT = rtf

# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF

1820

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

1821

# trees in general.

1822

# The default value is: NO.

1823

# This tag requires that the tag GENERATE_RTF is set to YES.

COMPACT_RTF = NO

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

1828

# contain hyperlink fields. The RTF file will contain links (just like the HTML

1829

# output) instead of page references. This makes the output suitable for online

1830

# browsing using Word or some other Word compatible readers that support those

1831

# fields.

1832

#

1833

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

1834

# The default value is: NO.

1835

# This tag requires that the tag GENERATE_RTF is set to YES.

1836

1837

RTF_HYPERLINKS = NO

1838

1839

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

1840

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

1841

# missing definitions are set to their default value.

1842

#

1843

# See also section "Doxygen usage" for information on how to generate the

1844

# default style sheet that doxygen normally uses.

1845

# This tag requires that the tag GENERATE_RTF is set to YES.

1846

1847

RTF_STYLESHEET_FILE =

1848

1849

# Set optional variables used in the generation of an RTF document. Syntax is

1850

# similar to doxygen's config file. A template extensions file can be generated

1851

# using doxygen -e rtf extensionFile.

1852

# This tag requires that the tag GENERATE_RTF is set to YES.

1853

1854

RTF_EXTENSIONS_FILE =

1855

1856

# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code

1857

# with syntax highlighting in the RTF output.

1858

#

1859

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

1860

# SOURCE_BROWSER.

1861

# The default value is: NO.

1862

# This tag requires that the tag GENERATE_RTF is set to YES.

1863

1864

RTF_SOURCE_CODE = NO

1865

1866

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

1867

# Configuration options related to the man page output

1868

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

1869

1870

# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for

1871

# classes and files.

1872

# The default value is: NO.

GENERATE_MAN = NO

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

1877

# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

1878

# it. A directory man3 will be created inside the directory specified by

1879

# MAN_OUTPUT.

1880

# The default directory is: man.

1881

# This tag requires that the tag GENERATE_MAN is set to YES.

MAN_OUTPUT = man

# The MAN_EXTENSION tag determines the extension that is added to the generated

1886

# man pages. In case the manual section does not start with a number, the number

1887

# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is

1888

# optional.

1889

# The default value is: .3.

1890

# This tag requires that the tag GENERATE_MAN is set to YES.

MAN_EXTENSION = .3

# The MAN_SUBDIR tag determines the name of the directory created within

1895

# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by

1896

# MAN_EXTENSION with the initial . removed.

1897

# This tag requires that the tag GENERATE_MAN is set to YES.

MAN_SUBDIR =

# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it

1902

# will generate one additional man file for each entity documented in the real

1903

# man page(s). These additional files only source the real man page, but without

1904

# them the man command would be unable to find the correct page.

1905

# The default value is: NO.

1906

# This tag requires that the tag GENERATE_MAN is set to YES.

MAN_LINKS = NO

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

1911

# Configuration options related to the XML output

1912

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

1913

1914

# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that

1915

# captures the structure of the code including all documentation.

1916

# The default value is: NO.

GENERATE_XML = NO

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

1921

# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

1922

# it.

1923

# The default directory is: xml.

1924

# This tag requires that the tag GENERATE_XML is set to YES.

XML_OUTPUT = xml

# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program

1929

# listings (including syntax highlighting and cross-referencing information) to

1930

# the XML output. Note that enabling this will significantly increase the size

1931

# of the XML output.

1932

# The default value is: YES.

1933

# This tag requires that the tag GENERATE_XML is set to YES.

1934

1935

XML_PROGRAMLISTING = YES

1936

1937

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

1938

# Configuration options related to the DOCBOOK output

1939

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

1940

1941

# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files

1942

# that can be used to generate PDF.

1943

# The default value is: NO.

1944

1945

GENERATE_DOCBOOK = NO

1946

1947

# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.

1948

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

1949

# front of it.

1950

# The default directory is: docbook.

1951

# This tag requires that the tag GENERATE_DOCBOOK is set to YES.

1952

1953

DOCBOOK_OUTPUT = docbook

1954

1955

# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the

1956

# program listings (including syntax highlighting and cross-referencing

1957

# information) to the DOCBOOK output. Note that enabling this will significantly

1958

# increase the size of the DOCBOOK output.

1959

# The default value is: NO.

1960

# This tag requires that the tag GENERATE_DOCBOOK is set to YES.

1961

1962

DOCBOOK_PROGRAMLISTING = NO

1963

1964

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

1965

# Configuration options for the AutoGen Definitions output

1966

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

1967

1968

# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an

1969

# AutoGen Definitions (see http://autogen.sf.net) file that captures the

1970

# structure of the code including all documentation. Note that this feature is

1971

# still experimental and incomplete at the moment.

1972

# The default value is: NO.

1973

1974

GENERATE_AUTOGEN_DEF = NO

1975

1976

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

1977

# Configuration options related to the Perl module output

1978

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

1979

1980

# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module

1981

# file that captures the structure of the code including all documentation.

1982

#

1983

# Note that this feature is still experimental and incomplete at the moment.

1984

# The default value is: NO.

1985

1986

GENERATE_PERLMOD = NO

1987

1988

# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary

1989

# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI

1990

# output from the Perl module output.

1991

# The default value is: NO.

1992

# This tag requires that the tag GENERATE_PERLMOD is set to YES.

PERLMOD_LATEX = NO

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

1997

# formatted so it can be parsed by a human reader. This is useful if you want to

1998

# understand what is going on. On the other hand, if this tag is set to NO, the

1999

# size of the Perl module output will be much smaller and Perl will parse it

2000

# just the same.

2001

# The default value is: YES.

2002

# This tag requires that the tag GENERATE_PERLMOD is set to YES.

2003

2004

PERLMOD_PRETTY = YES

2005

2006

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

2007

# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful

2008

# so different doxyrules.make files included by the same Makefile don't

2009

# overwrite each other's variables.

2010

# This tag requires that the tag GENERATE_PERLMOD is set to YES.

2011

2012

PERLMOD_MAKEVAR_PREFIX =

2013

2014

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

2015

# Configuration options related to the preprocessor

2016

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

2017

2018

# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all

2019

# C-preprocessor directives found in the sources and include files.

2020

# The default value is: YES.

2021

2022

ENABLE_PREPROCESSING = YES

2023

2024

# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names

2025

# in the source code. If set to NO, only conditional compilation will be

2026

# performed. Macro expansion can be done in a controlled way by setting

2027

# EXPAND_ONLY_PREDEF to YES.

2028

# The default value is: NO.

2029

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

2030

2031

MACRO_EXPANSION = YES

2032

2033

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

2034

# the macro expansion is limited to the macros specified with the PREDEFINED and

2035

# EXPAND_AS_DEFINED tags.

2036

# The default value is: NO.

2037

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

2038

2039

EXPAND_ONLY_PREDEF = NO

2040

2041

# If the SEARCH_INCLUDES tag is set to YES, the include files in the

2042

# INCLUDE_PATH will be searched if a #include is found.

2043

# The default value is: YES.

2044

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

2045

2046

SEARCH_INCLUDES = YES

2047

2048

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

2049

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

2050

# preprocessor.

2051

# This tag requires that the tag SEARCH_INCLUDES is set to YES.

2052

2053

INCLUDE_PATH = ../../src/include

2054

2055

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

2056

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

2057

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

2058

# used.

2059

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

2060

2061

INCLUDE_FILE_PATTERNS = *.h

2062

2063

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

2064

# defined before the preprocessor is started (similar to the -D option of e.g.

2065

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

2066

# name=definition (no spaces). If the definition and the "=" are omitted, "=1"

2067

# is assumed. To prevent a macro definition from being undefined via #undef or

2068

# recursively expanded use the := operator instead of the = operator.

2069

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

2070

2071

PREDEFINED = __DOXYGEN__=1 \

2072

NO_SYS=0 \

2073

SYS_LIGHTWEIGHT_PROT=1 \

2074

LWIP_TCPIP_CORE_LOCKING=1 \

LWIP_IPV4=1 \

LWIP_IPV6=1 \

LWIP_ICMP=1 \

LWIP_RAW=1 \

LWIP_DHCP=1 \

LWIP_UDPLITE=1 \

LWIP_UDP=1 \

LWIP_IGMP=1 \

LWIP_TCP=1 \

LWIP_ALTCP=1 \

LWIP_ALTCP_TLS=1 \

LWIP_IPV6_SCOPES=1 \

2087

TCP_LISTEN_BACKLOG=1 \

2088

LWIP_SNMP=1 \

2089

SNMP_USE_NETCONN=1 \

2090

SNMP_USE_RAW=1 \

2091

MIB2_STATS=1 \

2092

LWIP_MDNS_RESPONDER=1 \

2093

MEMP_OVERFLOW_CHECK=0 \

2094

MEMP_SANITY_CHECK=1 \

2095

LWIP_ARP=1 \

2096

LWIP_HAVE_LOOPIF=1 \

2097

LWIP_NETIF_HOSTNAME=1 \

2098

LWIP_NETIF_API=1 \

2099

LWIP_NETIF_CALLBACK=1 \

2100

LWIP_NETIF_STATUS_CALLBACK=1 \

2101

LWIP_NETIF_REMOVE_CALLBACK=1 \

2102

LWIP_NETIF_LINK_CALLBACK=1 \

2103

LWIP_NETIF_EXT_STATUS_CALLBACK = 1 \

2104

LWIP_NUM_NETIF_CLIENT_DATA=1 \

2105

ENABLE_LOOPBACK=1 \

LWIP_AUTOIP=1 \

ARP_QUEUEING=1 \

LWIP_STATS=1 \

MEM_USE_POOLS=0 \

LWIP_DNS=1 \

LWIP_SOCKET=1 \

LWIP_NETCONN=1 \

IP_SOF_BROADCAST=1 \

2114

IP_SOF_BROADCAST_RECV=1 \

2115

LWIP_NETIF_API=1 \

2116

LWIP_SO_SNDTIMEO=1 \

LWIP_SO_RCVBUF=1 \

LWIP_SO_LINGER=1 \

SO_REUSE=1 \

SO_REUSE_RXTOALL=1 \

2121

LWIP_HAVE_SLIPIF=1 \

2122

LWIP_6LOWPAN=1 \

2123

HTTPD_ENABLE_HTTPS=1

2124

2125

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

2126

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

2127

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

2128

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

2129

# definition found in the source code.

2130

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

2131

2132

EXPAND_AS_DEFINED =

2133

2134

# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will

2135

# remove all references to function-like macros that are alone on a line, have

2136

# an all uppercase name, and do not end with a semicolon. Such function macros

2137

# are typically used for boiler-plate code, and will confuse the parser if not

2138

# removed.

2139

# The default value is: YES.

2140

# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

2141

2142

SKIP_FUNCTION_MACROS = NO

2143

2144

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

2145

# Configuration options related to external references

2146

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

2147

2148

# The TAGFILES tag can be used to specify one or more tag files. For each tag

2149

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

2150

# a tag file without this location is as follows:

2151

# TAGFILES = file1 file2 ...

2152

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

2153

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

2154

# where loc1 and loc2 can be relative or absolute paths or URLs. See the

2155

# section "Linking to external documentation" for more information about the use

2156

# of tag files.

2157

# Note: Each tag file must have a unique name (where the name does NOT include

2158

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

2159

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

TAGFILES =

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

2164

# tag file that is based on the input files it reads. See section "Linking to

2165

# external documentation" for more information about the usage of tag files.

GENERATE_TAGFILE =

# If the ALLEXTERNALS tag is set to YES, all external class will be listed in

2170

# the class index. If set to NO, only the inherited external classes will be

2171

# listed.

2172

# The default value is: NO.

ALLEXTERNALS = NO

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

2177

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

2178

# listed.

2179

# The default value is: YES.

2180

2181

EXTERNAL_GROUPS = YES

2182

2183

# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in

2184

# the related pages index. If set to NO, only the current project's pages will

2185

# be listed.

2186

# The default value is: YES.

2187

2188

EXTERNAL_PAGES = YES

2189

2190

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

2191

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

2192

# The default file (with absolute path) is: /usr/bin/perl.

2193

2194

PERL_PATH = /usr/bin/perl

2195

2196

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

2197

# Configuration options related to the dot tool

2198

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

2199

2200

# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram

2201

# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to

2202

# NO turns the diagrams off. Note that this option also works with HAVE_DOT

2203

# disabled, but it is recommended to install and use dot, since it yields more

2204

# powerful graphs.

2205

# The default value is: YES.

2206

2207

CLASS_DIAGRAMS = YES

2208

2209

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

2210

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

2211

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

2212

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

2213

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

2214

# default search path.

MSCGEN_PATH =

# You can include diagrams made with dia in doxygen documentation. Doxygen will

2219

# then run dia to produce the diagram and insert it in the documentation. The

2220

# DIA_PATH tag allows you to specify the directory where the dia binary resides.

2221

# If left empty dia is assumed to be found in the default search path.

DIA_PATH =

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

2226

# and usage relations if the target is undocumented or is not a class.

2227

# The default value is: YES.

2228

2229

HIDE_UNDOC_RELATIONS = YES

2230

2231

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

2232

# available from the path. This tool is part of Graphviz (see:

2233

# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent

2234

# Bell Labs. The other options in this section have no effect if this option is

2235

# set to NO

2236

# The default value is: YES.

HAVE_DOT = NO

# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed

2241

# to run in parallel. When set to 0 doxygen will base this on the number of

2242

# processors available in the system. You can set it explicitly to a value

2243

# larger than 0 to get control over the balance between CPU load and processing

2244

# speed.

2245

# Minimum value: 0, maximum value: 32, default value: 0.

2246

# This tag requires that the tag HAVE_DOT is set to YES.

2247

2248

DOT_NUM_THREADS = 0

2249

2250

# When you want a differently looking font in the dot files that doxygen

2251

# generates you can specify the font name using DOT_FONTNAME. You need to make

2252

# sure dot is able to find the font, which can be done by putting it in a

2253

# standard location or by setting the DOTFONTPATH environment variable or by

2254

# setting DOT_FONTPATH to the directory containing the font.

2255

# The default value is: Helvetica.

2256

# This tag requires that the tag HAVE_DOT is set to YES.

2257

2258

DOT_FONTNAME = Helvetica

2259

2260

# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of

2261

# dot graphs.

2262

# Minimum value: 4, maximum value: 24, default value: 10.

2263

# This tag requires that the tag HAVE_DOT is set to YES.

DOT_FONTSIZE = 10

# By default doxygen will tell dot to use the default font as specified with

2268

# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set

2269

# the path where dot can find it using this tag.

2270

# This tag requires that the tag HAVE_DOT is set to YES.

DOT_FONTPATH =

# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for

2275

# each documented class showing the direct and indirect inheritance relations.

2276

# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.

2277

# The default value is: YES.

2278

# This tag requires that the tag HAVE_DOT is set to YES.

CLASS_GRAPH = YES

# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a

2283

# graph for each documented class showing the direct and indirect implementation

2284

# dependencies (inheritance, containment, and class references variables) of the

2285

# class with other documented classes.

2286

# The default value is: YES.

2287

# This tag requires that the tag HAVE_DOT is set to YES.

2288

2289

COLLABORATION_GRAPH = YES

2290

2291

# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for

2292

# groups, showing the direct groups dependencies.

2293

# The default value is: YES.

2294

# This tag requires that the tag HAVE_DOT is set to YES.

GROUP_GRAPHS = YES

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

2299

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

2300

# Language.

2301

# The default value is: NO.

2302

# This tag requires that the tag HAVE_DOT is set to YES.

UML_LOOK = NO

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

2307

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

2308

# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the

2309

# number of items for each type to make the size more manageable. Set this to 0

2310

# for no limit. Note that the threshold may be exceeded by 50% before the limit

2311

# is enforced. So when you set the threshold to 10, up to 15 fields may appear,

2312

# but if the number exceeds 15, the total amount of fields shown is limited to

2313

# 10.

2314

# Minimum value: 0, maximum value: 100, default value: 10.

2315

# This tag requires that the tag HAVE_DOT is set to YES.

2316

2317

UML_LIMIT_NUM_FIELDS = 10

2318

2319

# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and

2320

# collaboration graphs will show the relations between templates and their

2321

# instances.

2322

# The default value is: NO.

2323

# This tag requires that the tag HAVE_DOT is set to YES.

2324

2325

TEMPLATE_RELATIONS = NO

2326

2327

# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to

2328

# YES then doxygen will generate a graph for each documented file showing the

2329

# direct and indirect include dependencies of the file with other documented

2330

# files.

2331

# The default value is: YES.

2332

# This tag requires that the tag HAVE_DOT is set to YES.

2333

2334

INCLUDE_GRAPH = YES

2335

2336

# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are

2337

# set to YES then doxygen will generate a graph for each documented file showing

2338

# the direct and indirect include dependencies of the file with other documented

2339

# files.

2340

# The default value is: YES.

2341

# This tag requires that the tag HAVE_DOT is set to YES.

2342

2343

INCLUDED_BY_GRAPH = YES

2344

2345

# If the CALL_GRAPH tag is set to YES then doxygen will generate a call

2346

# dependency graph for every global function or class method.

2347

#

2348

# Note that enabling this option will significantly increase the time of a run.

2349

# So in most cases it will be better to enable call graphs for selected

2350

# functions only using the \callgraph command. Disabling a call graph can be

2351

# accomplished by means of the command \hidecallgraph.

2352

# The default value is: NO.

2353

# This tag requires that the tag HAVE_DOT is set to YES.

CALL_GRAPH = NO

# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller

2358

# dependency graph for every global function or class method.

2359

#

2360

# Note that enabling this option will significantly increase the time of a run.

2361

# So in most cases it will be better to enable caller graphs for selected

2362

# functions only using the \callergraph command. Disabling a caller graph can be

2363

# accomplished by means of the command \hidecallergraph.

2364

# The default value is: NO.

2365

# This tag requires that the tag HAVE_DOT is set to YES.

CALLER_GRAPH = NO

# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical

2370

# hierarchy of all classes instead of a textual one.

2371

# The default value is: YES.

2372

# This tag requires that the tag HAVE_DOT is set to YES.

2373

2374

GRAPHICAL_HIERARCHY = YES

2375

2376

# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the

2377

# dependencies a directory has on other directories in a graphical way. The

2378

# dependency relations are determined by the #include relations between the

2379

# files in the directories.

2380

# The default value is: YES.

2381

# This tag requires that the tag HAVE_DOT is set to YES.

2382

2383

DIRECTORY_GRAPH = YES

2384

2385

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

2386

# generated by dot. For an explanation of the image formats see the section

2387

# output formats in the documentation of the dot tool (Graphviz (see:

2388

# http://www.graphviz.org/)).

2389

# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order

2390

# to make the SVG files visible in IE 9+ (other browsers do not have this

2391

# requirement).

2392

# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,

2393

# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,

2394

# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,

2395

# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and

2396

# png:gdiplus:gdiplus.

2397

# The default value is: png.

2398

# This tag requires that the tag HAVE_DOT is set to YES.

2399

2400

DOT_IMAGE_FORMAT = png

2401

2402

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

2403

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

2404

#

2405

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

2406

# and working are Firefox, Chrome, Safari, and Opera.

2407

# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make

2408

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

2409

# The default value is: NO.

2410

# This tag requires that the tag HAVE_DOT is set to YES.

2411

2412

INTERACTIVE_SVG = NO

2413

2414

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

2415

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

2416

# This tag requires that the tag HAVE_DOT is set to YES.

DOT_PATH =

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

2421

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

2422

# command).

2423

# This tag requires that the tag HAVE_DOT is set to YES.

DOTFILE_DIRS =

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

2428

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

# command).

MSCFILE_DIRS =

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

2434

# contain dia files that are included in the documentation (see the \diafile

# command).

DIAFILE_DIRS =

# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the

2440

# path where java can find the plantuml.jar file. If left blank, it is assumed

2441

# PlantUML is not used or called during a preprocessing step. Doxygen will

2442

# generate a warning when it encounters a \startuml command in this case and

2443

# will not generate output for the diagram.

2444

2445

PLANTUML_JAR_PATH =

2446

2447

# When using plantuml, the specified paths are searched for files specified by

2448

# the !include statement in a plantuml block.

2449

2450

PLANTUML_INCLUDE_PATH =

2451

2452

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

2453

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

2454

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

2455

# by representing a node as a red box. Note that doxygen if the number of direct

2456

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

2457

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

2458

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

2459

# Minimum value: 0, maximum value: 10000, default value: 50.

2460

# This tag requires that the tag HAVE_DOT is set to YES.

2461

2462

DOT_GRAPH_MAX_NODES = 50

2463

2464

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

2465

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

2466

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

2467

# further from the root node will be omitted. Note that setting this option to 1

2468

# or 2 may greatly reduce the computation time needed for large code bases. Also

2469

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

2470

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

2471

# Minimum value: 0, maximum value: 1000, default value: 0.

2472

# This tag requires that the tag HAVE_DOT is set to YES.

2473

2474

MAX_DOT_GRAPH_DEPTH = 1000

2475

2476

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

2477

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

2478

# to support this out of the box.

2479

#

2480

# Warning: Depending on the platform used, enabling this option may lead to

2481

# badly anti-aliased labels on the edges of a graph (i.e. they become hard to

2482

# read).

2483

# The default value is: NO.

2484

# This tag requires that the tag HAVE_DOT is set to YES.

2485

2486

DOT_TRANSPARENT = NO

2487

2488

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

2489

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

2490

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

2491

# this, this feature is disabled by default.

2492

# The default value is: NO.

2493

# This tag requires that the tag HAVE_DOT is set to YES.

2494

2495

DOT_MULTI_TARGETS = NO

2496

2497

# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page

2498

# explaining the meaning of the various boxes and arrows in the dot generated

2499

# graphs.

2500

# The default value is: YES.

2501

# This tag requires that the tag HAVE_DOT is set to YES.

2502

2503

GENERATE_LEGEND = YES

2504

2505

# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot

2506

# files that are used to generate the various graphs.

2507

# The default value is: YES.

2508

# This tag requires that the tag HAVE_DOT is set to YES.

2509

2510

DOT_CLEANUP = YES

BadVPN – Blame information for rev 1