doc/doxygen.config.in

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