doxyfile

   1 # Doxyfile 1.5.6
   2
   3 # This file is used to create the doxygen documentation of the source code.
   4 # Run `make doc' to build it.
   5
   6 #---------------------------------------------------------------------------
   7 # Project related configuration options
   8 #---------------------------------------------------------------------------
   9 DOXYFILE_ENCODING      = UTF-8
  10 PROJECT_NAME           = OpenStranded
  11 PROJECT_NUMBER         =
  12 OUTPUT_DIRECTORY       = doc
  13 CREATE_SUBDIRS         = NO
  14 OUTPUT_LANGUAGE        = English
  15 BRIEF_MEMBER_DESC      = YES
  16 REPEAT_BRIEF           = YES
  17 ABBREVIATE_BRIEF       =
  18 ALWAYS_DETAILED_SEC    = NO
  19 INLINE_INHERITED_MEMB  = NO
  20 FULL_PATH_NAMES        = YES
  21 STRIP_FROM_PATH        =
  22 STRIP_FROM_INC_PATH    =
  23 SHORT_NAMES            = NO
  24 JAVADOC_AUTOBRIEF      = YES
  25 QT_AUTOBRIEF           = NO
  26 MULTILINE_CPP_IS_BRIEF = NO
  27 DETAILS_AT_TOP         = NO
  28 INHERIT_DOCS           = YES
  29 SEPARATE_MEMBER_PAGES  = NO
  30 TAB_SIZE               = 8
  31 ALIASES                =
  32 OPTIMIZE_OUTPUT_FOR_C  = NO
  33 OPTIMIZE_OUTPUT_JAVA   = NO
  34 OPTIMIZE_FOR_FORTRAN   = NO
  35 OPTIMIZE_OUTPUT_VHDL   = NO
  36 BUILTIN_STL_SUPPORT    = NO
  37 CPP_CLI_SUPPORT        = NO
  38 SIP_SUPPORT            = NO
  39 IDL_PROPERTY_SUPPORT   = YES
  40 DISTRIBUTE_GROUP_DOC   = NO
  41 SUBGROUPING            = YES
  42 TYPEDEF_HIDES_STRUCT   = NO
  43 #---------------------------------------------------------------------------
  44 # Build related configuration options
  45 #---------------------------------------------------------------------------
  46 EXTRACT_ALL            = NO
  47 EXTRACT_PRIVATE        = NO
  48 EXTRACT_STATIC         = NO
  49 EXTRACT_LOCAL_CLASSES  = YES
  50 EXTRACT_LOCAL_METHODS  = NO
  51 EXTRACT_ANON_NSPACES   = NO
  52 HIDE_UNDOC_MEMBERS     = NO
  53 HIDE_UNDOC_CLASSES     = NO
  54 HIDE_FRIEND_COMPOUNDS  = NO
  55 HIDE_IN_BODY_DOCS      = NO
  56 INTERNAL_DOCS          = NO
  57 CASE_SENSE_NAMES       = YES
  58 HIDE_SCOPE_NAMES       = NO
  59 SHOW_INCLUDE_FILES     = YES
  60 INLINE_INFO            = YES
  61 SORT_MEMBER_DOCS       = YES
  62 SORT_BRIEF_DOCS        = NO
  63 SORT_GROUP_NAMES       = NO
  64 SORT_BY_SCOPE_NAME     = NO
  65 GENERATE_TODOLIST      = YES
  66 GENERATE_TESTLIST      = YES
  67 GENERATE_BUGLIST       = YES
  68 GENERATE_DEPRECATEDLIST= YES
  69 ENABLED_SECTIONS       =
  70 MAX_INITIALIZER_LINES  = 30
  71 SHOW_USED_FILES        = YES
  72 SHOW_DIRECTORIES       = NO
  73 SHOW_FILES             = YES
  74 SHOW_NAMESPACES        = YES
  75 FILE_VERSION_FILTER    =
  76 #---------------------------------------------------------------------------
  77 # configuration options related to warning and progress messages
  78 #---------------------------------------------------------------------------
  79 QUIET                  = NO
  80 WARNINGS               = YES
  81 WARN_IF_UNDOCUMENTED   = YES
  82 WARN_IF_DOC_ERROR      = YES
  83 WARN_NO_PARAMDOC       = NO
  84 WARN_FORMAT            = "$file:$line: $text"
  85 WARN_LOGFILE           =
  86 #---------------------------------------------------------------------------
  87 # configuration options related to the input files
  88 #---------------------------------------------------------------------------
  89 INPUT                  = "src"
  90 INPUT_ENCODING         = UTF-8
  91 FILE_PATTERNS          = *.cc \
  92                          *.hh \
  93                          *.c  \
  94                          *.h
  95 RECURSIVE              = NO
  96 EXCLUDE                =
  97 EXCLUDE_SYMLINKS       = NO
  98 EXCLUDE_PATTERNS       =
  99 EXCLUDE_SYMBOLS        =
 100 EXAMPLE_PATH           =
 101 EXAMPLE_PATTERNS       =
 102 EXAMPLE_RECURSIVE      = NO
 103 IMAGE_PATH             =
 104 INPUT_FILTER           =
 105 FILTER_PATTERNS        =
 106 FILTER_SOURCE_FILES    = NO
 107 #---------------------------------------------------------------------------
 108 # configuration options related to source browsing
 109 #---------------------------------------------------------------------------
 110 SOURCE_BROWSER         = NO
 111 INLINE_SOURCES         = NO
 112 STRIP_CODE_COMMENTS    = YES
 113 REFERENCED_BY_RELATION = NO
 114 REFERENCES_RELATION    = NO
 115 REFERENCES_LINK_SOURCE = YES
 116 USE_HTAGS              = NO
 117 VERBATIM_HEADERS       = YES
 118 #---------------------------------------------------------------------------
 119 # configuration options related to the alphabetical class index
 120 #---------------------------------------------------------------------------
 121 ALPHABETICAL_INDEX     = NO
 122 COLS_IN_ALPHA_INDEX    = 5
 123 IGNORE_PREFIX          =
 124 #---------------------------------------------------------------------------
 125 # configuration options related to the HTML output
 126 #---------------------------------------------------------------------------
 127 GENERATE_HTML          = YES
 128 HTML_OUTPUT            = doxygen
 129 HTML_FILE_EXTENSION    = .html
 130 HTML_HEADER            =
 131 HTML_FOOTER            =
 132 HTML_STYLESHEET        =
 133 HTML_ALIGN_MEMBERS     = YES
 134 GENERATE_HTMLHELP      = NO
 135 GENERATE_DOCSET        = NO
 136 DOCSET_FEEDNAME        = "Doxygen generated docs"
 137 DOCSET_BUNDLE_ID       = org.doxygen.Project
 138 HTML_DYNAMIC_SECTIONS  = NO
 139 CHM_FILE               =
 140 HHC_LOCATION           =
 141 GENERATE_CHI           = NO
 142 CHM_INDEX_ENCODING     =
 143 BINARY_TOC             = NO
 144 TOC_EXPAND             = NO
 145 DISABLE_INDEX          = NO
 146 ENUM_VALUES_PER_LINE   = 4
 147 GENERATE_TREEVIEW      = NONE
 148 TREEVIEW_WIDTH         = 250
 149 FORMULA_FONTSIZE       = 10
 150 #---------------------------------------------------------------------------
 151 # configuration options related to the LaTeX output
 152 #---------------------------------------------------------------------------
 153 GENERATE_LATEX         = NO
 154 LATEX_OUTPUT           = latex
 155 LATEX_CMD_NAME         = latex
 156 MAKEINDEX_CMD_NAME     = makeindex
 157 COMPACT_LATEX          = NO
 158 PAPER_TYPE             = a4wide
 159 EXTRA_PACKAGES         =
 160 LATEX_HEADER           =
 161 PDF_HYPERLINKS         = YES
 162 USE_PDFLATEX           = YES
 163 LATEX_BATCHMODE        = NO
 164 LATEX_HIDE_INDICES     = NO
 165 #---------------------------------------------------------------------------
 166 # configuration options related to the RTF output
 167 #---------------------------------------------------------------------------
 168 GENERATE_RTF           = NO
 169 RTF_OUTPUT             = rtf
 170 COMPACT_RTF            = NO
 171 RTF_HYPERLINKS         = NO
 172 RTF_STYLESHEET_FILE    =
 173 RTF_EXTENSIONS_FILE    =
 174 #---------------------------------------------------------------------------
 175 # configuration options related to the man page output
 176 #---------------------------------------------------------------------------
 177 GENERATE_MAN           = NO
 178 MAN_OUTPUT             = man
 179 MAN_EXTENSION          = .3
 180 MAN_LINKS              = NO
 181 #---------------------------------------------------------------------------
 182 # configuration options related to the XML output
 183 #---------------------------------------------------------------------------
 184 GENERATE_XML           = NO
 185 XML_OUTPUT             = xml
 186 XML_SCHEMA             =
 187 XML_DTD                =
 188 XML_PROGRAMLISTING     = YES
 189 #---------------------------------------------------------------------------
 190 # configuration options for the AutoGen Definitions output
 191 #---------------------------------------------------------------------------
 192 GENERATE_AUTOGEN_DEF   = NO
 193 #---------------------------------------------------------------------------
 194 # configuration options related to the Perl module output
 195 #---------------------------------------------------------------------------
 196 GENERATE_PERLMOD       = NO
 197 PERLMOD_LATEX          = NO
 198 PERLMOD_PRETTY         = YES
 199 PERLMOD_MAKEVAR_PREFIX =
 200 #---------------------------------------------------------------------------
 201 # Configuration options related to the preprocessor
 202 #---------------------------------------------------------------------------
 203 ENABLE_PREPROCESSING   = YES
 204 MACRO_EXPANSION        = NO
 205 EXPAND_ONLY_PREDEF     = NO
 206 SEARCH_INCLUDES        = YES
 207 INCLUDE_PATH           =
 208 INCLUDE_FILE_PATTERNS  =
 209 PREDEFINED             =
 210 EXPAND_AS_DEFINED      =
 211 SKIP_FUNCTION_MACROS   = YES
 212 #---------------------------------------------------------------------------
 213 # Configuration::additions related to external references
 214 #---------------------------------------------------------------------------
 215 TAGFILES               =
 216 GENERATE_TAGFILE       =
 217 ALLEXTERNALS           = NO
 218 EXTERNAL_GROUPS        = YES
 219 PERL_PATH              = /usr/bin/perl
 220 #---------------------------------------------------------------------------
 221 # Configuration options related to the dot tool
 222 #---------------------------------------------------------------------------
 223 CLASS_DIAGRAMS         = YES
 224 MSCGEN_PATH            =
 225 HIDE_UNDOC_RELATIONS   = YES
 226 HAVE_DOT               = NO
 227 DOT_FONTNAME           = FreeSans
 228 DOT_FONTPATH           =
 229 CLASS_GRAPH            = YES
 230 COLLABORATION_GRAPH    = YES
 231 GROUP_GRAPHS           = YES
 232 UML_LOOK               = NO
 233 TEMPLATE_RELATIONS     = NO
 234 INCLUDE_GRAPH          = YES
 235 INCLUDED_BY_GRAPH      = YES
 236 CALL_GRAPH             = NO
 237 CALLER_GRAPH           = NO
 238 GRAPHICAL_HIERARCHY    = YES
 239 DIRECTORY_GRAPH        = YES
 240 DOT_IMAGE_FORMAT       = png
 241 DOT_PATH               =
 242 DOTFILE_DIRS           =
 243 DOT_GRAPH_MAX_NODES    = 50
 244 MAX_DOT_GRAPH_DEPTH    = 0
 245 DOT_TRANSPARENT        = YES
 246 DOT_MULTI_TARGETS      = NO
 247 GENERATE_LEGEND        = YES
 248 DOT_CLEANUP            = YES
 249 #---------------------------------------------------------------------------
 250 # Configuration::additions related to the search engine
 251 #---------------------------------------------------------------------------
 252 SEARCHENGINE           = NO