1

# Doxyfile 1.8.1

     2

     3

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

     4

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

     5

#

     6

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

     7

# The format is:

     8

#       TAG = value [value, ...]

     9

# For lists items can also be appended using:

    10

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

    11

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

    12

    13

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

    14

# Project related configuration options

    15

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

    16

    17

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

    18

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

    19

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

    20

# iconv built into libc) for the transcoding. See

    21

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

    22

    23

DOXYFILE_ENCODING      = UTF-8

    24

    25

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

    26

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

    27

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

    28

    29

PROJECT_NAME           = "IgH EtherCAT Master"

    30

    31

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

    32

# This could be handy for archiving the generated documentation or

    33

# if some version control system is used.

    34

    35

PROJECT_NUMBER         = @VERSION@

    36

    37

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

    38

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

    39

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

    40

    41

PROJECT_BRIEF          =

    42

    43

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

    44

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

    45

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

    46

# Doxygen will copy the logo to the output directory.

    47

    48

PROJECT_LOGO           =

    49

    50

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

    51

# base path where the generated documentation will be put.

    52

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

    53

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

    54

    55

OUTPUT_DIRECTORY       = doxygen-output

    56

    57

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

    58

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

    59

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

    60

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

    61

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

    62

# otherwise cause performance problems for the file system.

    63

    64

CREATE_SUBDIRS         = NO

    65

    66

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

    67

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

    68

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

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

    77

OUTPUT_LANGUAGE        = English

    78

    79

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

    80

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

    81

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

    82

# Set to NO to disable this.

    83

    84

BRIEF_MEMBER_DESC      = YES

    85

    86

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

    87

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

    88

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

    89

# brief descriptions will be completely suppressed.

    90

    91

REPEAT_BRIEF           = YES

    92

    93

# This tag implements a quasi-intelligent brief description abbreviator

    94

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

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

   103

ABBREVIATE_BRIEF       =

   104

   105

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

   106

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

   107

# description.

   108

   109

ALWAYS_DETAILED_SEC    = NO

   110

   111

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

   112

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

   113

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

   114

# operators of the base classes will not be shown.

   115

   116

INLINE_INHERITED_MEMB  = NO

   117

   118

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

   119

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

   120

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

   121

   122

FULL_PATH_NAMES        = NO

   123

   124

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

   125

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

   126

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

   127

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

   128

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

   129

# path to strip.

   130

   131

STRIP_FROM_PATH        =

   132

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

   140

STRIP_FROM_INC_PATH    =

   141

   142

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

   143

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

   144

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

   145

   146

SHORT_NAMES            = NO

   147

   148

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen

   149

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

   150

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

   151

# comments will behave just like regular Qt-style comments

   152

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

   153

   154

JAVADOC_AUTOBRIEF      = YES

   155

   156

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

   157

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

   158

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

   159

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

   160

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

   161

   162

QT_AUTOBRIEF           = NO

   163

   164

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

   165

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

   166

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

   167

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

   168

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

   169

   170

MULTILINE_CPP_IS_BRIEF = YES

   171

   172

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

   173

# member inherits the documentation from any documented member that it

   174

# re-implements.

   175

   176

INHERIT_DOCS           = YES

   177

   178

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

   179

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

   180

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

   181

   182

SEPARATE_MEMBER_PAGES  = NO

   183

   184

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

   185

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

   186

   187

TAB_SIZE               = 4

   188

   189

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

   190

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

   191

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

   192

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

   193

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

   194

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

   195

   196

ALIASES                =

   197

   198

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

   199

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

   200

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

   201

# itcl::class meaning.

   202

   203

TCL_SUBST              =

   204

   205

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

   206

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

   207

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

   208

# of all members will be omitted, etc.

   209

   210

OPTIMIZE_OUTPUT_FOR_C  = YES

   211

   212

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

   213

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

   214

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

   215

# scopes will look different, etc.

   216

   217

OPTIMIZE_OUTPUT_JAVA   = NO

   218

   219

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

   220

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

   221

# Fortran.

   222

   223

OPTIMIZE_FOR_FORTRAN   = NO

   224

   225

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

   226

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

   227

# VHDL.

   228

   229

OPTIMIZE_OUTPUT_VHDL   = NO

   230

   231

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

   232

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

   233

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

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

   241

EXTENSION_MAPPING      =

   242

   243

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

   244

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

   245

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

   246

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

   247

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

   248

# Disable only in case of backward compatibilities issues.

   249

   250

MARKDOWN_SUPPORT       = YES

   251

   252

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

   253

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

   254

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

   255

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

   256

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

   257

# diagrams that involve STL classes more complete and accurate.

   258

   259

