~oif-team/geis/2.1.2 : revision 116.1.1

1

# Doxyfile 1.7.1

1

# Doxyfile 1.7.3

2

3

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

4

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

31

# This could be handy for archiving the generated documentation or

32

# if some version control system is used.

33

34

PROJECT_NUMBER = 0.3

34

PROJECT_NUMBER = 2.0

35

36

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

37

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

38

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

39

40

PROJECT_BRIEF = "Gesture Engine Interface Support"

41

42

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

43

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

44

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

45

# Doxygen will copy the logo to the output directory.

46

47

PROJECT_LOGO = logo_x64.png

35

48

36

49

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

37

50

# base path where the generated documentation will be put.

57

70

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

58

71

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

59

72

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

60

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

73

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

61

74

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

62

75

63

76

OUTPUT_LANGUAGE = English

136

149

STRIP_FROM_INC_PATH =

137

150

138

151

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

139

# (but less readable) file names. This can be useful is your file systems

152

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

140

153

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

141

154

142

155

SHORT_NAMES = NO

147

160

# comments will behave just like regular Qt-style comments

148

161

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

149

162

150

JAVADOC_AUTOBRIEF = NO

163

JAVADOC_AUTOBRIEF = YES

151

164

152

165

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

153

166

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

233

246

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

234

247

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

235

248

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

236

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

249

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

237

250

# diagrams that involve STL classes more complete and accurate.

238

251

239

252

BUILTIN_STL_SUPPORT = NO

251

264

252

265

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

253

266

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

254

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

267

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

255

268

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

256

269

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

257

270

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

289

302

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

290

303

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

291

304

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

292

# causing a significant performance penality.

305

# causing a significant performance penalty.

293

306

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

294

307

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

295

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

308

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

296

309

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

297

310

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

298

311

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

337

350

# extracted and appear in the documentation as a namespace called

338

351

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

339

352

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

340

# anonymous namespace are hidden.

353

# anonymous namespaces are hidden.

341

354

342

355

EXTRACT_ANON_NSPACES = NO

343

356

448

461

449

462

SORT_BY_SCOPE_NAME = NO

450

463

464

# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to

465

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

466

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

467

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

468

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

469

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

470

471

STRICT_PROTO_MATCHING = NO

472

451

473

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

452

474

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

453

475

# commands in the documentation.

478

500

ENABLED_SECTIONS =

479

501

480

502

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines

481

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

503

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

482

504

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

483

505

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

484

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

506

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

485

507

# documentation can be controlled using \showinitializer or \hideinitializer

486

508

# command in the documentation regardless of this setting.

487

509

488

MAX_INITIALIZER_LINES = 30

510

MAX_INITIALIZER_LINES = 0

489

511

490

512

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

491

513

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

558

580

559

581

WARN_IF_DOC_ERROR = YES

560

582

561

# This WARN_NO_PARAMDOC option can be abled to get warnings for

583

# The WARN_NO_PARAMDOC option can be enabled to get warnings for

562

584

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

563

585

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

564

586

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

590

612

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

591

613

# with spaces.

592

614

593

INPUT = ../include/geis

615

INPUT = ../include/geis \

616

.

594

617

595

618

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

596

619

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

604

627

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

605

628

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

606

629

# blank the following patterns are tested:

607

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

608

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

630

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

631

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

632

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

609

633

610

634

FILE_PATTERNS = *.c \

611

635

*.cc \

637

661

*.f90 \

638

662

*.f \

639

663

*.vhd \

640

*.vhdl

664

*.vhdl \

665

*.dox

641

666

642

667

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

643

668

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

652

677

EXCLUDE =

653

678

654

679

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

655

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

680

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

656

681

# from the input.

657

682

658

683

EXCLUDE_SYMLINKS = NO

677

702

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

678

703

# the \include command).

679

704

680

EXAMPLE_PATH =

705

EXAMPLE_PATH = ../examples

681

706

682

707

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

683

708

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

713

738

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

714

739

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

715

740

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

716

# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER

717

# is applied to all files.

741

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

742

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

718

743

719

744

FILTER_PATTERNS =

720

745

724

749

725

750

FILTER_SOURCE_FILES = NO

726

751

752

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

753

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

754

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

755

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

756

# FILTER_SOURCE_FILES is enabled.

757

758

FILTER_SOURCE_PATTERNS =

759

727

760

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

728

761

# configuration options related to source browsing

729

762

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

777

810

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

