Doxyfile

   1 PROJECT_NAME           = Overview
   2 PROJECT_NUMBER         = "Version 0.0.1"
   3
   4 OUTPUT_DIRECTORY       = doc
   5 CREATE_SUBDIRS         = NO
   6 OUTPUT_LANGUAGE        = English
   7 USE_WINDOWS_ENCODING   = NO
   8 BRIEF_MEMBER_DESC      = YES
   9 REPEAT_BRIEF           = NO
  10 ABBREVIATE_BRIEF       =
  11 ALWAYS_DETAILED_SEC    = NO
  12 INLINE_INHERITED_MEMB  = NO
  13 FULL_PATH_NAMES        = NO
  14 STRIP_FROM_PATH        =
  15 STRIP_FROM_INC_PATH    =
  16 SHORT_NAMES            = NO
  17 JAVADOC_AUTOBRIEF      = NO
  18 MULTILINE_CPP_IS_BRIEF = NO
  19 DETAILS_AT_TOP         = YES
  20 INHERIT_DOCS           = YES
  21 DISTRIBUTE_GROUP_DOC   = NO
  22 SEPARATE_MEMBER_PAGES  = NO
  23 TAB_SIZE               = 8
  24 ALIASES                =
  25 OPTIMIZE_OUTPUT_FOR_C  = NO
  26 OPTIMIZE_OUTPUT_JAVA   = NO
  27 SUBGROUPING            = YES
  28 BUILTIN_STL_SUPPORT    = YES
  29
  30 EXTRACT_ALL            = NO
  31 EXTRACT_PRIVATE        = NO
  32 EXTRACT_STATIC         = NO
  33 EXTRACT_LOCAL_CLASSES  = NO
  34 EXTRACT_LOCAL_METHODS  = NO
  35 HIDE_UNDOC_MEMBERS     = NO
  36 HIDE_UNDOC_CLASSES     = NO
  37 HIDE_FRIEND_COMPOUNDS  = NO
  38 HIDE_IN_BODY_DOCS      = NO
  39 INTERNAL_DOCS          = NO
  40 CASE_SENSE_NAMES       = YES
  41 HIDE_SCOPE_NAMES       = NO
  42 SHOW_INCLUDE_FILES     = NO
  43 INLINE_INFO            = NO
  44 SORT_MEMBER_DOCS       = YES
  45 SORT_BRIEF_DOCS        = NO
  46 SORT_BY_SCOPE_NAME     = YES
  47 GENERATE_TODOLIST      = YES
  48 GENERATE_TESTLIST      = YES
  49 GENERATE_BUGLIST       = YES
  50 GENERATE_DEPRECATEDLIST= YES
  51 ENABLED_SECTIONS       =
  52 MAX_INITIALIZER_LINES  = 30
  53 SHOW_USED_FILES        = NO
  54 SHOW_DIRECTORIES       = NO
  55 FILE_VERSION_FILTER    =
  56 #---------------------------------------------------------------------------
  57 # configuration options related to warning and progress messages
  58 #---------------------------------------------------------------------------
  59 QUIET                  = NO
  60 WARNINGS               = YES
  61 WARN_IF_UNDOCUMENTED   = NO
  62 WARN_IF_DOC_ERROR      = YES
  63 WARN_NO_PARAMDOC       = NO
  64 WARN_FORMAT            = "$file:$line: $text"
  65 WARN_LOGFILE           =
  66 #---------------------------------------------------------------------------
  67 # configuration options related to the input files
  68 #---------------------------------------------------------------------------
  69 INPUT                  = .
  70 FILE_PATTERNS          = *.dox
  71 RECURSIVE              = NO
  72 EXCLUDE                = doc
  73 EXCLUDE_SYMLINKS       = NO
  74 EXCLUDE_PATTERNS       =
  75 EXAMPLE_PATH           =
  76 EXAMPLE_PATTERNS       =
  77 EXAMPLE_RECURSIVE      = NO
  78 IMAGE_PATH             =
  79 INPUT_FILTER           =
  80 FILTER_PATTERNS        =
  81 FILTER_SOURCE_FILES    = NO
  82 #---------------------------------------------------------------------------
  83 # configuration options related to source browsing
  84 #---------------------------------------------------------------------------
  85 SOURCE_BROWSER         = NO
  86 INLINE_SOURCES         = NO
  87 STRIP_CODE_COMMENTS    = YES
  88 REFERENCED_BY_RELATION = NO
  89 REFERENCES_RELATION    = NO
  90 VERBATIM_HEADERS       = NO
  91 #---------------------------------------------------------------------------
  92 # configuration options related to the alphabetical class index
  93 #---------------------------------------------------------------------------
  94 ALPHABETICAL_INDEX     = NO
  95 COLS_IN_ALPHA_INDEX    = 5
  96 IGNORE_PREFIX          =
  97 #---------------------------------------------------------------------------
  98 # configuration options related to the HTML output
  99 #---------------------------------------------------------------------------
 100 GENERATE_HTML          = YES
 101 HTML_OUTPUT            = html
 102 HTML_FILE_EXTENSION    = .html
 103 HTML_HEADER            = doclib/doxy-header-overview.html
 104 HTML_FOOTER            = doclib/doxy-footer.html
 105 HTML_STYLESHEET        =
 106 HTML_ALIGN_MEMBERS     = YES
 107 GENERATE_HTMLHELP      = NO
 108 CHM_FILE               =
 109 HHC_LOCATION           =
 110 GENERATE_CHI           = NO
 111 BINARY_TOC             = NO
 112 TOC_EXPAND             = NO
 113 DISABLE_INDEX          = NO
 114 ENUM_VALUES_PER_LINE   = 4
 115 GENERATE_TREEVIEW      = NO
 116 TREEVIEW_WIDTH         = 250
 117 #---------------------------------------------------------------------------
 118 # configuration options related to the LaTeX output
 119 #---------------------------------------------------------------------------
 120 GENERATE_LATEX         = NO
 121 LATEX_OUTPUT           = latex
 122 LATEX_CMD_NAME         = latex
 123 MAKEINDEX_CMD_NAME     = makeindex
 124 COMPACT_LATEX          = NO
 125 PAPER_TYPE             = a4wide
 126 EXTRA_PACKAGES         =
 127 LATEX_HEADER           =
 128 PDF_HYPERLINKS         = NO
 129 USE_PDFLATEX           = NO
 130 LATEX_BATCHMODE        = NO
 131 LATEX_HIDE_INDICES     = NO
 132 #---------------------------------------------------------------------------
 133 # configuration options related to the RTF output
 134 #---------------------------------------------------------------------------
 135 GENERATE_RTF           = NO
 136 RTF_OUTPUT             = rtf
 137 COMPACT_RTF            = NO
 138 RTF_HYPERLINKS         = NO
 139 RTF_STYLESHEET_FILE    =
 140 RTF_EXTENSIONS_FILE    =
 141 #---------------------------------------------------------------------------
 142 # configuration options related to the man page output
 143 #---------------------------------------------------------------------------
 144 GENERATE_MAN           = NO
 145 MAN_OUTPUT             = man
 146 MAN_EXTENSION          = .3
 147 MAN_LINKS              = NO
 148 #---------------------------------------------------------------------------
 149 # configuration options related to the XML output
 150 #---------------------------------------------------------------------------
 151 GENERATE_XML           = NO
 152 XML_OUTPUT             = xml
 153 XML_SCHEMA             =
 154 XML_DTD                =
 155 XML_PROGRAMLISTING     = YES
 156 #---------------------------------------------------------------------------
 157 # configuration options for the AutoGen Definitions output
 158 #---------------------------------------------------------------------------
 159 GENERATE_AUTOGEN_DEF   = NO
 160 #---------------------------------------------------------------------------
 161 # configuration options related to the Perl module output
 162 #---------------------------------------------------------------------------
 163 GENERATE_PERLMOD       = NO
 164 PERLMOD_LATEX          = NO
 165 PERLMOD_PRETTY         = YES
 166 PERLMOD_MAKEVAR_PREFIX =
 167 #---------------------------------------------------------------------------
 168 # Configuration options related to the preprocessor
 169 #---------------------------------------------------------------------------
 170 ENABLE_PREPROCESSING   = NO
 171 MACRO_EXPANSION        = YES
 172 EXPAND_ONLY_PREDEF     = YES
 173 SEARCH_INCLUDES        = YES
 174 INCLUDE_PATH           = libs
 175 INCLUDE_FILE_PATTERNS  =
 176 PREDEFINED             = DOXYGEN
 177 EXPAND_AS_DEFINED      = DefineCommand
 178 SKIP_FUNCTION_MACROS   = YES
 179 #---------------------------------------------------------------------------
 180 # Configuration::additions related to external references
 181 #---------------------------------------------------------------------------
 182 TAGFILES               =
 183 GENERATE_TAGFILE       =
 184 ALLEXTERNALS           = NO
 185 EXTERNAL_GROUPS        = YES
 186 PERL_PATH              = /usr/bin/perl
 187 #---------------------------------------------------------------------------
 188 # Configuration options related to the dot tool
 189 #---------------------------------------------------------------------------
 190 CLASS_DIAGRAMS         = NO
 191 HIDE_UNDOC_RELATIONS   = NO
 192 HAVE_DOT               = NO
 193 CLASS_GRAPH            = NO
 194 COLLABORATION_GRAPH    = NO
 195 GROUP_GRAPHS           = NO
 196 UML_LOOK               = NO
 197 TEMPLATE_RELATIONS     = NO
 198 INCLUDE_GRAPH          = NO
 199 INCLUDED_BY_GRAPH      = NO
 200 CALL_GRAPH             = NO
 201 GRAPHICAL_HIERARCHY    = NO
 202 DIRECTORY_GRAPH        = NO
 203 DOT_IMAGE_FORMAT       = png
 204 DOT_PATH               =
 205 DOTFILE_DIRS           =
 206 MAX_DOT_GRAPH_WIDTH    = 800
 207 MAX_DOT_GRAPH_HEIGHT   = 1200
 208 MAX_DOT_GRAPH_DEPTH    = 1000
 209 DOT_TRANSPARENT        = NO
 210 DOT_MULTI_TARGETS      = YES
 211 GENERATE_LEGEND        = NO
 212 DOT_CLEANUP            = NO
 213 #---------------------------------------------------------------------------
 214 # Configuration::additions related to the search engine
 215 #---------------------------------------------------------------------------
 216 SEARCHENGINE           = NO