Source/charon/documentation.DoxyFile

   1 # Doxyfile 1.4.2
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6
   7 PROJECT_NAME = IKEv2 for Linux strongSwan
   8
   9 PROJECT_NUMBER = 1.0
  10
  11 OUTPUT_DIRECTORY = /tmp/doc
  12
  13 CREATE_SUBDIRS = NO
  14
  15 OUTPUT_LANGUAGE = English
  16
  17 USE_WINDOWS_ENCODING = NO
  18
  19 BRIEF_MEMBER_DESC = YES
  20
  21 REPEAT_BRIEF = YES
  22
  23 ABBREVIATE_BRIEF =
  24
  25 ALWAYS_DETAILED_SEC = NO
  26
  27 INLINE_INHERITED_MEMB = NO
  28
  29 FULL_PATH_NAMES = YES
  30
  31 STRIP_FROM_PATH =
  32
  33 STRIP_FROM_INC_PATH =
  34
  35 SHORT_NAMES = NO
  36
  37 JAVADOC_AUTOBRIEF = YES
  38
  39 MULTILINE_CPP_IS_BRIEF = NO
  40
  41 DETAILS_AT_TOP = NO
  42
  43 INHERIT_DOCS = YES
  44
  45 DISTRIBUTE_GROUP_DOC = NO
  46
  47 SEPARATE_MEMBER_PAGES = NO
  48
  49 TAB_SIZE = 8
  50
  51 ALIASES =
  52
  53 OPTIMIZE_OUTPUT_FOR_C = YES
  54
  55 OPTIMIZE_OUTPUT_JAVA = NO
  56
  57 SUBGROUPING = YES
  58
  59 #---------------------------------------------------------------------------
  60 # Build related configuration options
  61 #---------------------------------------------------------------------------
  62
  63 EXTRACT_ALL = YES
  64
  65 EXTRACT_PRIVATE = YES
  66
  67 EXTRACT_STATIC = YES
  68
  69 EXTRACT_LOCAL_CLASSES = YES
  70
  71 EXTRACT_LOCAL_METHODS = YES
  72
  73 HIDE_UNDOC_MEMBERS = YES
  74
  75 HIDE_UNDOC_CLASSES = YES
  76
  77 HIDE_FRIEND_COMPOUNDS = NO
  78
  79 HIDE_IN_BODY_DOCS = NO
  80
  81 INTERNAL_DOCS = NO
  82
  83 CASE_SENSE_NAMES = YES
  84
  85 HIDE_SCOPE_NAMES = NO
  86
  87 SHOW_INCLUDE_FILES = YES
  88
  89 INLINE_INFO = YES
  90
  91 SORT_MEMBER_DOCS = YES
  92
  93 SORT_BRIEF_DOCS = NO
  94
  95 SORT_BY_SCOPE_NAME = NO
  96
  97 GENERATE_TODOLIST = NO
  98
  99 GENERATE_TESTLIST = NO
 100
 101 GENERATE_BUGLIST = YES
 102
 103 GENERATE_DEPRECATEDLIST = YES
 104
 105 ENABLED_SECTIONS =
 106
 107 MAX_INITIALIZER_LINES = 30
 108
 109 SHOW_USED_FILES = YES
 110
 111 SHOW_DIRECTORIES = YES
 112
 113 FILE_VERSION_FILTER =
 114
 115 #---------------------------------------------------------------------------
 116 # configuration options related to warning and progress messages
 117 #---------------------------------------------------------------------------
 118
 119 QUIET = NO
 120
 121 WARNINGS = YES
 122
 123 WARN_IF_UNDOCUMENTED = YES
 124
 125 WARN_IF_DOC_ERROR = YES
 126
 127 WARN_NO_PARAMDOC = NO
 128
 129 WARN_FORMAT = "$file:$line: $text"
 130
 131 WARN_LOGFILE =
 132
 133 #---------------------------------------------------------------------------
 134 # configuration options related to the input files
 135 #---------------------------------------------------------------------------
 136
 137 INPUT = ./
 138
 139 FILE_PATTERNS = *.c *.h
 140
 141 RECURSIVE = YES
 142
 143 EXCLUDE = testcases
 144
 145 EXCLUDE_SYMLINKS = NO
 146
 147 EXCLUDE_PATTERNS =
 148
 149 EXAMPLE_PATH =
 150
 151 EXAMPLE_PATTERNS =
 152
 153 EXAMPLE_RECURSIVE = NO
 154
 155 IMAGE_PATH =
 156
 157 INPUT_FILTER =
 158
 159 FILTER_PATTERNS =
 160
 161 FILTER_SOURCE_FILES = NO
 162
 163 #---------------------------------------------------------------------------
 164 # configuration options related to source browsing
 165 #---------------------------------------------------------------------------
 166
 167 SOURCE_BROWSER = NO
 168
 169 INLINE_SOURCES = NO
 170
 171 STRIP_CODE_COMMENTS = YES
 172
 173 REFERENCED_BY_RELATION = NO
 174
 175 REFERENCES_RELATION = NO
 176
 177 VERBATIM_HEADERS = NO
 178
 179 #---------------------------------------------------------------------------
 180 # configuration options related to the alphabetical class index
 181 #---------------------------------------------------------------------------
 182
 183 ALPHABETICAL_INDEX = NO
 184
 185 COLS_IN_ALPHA_INDEX = 5
 186
 187 IGNORE_PREFIX =
 188
 189 #---------------------------------------------------------------------------
 190 # configuration options related to the HTML output
 191 #---------------------------------------------------------------------------
 192
 193 GENERATE_HTML = YES
 194
 195 HTML_OUTPUT = html
 196
 197 HTML_FILE_EXTENSION = .html
 198
 199 HTML_HEADER =
 200
 201 HTML_FOOTER =
 202
 203 HTML_STYLESHEET =
 204
 205 HTML_ALIGN_MEMBERS = YES
 206
 207 GENERATE_HTMLHELP = NO
 208
 209 CHM_FILE =
 210
 211 HHC_LOCATION =
 212
 213 GENERATE_CHI = NO
 214
 215 BINARY_TOC = NO
 216
 217 TOC_EXPAND = NO
 218
 219 DISABLE_INDEX = NO
 220
 221 ENUM_VALUES_PER_LINE = 4
 222
 223 GENERATE_TREEVIEW = YES
 224
 225 TREEVIEW_WIDTH = 250
 226
 227 #---------------------------------------------------------------------------
 228 # configuration options related to the LaTeX output
 229 #---------------------------------------------------------------------------
 230
 231 GENERATE_LATEX = NO
 232
 233 LATEX_OUTPUT = latex
 234
 235 LATEX_CMD_NAME = latex
 236
 237 MAKEINDEX_CMD_NAME = makeindex
 238
 239 COMPACT_LATEX = NO
 240
 241 PAPER_TYPE = a4wide
 242
 243 EXTRA_PACKAGES =
 244
 245 LATEX_HEADER =
 246
 247 PDF_HYPERLINKS = NO
 248
 249 USE_PDFLATEX = NO
 250
 251 LATEX_BATCHMODE = NO
 252
 253 LATEX_HIDE_INDICES = NO
 254
 255 #---------------------------------------------------------------------------
 256 # configuration options related to the RTF output
 257 #---------------------------------------------------------------------------
 258
 259 GENERATE_RTF = NO
 260
 261 RTF_OUTPUT = rtf
 262
 263 COMPACT_RTF = NO
 264
 265 RTF_HYPERLINKS = NO
 266
 267 RTF_STYLESHEET_FILE =
 268
 269 RTF_EXTENSIONS_FILE =
 270
 271 #---------------------------------------------------------------------------
 272 # configuration options related to the man page output
 273 #---------------------------------------------------------------------------
 274
 275 GENERATE_MAN = YES
 276
 277 MAN_OUTPUT = man
 278
 279 MAN_EXTENSION = .3
 280
 281 MAN_LINKS = YES
 282
 283 #---------------------------------------------------------------------------
 284 # configuration options related to the XML output
 285 #---------------------------------------------------------------------------
 286
 287 GENERATE_XML = NO
 288
 289 XML_OUTPUT = xml
 290
 291 XML_SCHEMA =
 292
 293 XML_DTD =
 294
 295 XML_PROGRAMLISTING = YES
 296
 297 #---------------------------------------------------------------------------
 298 # configuration options for the AutoGen Definitions output
 299 #---------------------------------------------------------------------------
 300
 301 GENERATE_AUTOGEN_DEF = NO
 302
 303 #---------------------------------------------------------------------------
 304 # configuration options related to the Perl module output
 305 #---------------------------------------------------------------------------
 306
 307 GENERATE_PERLMOD = NO
 308
 309 PERLMOD_LATEX = NO
 310
 311 PERLMOD_PRETTY = YES
 312
 313 PERLMOD_MAKEVAR_PREFIX =
 314
 315 #---------------------------------------------------------------------------
 316 # Configuration options related to the preprocessor
 317 #---------------------------------------------------------------------------
 318
 319 ENABLE_PREPROCESSING = YES
 320
 321 MACRO_EXPANSION = NO
 322
 323 EXPAND_ONLY_PREDEF = NO
 324
 325 SEARCH_INCLUDES = YES
 326
 327 INCLUDE_PATH =
 328
 329 INCLUDE_FILE_PATTERNS =
 330
 331 PREDEFINED = LEAK_DETECTIVE
 332
 333 EXPAND_AS_DEFINED =
 334
 335 SKIP_FUNCTION_MACROS = YES
 336
 337 #---------------------------------------------------------------------------
 338 # Configuration::additions related to external references
 339 #---------------------------------------------------------------------------
 340
 341 TAGFILES =
 342
 343 GENERATE_TAGFILE =
 344
 345 ALLEXTERNALS = NO
 346
 347 EXTERNAL_GROUPS = YES
 348
 349 PERL_PATH = /usr/bin/perl
 350
 351 #---------------------------------------------------------------------------
 352 # Configuration options related to the dot tool
 353 #---------------------------------------------------------------------------
 354
 355 CLASS_DIAGRAMS = YES
 356
 357 HIDE_UNDOC_RELATIONS = YES
 358
 359 HAVE_DOT = NO
 360
 361 CLASS_GRAPH = YES
 362
 363 COLLABORATION_GRAPH = YES
 364
 365 GROUP_GRAPHS = YES
 366
 367 UML_LOOK = NO
 368
 369 TEMPLATE_RELATIONS = NO
 370
 371 INCLUDE_GRAPH = YES
 372
 373 INCLUDED_BY_GRAPH = YES
 374
 375 CALL_GRAPH = NO
 376
 377 GRAPHICAL_HIERARCHY = YES
 378
 379 DIRECTORY_GRAPH = YES
 380
 381 DOT_IMAGE_FORMAT = png
 382
 383 DOT_PATH =
 384
 385 DOTFILE_DIRS =
 386
 387 MAX_DOT_GRAPH_WIDTH = 1024
 388
 389 MAX_DOT_GRAPH_HEIGHT = 1024
 390
 391 MAX_DOT_GRAPH_DEPTH = 0
 392
 393 DOT_TRANSPARENT = NO
 394
 395 DOT_MULTI_TARGETS = NO
 396
 397 GENERATE_LEGEND = YES
 398
 399 DOT_CLEANUP = YES
 400
 401 #---------------------------------------------------------------------------
 402 # Configuration::additions related to the search engine
 403 #---------------------------------------------------------------------------
 404
 405 SEARCHENGINE = NO
 406