doclib/Doxyfile.global

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