libs/CppAddons/Doxyfile

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