doc/doxygen/gnunet.doxy

   1 # Doxyfile 1.5.6
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = GNUnet
   8 PROJECT_NUMBER         = 0.10.x
   9 PROJECT_LOGO           = logo.png
  10 OUTPUT_DIRECTORY       = .
  11 CREATE_SUBDIRS         = YES
  12 OUTPUT_LANGUAGE        = English
  13 BRIEF_MEMBER_DESC      = YES
  14 REPEAT_BRIEF           = YES
  15 ABBREVIATE_BRIEF       = "The $name class" \
  16                          "The $name widget" \
  17                          "The $name file" \
  18                          is \
  19                          provides \
  20                          specifies \
  21                          contains \
  22                          represents \
  23                          a \
  24                          an \
  25                          the
  26 ALWAYS_DETAILED_SEC    = NO
  27 INLINE_INHERITED_MEMB  = NO
  28 FULL_PATH_NAMES        = YES
  29 STRIP_FROM_PATH        = ../..
  30 STRIP_FROM_INC_PATH    = ../../src/include \
  31                          src/include \
  32                          include
  33 SHORT_NAMES            = NO
  34 JAVADOC_AUTOBRIEF      = YES
  35 QT_AUTOBRIEF           = NO
  36 MULTILINE_CPP_IS_BRIEF = NO
  37 INHERIT_DOCS           = YES
  38 SEPARATE_MEMBER_PAGES  = NO
  39 TAB_SIZE               = 8
  40 ALIASES                =
  41 OPTIMIZE_OUTPUT_FOR_C  = YES
  42 OPTIMIZE_OUTPUT_JAVA   = NO
  43 OPTIMIZE_FOR_FORTRAN   = NO
  44 OPTIMIZE_OUTPUT_VHDL   = NO
  45 BUILTIN_STL_SUPPORT    = NO
  46 CPP_CLI_SUPPORT        = NO
  47 SIP_SUPPORT            = NO
  48 IDL_PROPERTY_SUPPORT   = YES
  49 DISTRIBUTE_GROUP_DOC   = NO
  50 SUBGROUPING            = YES
  51 TYPEDEF_HIDES_STRUCT   = NO
  52 #---------------------------------------------------------------------------
  53 # Build related configuration options
  54 #---------------------------------------------------------------------------
  55 EXTRACT_ALL            = YES
  56 EXTRACT_PRIVATE        = YES
  57 EXTRACT_STATIC         = YES
  58 EXTRACT_LOCAL_CLASSES  = YES
  59 EXTRACT_LOCAL_METHODS  = YES
  60 EXTRACT_ANON_NSPACES   = YES
  61 HIDE_UNDOC_MEMBERS     = NO
  62 HIDE_UNDOC_CLASSES     = NO
  63 HIDE_FRIEND_COMPOUNDS  = NO
  64 HIDE_IN_BODY_DOCS      = NO
  65 INTERNAL_DOCS          = YES
  66 CASE_SENSE_NAMES       = YES
  67 HIDE_SCOPE_NAMES       = NO
  68 SHOW_INCLUDE_FILES     = YES
  69 INLINE_INFO            = YES
  70 SORT_MEMBER_DOCS       = NO
  71 SORT_BRIEF_DOCS        = NO
  72 SORT_GROUP_NAMES       = YES
  73 SORT_BY_SCOPE_NAME     = NO
  74 GENERATE_TODOLIST      = YES
  75 GENERATE_TESTLIST      = YES
  76 GENERATE_BUGLIST       = YES
  77 GENERATE_DEPRECATEDLIST= YES
  78 ENABLED_SECTIONS       =
  79 MAX_INITIALIZER_LINES  = 30
  80 SHOW_USED_FILES        = YES
  81 SHOW_FILES             = YES
  82 SHOW_NAMESPACES        = YES
  83 FILE_VERSION_FILTER    =
  84 #---------------------------------------------------------------------------
  85 # configuration options related to warning and progress messages
  86 #---------------------------------------------------------------------------
  87 QUIET                  = YES
  88 WARNINGS               = YES
  89 WARN_IF_UNDOCUMENTED   = YES
  90 WARN_IF_DOC_ERROR      = YES
  91 WARN_NO_PARAMDOC       = YES
  92 WARN_FORMAT            = "$file:$line: $text"
  93 WARN_LOGFILE           =
  94 #---------------------------------------------------------------------------
  95 # configuration options related to the input files
  96 #---------------------------------------------------------------------------
  97 INPUT                  = ../../src ../../contrib ../../doc
  98 INPUT_ENCODING         = UTF-8
  99 FILE_PATTERNS          = *.c \
 100                          *.cc \
 101                          *.cxx \
 102                          *.cpp \
 103                          *.c++ \
 104                          *.d \
 105                          *.java \
 106                          *.ii \
 107                          *.ixx \
 108                          *.ipp \
 109                          *.i++ \
 110                          *.inl \
 111                          *.h \
 112                          *.hh \
 113                          *.hxx \
 114                          *.hpp \
 115                          *.h++ \
 116                          *.idl \
 117                          *.odl \
 118                          *.cs \
 119                          *.php \
 120                          *.php3 \
 121                          *.inc \
 122                          *.m \
 123                          *.mm \
 124                          *.dox \
 125                          *.py \
 126                          *.f90 \
 127                          *.f \
 128                          *.vhd \
 129                          *.vhdl \
 130                          *.C \
 131                          *.CC \
 132                          *.C++ \
 133                          *.II \
 134                          *.I++ \
 135                          *.H \
 136                          *.HH \
 137                          *.H++ \
 138                          *.CS \
 139                          *.PHP \
 140                          *.PHP3 \
 141                          *.M \
 142                          *.MM \
 143                          *.PY \
 144                          *.F90 \
 145                          *.F \
 146                          *.VHD \
 147                          *.VHDL
 148 RECURSIVE              = YES
 149 EXCLUDE                =
 150 EXCLUDE_SYMLINKS       = NO
 151 EXCLUDE_PATTERNS       = */test_* */.svn/* */.git/* */perf_* .*
 152 EXCLUDE_SYMBOLS        =
 153 EXAMPLE_PATH           =
 154 EXAMPLE_PATTERNS       = *
 155 EXAMPLE_RECURSIVE      = NO
 156 IMAGE_PATH             =
 157 INPUT_FILTER           =
 158 FILTER_PATTERNS        =
 159 FILTER_SOURCE_FILES    = NO
 160 #---------------------------------------------------------------------------
 161 # configuration options related to source browsing
 162 #---------------------------------------------------------------------------
 163 SOURCE_BROWSER         = YES
 164 INLINE_SOURCES         = YES
 165 STRIP_CODE_COMMENTS    = YES
 166 REFERENCED_BY_RELATION = YES
 167 REFERENCES_RELATION    = YES
 168 REFERENCES_LINK_SOURCE = YES
 169 USE_HTAGS              = NO
 170 VERBATIM_HEADERS       = YES
 171 #---------------------------------------------------------------------------
 172 # configuration options related to the alphabetical class index
 173 #---------------------------------------------------------------------------
 174 ALPHABETICAL_INDEX     = YES
 175 COLS_IN_ALPHA_INDEX    = 3
 176 IGNORE_PREFIX          = GNUNET_
 177 #---------------------------------------------------------------------------
 178 # configuration options related to the HTML output
 179 #---------------------------------------------------------------------------
 180 GENERATE_HTML          = YES
 181 HTML_OUTPUT            = html
 182 HTML_FILE_EXTENSION    = .html
 183 HTML_HEADER            =
 184 HTML_FOOTER            =
 185 HTML_STYLESHEET        =
 186 GENERATE_HTMLHELP      = NO
 187 GENERATE_DOCSET        = NO
 188 DOCSET_FEEDNAME        = "GNUnet Source Documentation"
 189 DOCSET_BUNDLE_ID       = org.gnunet
 190 HTML_DYNAMIC_SECTIONS  = NO
 191 CHM_FILE               =
 192 HHC_LOCATION           =
 193 GENERATE_CHI           = NO
 194 CHM_INDEX_ENCODING     =
 195 BINARY_TOC             = NO
 196 TOC_EXPAND             = NO
 197 DISABLE_INDEX          = NO
 198 ENUM_VALUES_PER_LINE   = 4
 199 GENERATE_TREEVIEW      = NONE
 200 TREEVIEW_WIDTH         = 250
 201 FORMULA_FONTSIZE       = 10
 202 #---------------------------------------------------------------------------
 203 # configuration options related to the LaTeX output
 204 #---------------------------------------------------------------------------
 205 GENERATE_LATEX         = NO
 206 LATEX_OUTPUT           = latex
 207 LATEX_CMD_NAME         = latex
 208 MAKEINDEX_CMD_NAME     = makeindex
 209 COMPACT_LATEX          = YES
 210 PAPER_TYPE             = a4
 211 EXTRA_PACKAGES         =
 212 LATEX_HEADER           =
 213 PDF_HYPERLINKS         = YES
 214 USE_PDFLATEX           = YES
 215 LATEX_BATCHMODE        = NO
 216 LATEX_HIDE_INDICES     = NO
 217 #---------------------------------------------------------------------------
 218 # configuration options related to the RTF output
 219 #---------------------------------------------------------------------------
 220 GENERATE_RTF           = NO
 221 RTF_OUTPUT             = rtf
 222 COMPACT_RTF            = NO
 223 RTF_HYPERLINKS         = NO
 224 RTF_STYLESHEET_FILE    =
 225 RTF_EXTENSIONS_FILE    =
 226 #---------------------------------------------------------------------------
 227 # configuration options related to the man page output
 228 #---------------------------------------------------------------------------
 229 GENERATE_MAN           = NO
 230 MAN_OUTPUT             = man
 231 MAN_EXTENSION          = .3
 232 MAN_LINKS              = NO
 233 #---------------------------------------------------------------------------
 234 # configuration options related to the XML output
 235 #---------------------------------------------------------------------------
 236 GENERATE_XML           = NO
 237 XML_OUTPUT             = xml
 238 XML_SCHEMA             =
 239 XML_DTD                =
 240 XML_PROGRAMLISTING     = YES
 241 #---------------------------------------------------------------------------
 242 # configuration options for the AutoGen Definitions output
 243 #---------------------------------------------------------------------------
 244 GENERATE_AUTOGEN_DEF   = NO
 245 #---------------------------------------------------------------------------
 246 # configuration options related to the Perl module output
 247 #---------------------------------------------------------------------------
 248 GENERATE_PERLMOD       = NO
 249 PERLMOD_LATEX          = NO
 250 PERLMOD_PRETTY         = YES
 251 PERLMOD_MAKEVAR_PREFIX =
 252 #---------------------------------------------------------------------------
 253 # Configuration options related to the preprocessor
 254 #---------------------------------------------------------------------------
 255 ENABLE_PREPROCESSING   = YES
 256 MACRO_EXPANSION        = YES
 257 EXPAND_ONLY_PREDEF     = NO
 258 SEARCH_INCLUDES        = YES
 259 INCLUDE_PATH           =
 260 INCLUDE_FILE_PATTERNS  =
 261 PREDEFINED             = GNUNET_UNUSED="" GNUNET_PACKED=""
 262 EXPAND_AS_DEFINED      =
 263 SKIP_FUNCTION_MACROS   = YES
 264 #---------------------------------------------------------------------------
 265 # Configuration::additions related to external references
 266 #---------------------------------------------------------------------------
 267 TAGFILES               =
 268 GENERATE_TAGFILE       = gnunet.tag
 269 ALLEXTERNALS           = NO
 270 EXTERNAL_GROUPS        = YES
 271 PERL_PATH              = /usr/bin/perl
 272 #---------------------------------------------------------------------------
 273 # Configuration options related to the dot tool
 274 #---------------------------------------------------------------------------
 275 CLASS_DIAGRAMS         = YES
 276 MSCGEN_PATH            =
 277 HIDE_UNDOC_RELATIONS   = YES
 278 HAVE_DOT               = YES
 279 DOT_FONTNAME           = FreeSans
 280 DOT_FONTPATH           =
 281 CLASS_GRAPH            = YES
 282 COLLABORATION_GRAPH    = YES
 283 GROUP_GRAPHS           = YES
 284 UML_LOOK               = NO
 285 TEMPLATE_RELATIONS     = NO
 286 INCLUDE_GRAPH          = YES
 287 INCLUDED_BY_GRAPH      = YES
 288 CALL_GRAPH             = YES
 289 CALLER_GRAPH           = YES
 290 GRAPHICAL_HIERARCHY    = YES
 291 DIRECTORY_GRAPH        = YES
 292 DOT_IMAGE_FORMAT       = svg
 293 INTERACTIVE_SVG        = NO
 294 DOT_PATH               =
 295 DOTFILE_DIRS           =
 296 DOT_GRAPH_MAX_NODES    = 50
 297 MAX_DOT_GRAPH_DEPTH    = 10
 298 DOT_TRANSPARENT        = YES
 299 DOT_MULTI_TARGETS      = YES
 300 GENERATE_LEGEND        = YES
 301 DOT_CLEANUP            = YES
 302 #---------------------------------------------------------------------------
 303 # Configuration::additions related to the search engine
 304 #---------------------------------------------------------------------------
 305 SEARCHENGINE           = YES