778

811

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

779

812

780

VERBATIM_HEADERS = YES

813

VERBATIM_HEADERS = NO

781

814

782

815

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

783

816

# configuration options related to the alphabetical class index

1046

1079

1047

1080

DISABLE_INDEX = NO

1048

1081

1049

# This tag can be used to set the number of enum values (range [1..20])

1050

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

1082

# This tag can be used to set the number of enum values (range [0,1..20])

1083

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

1084

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

1085

# appearing in the overview section.

1051

1086

1052

1087

ENUM_VALUES_PER_LINE = 4

1053

1088

1093

1128

1094

1129

FORMULA_TRANSPARENT = YES

1095

1130

1131

# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax

1132

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

1133

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

1134

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

1135

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

1136

# configure the path to it using the MATHJAX_RELPATH option.

1137

1138

USE_MATHJAX = NO

1139

1140

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

1141

# HTML output directory using the MATHJAX_RELPATH option. The destination

1142

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

1143

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

1144

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

1145

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

1146

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

1147

# before deployment.

1148

1149

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

1150

1096

1151

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

1097

1152

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

1098

1153

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

1108

1163

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

1109

1164

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

1110

1165

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

1111

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

1166

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

1112

1167

# and does not have live searching capabilities.

1113

1168

1114

1169

SERVER_BASED_SEARCH = NO

1149

1204

COMPACT_LATEX = NO

1150

1205

1151

1206

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

1152

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

1207

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

1153

1208

# executive. If left blank a4wide will be used.

1154

1209

1155

1210

PAPER_TYPE = a4wide

1364

1419

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

1365

1420

# way by setting EXPAND_ONLY_PREDEF to YES.

1366

1421

1367

MACRO_EXPANSION = NO

1422

MACRO_EXPANSION = YES

1368

1423

1369

1424

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

1370

1425

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

1371

1426

# PREDEFINED and EXPAND_AS_DEFINED tags.

1372

1427

1373

EXPAND_ONLY_PREDEF = NO

1428

EXPAND_ONLY_PREDEF = YES

1374

1429

1375

1430

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

1376

1431

# in the INCLUDE_PATH (see below) will be search if a #include is found.

1398

1453

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

1399

1454

# instead of the = operator.

1400

1455

1401

PREDEFINED = GEIS_API=""

1456

PREDEFINED = GEIS_API=

1402

1457

1403

1458

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

1404

1459

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

1405

1460

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

1406

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

1461

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

1462

# overrules the definition found in the source code.

1407

1463

1408

1464

EXPAND_AS_DEFINED =

1409

1465

1410

1466

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

1411

# doxygen's preprocessor will remove all function-like macros that are alone

1412

# on a line, have an all uppercase name, and do not end with a semicolon. Such

1413

# function macros are typically used for boiler-plate code, and will confuse

1414

# the parser if not removed.

1467

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

1468

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

1469

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

1415

1470

1416

1471

SKIP_FUNCTION_MACROS = YES

1417

1472

1465

1520

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

1466

1521

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

1467

1522

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

1468

# this option is superseded by the HAVE_DOT option below. This is only a

1469

# fallback. It is recommended to install and use dot, since it yields more

1470

# powerful graphs.

1523

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

1524

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

1471

1525

1472

1526

CLASS_DIAGRAMS = YES

1473

1527

1501

1555

1502

1556

DOT_NUM_THREADS = 0

1503

1557

1504

# By default doxygen will write a font called FreeSans.ttf to the output

1505

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

1506

# font does not include all possible unicode characters however, so when you need

1507

# these (or just want a differently looking font) you can specify the font name

1508

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

1558

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

1559

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

1560

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

1561

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

1509

1562

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

1510

1563

# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory

1511

1564

# containing the font.

1585

1638

CALLER_GRAPH = NO

1586

1639

1587

1640

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

1588

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

1641

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

1589

1642

1590

1643

GRAPHICAL_HIERARCHY = YES

1591

1644

1597

1650

DIRECTORY_GRAPH = YES

1598

1651

1599

1652

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

1600

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

1653

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

1601

1654

# If left blank png will be used.

1602

1655

1603

1656

DOT_IMAGE_FORMAT = png

1613

1666

1614

1667

DOTFILE_DIRS =

1615

1668

1669

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

1670

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

1671

# \mscfile command).

1672

1673

MSCFILE_DIRS =

1674

1616

1675

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

1617

1676

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

1618

1677

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