Doxyfile

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