BUILTIN_STL_SUPPORT    = NO

   260

   261

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

   262

# enable parsing support.

   263

   264

CPP_CLI_SUPPORT        = NO

   265

   266

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

   267

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

   268

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

   269

   270

SIP_SUPPORT            = NO

   271

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

   279

IDL_PROPERTY_SUPPORT   = YES

   280

   281

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

   282

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

   283

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

   284

# all members of a group must be documented explicitly.

   285

   286

DISTRIBUTE_GROUP_DOC   = NO

   287

   288

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

   289

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

   290

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

   291

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

   292

# the \nosubgrouping command.

   293

   294

SUBGROUPING            = YES

   295

   296

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

   297

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

   298

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

   299

# section (for LaTeX and RTF).

   300

   301

INLINE_GROUPED_CLASSES = NO

   302

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

   310

INLINE_SIMPLE_STRUCTS  = NO

   311

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

   320

TYPEDEF_HIDES_STRUCT   = NO

   321

   322

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

   323

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

   324

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

   325

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

   326

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

   327

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

   328

# causing a significant performance penalty.

   329

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

   330

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

   331

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

   332

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

   333

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

   334

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

   335

   336

SYMBOL_CACHE_SIZE      = 0

   337

   338

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

   339

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

   340

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

   341

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

   342

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

   343

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

   344

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

   345

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

   346

   347

LOOKUP_CACHE_SIZE      = 0

   348

   349

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

   350

# Build related configuration options

   351

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

   352

   353

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

   354

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

   355

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

   356

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

   357

   358

EXTRACT_ALL            = NO

   359

   360

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

   361

# will be included in the documentation.

   362

   363

EXTRACT_PRIVATE        = YES

   364

   365

# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.

   366

   367

EXTRACT_PACKAGE        = NO

   368

   369

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

   370

# will be included in the documentation.

   371

   372

EXTRACT_STATIC         = YES

   373

   374

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

   375

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

   376

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

   377

   378

EXTRACT_LOCAL_CLASSES  = YES

   379

   380

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

   381

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

   382

# the interface are included in the documentation.

   383

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

   384

   385

EXTRACT_LOCAL_METHODS  = YES

   386

   387

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

   388

# extracted and appear in the documentation as a namespace called

   389

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

   390

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

   391

# anonymous namespaces are hidden.

   392

   393

EXTRACT_ANON_NSPACES   = NO

   394

   395

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

   396

# undocumented members of documented classes, files or namespaces.

   397

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

   398

# various overviews, but no documentation section is generated.

   399

# This option has no effect if EXTRACT_ALL is enabled.

   400

   401

HIDE_UNDOC_MEMBERS     = NO

   402

   403

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

   404

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

   405

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

   406

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

   407

   408

HIDE_UNDOC_CLASSES     = NO

   409

   410

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

   411

# friend (class|struct|union) declarations.

   412

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

   413

# documentation.

   414

   415

HIDE_FRIEND_COMPOUNDS  = NO

   416

   417

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

   418

# documentation blocks found inside the body of a function.

   419

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

   420

# function's detailed documentation block.

   421

   422

HIDE_IN_BODY_DOCS      = NO

   423

   424

# The INTERNAL_DOCS tag determines if documentation

   425

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

   426

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

   427

# Set it to YES to include the internal documentation.

   428

   429

INTERNAL_DOCS          = NO

   430

   431

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

   432

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

   433

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

   434

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

   435

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

   436

   437

CASE_SENSE_NAMES       = YES

   438

   439

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

   440

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

   441

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

   442

   443

HIDE_SCOPE_NAMES       = NO

   444

   445

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

   446

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

   447

# of that file.

   448

   449

SHOW_INCLUDE_FILES     = NO

   450

   451

# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen

   452

# will list include files with double quotes in the documentation

   453

# rather than with sharp brackets.

   454

   455

FORCE_LOCAL_INCLUDES   = NO

   456

   457

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

   458

# is inserted in the documentation for inline members.

   459

   460

INLINE_INFO            = YES

   461

   462

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

   463

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

   464

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

   465

# declaration order.

   466

   467

SORT_MEMBER_DOCS       = NO

   468

   469

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

   470

# brief documentation of file, namespace and class members alphabetically

   471

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

   472

# declaration order.

   473

   474

SORT_BRIEF_DOCS        = NO

   475

   476

# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen

   477

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

   478

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

   479

# the constructors will appear in the respective orders defined by

   480

# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.

   481

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

   482

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

   483

   484

SORT_MEMBERS_CTORS_1ST = NO

   485

   486

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

   487

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

   488

# the group names will appear in their defined order.

   489

   490

SORT_GROUP_NAMES       = NO

   491

   492

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

   493

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