source/Doxyfile

   1 # Doxyfile 0.1
   2
   3 #---------------------------------------------------------------------------
   4 # General configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = Samba
   7 PROJECT_NUMBER         = HEAD
   8
   9 # NOTE: By default, Doxygen writes into the dox/ subdirectory of the
  10 # invocation directory.  If you want to put it somewhere else, for
  11 # example, to write straight into a webserver directory, then override
  12 # this variable in a configuration concatenated to this one: Doxygen
  13 # doesn't mind variables being redefined.
  14
  15 OUTPUT_DIRECTORY       = dox
  16
  17 OUTPUT_LANGUAGE        = English
  18 EXTRACT_ALL            = YES
  19 EXTRACT_PRIVATE        = YES
  20 EXTRACT_STATIC         = YES
  21 HIDE_UNDOC_MEMBERS     = NO
  22 HIDE_UNDOC_CLASSES     = NO
  23 BRIEF_MEMBER_DESC      = YES
  24 REPEAT_BRIEF           = YES
  25 ALWAYS_DETAILED_SEC    = NO
  26 FULL_PATH_NAMES        = NO
  27 STRIP_FROM_PATH        = *source
  28 INTERNAL_DOCS          = YES
  29 CLASS_DIAGRAMS         = YES
  30 SOURCE_BROWSER         = YES
  31 INLINE_SOURCES         = YES
  32 STRIP_CODE_COMMENTS    = NO
  33 CASE_SENSE_NAMES       = YES
  34 SHORT_NAMES            = NO
  35 HIDE_SCOPE_NAMES       = YES
  36 VERBATIM_HEADERS       = YES
  37 SHOW_INCLUDE_FILES     = YES
  38 JAVADOC_AUTOBRIEF      = YES
  39 INHERIT_DOCS           = YES
  40 INLINE_INFO            = YES
  41 SORT_MEMBER_DOCS       = NO
  42 DISTRIBUTE_GROUP_DOC   = NO
  43 TAB_SIZE               = 8
  44 GENERATE_TODOLIST      = YES
  45 GENERATE_TESTLIST      = YES
  46 GENERATE_BUGLIST       = YES
  47 ALIASES                =
  48 ENABLED_SECTIONS       =
  49 MAX_INITIALIZER_LINES  = 30
  50 OPTIMIZE_OUTPUT_FOR_C  = YES
  51 SHOW_USED_FILES        = YES
  52 REFERENCED_BY_RELATION = YES
  53 #---------------------------------------------------------------------------
  54 # configuration options related to warning and progress messages
  55 #---------------------------------------------------------------------------
  56 QUIET                  = YES
  57 WARNINGS               = NO
  58 WARN_IF_UNDOCUMENTED   = NO
  59 WARN_FORMAT            = "$file:$line: $text"
  60 WARN_LOGFILE           =
  61 #---------------------------------------------------------------------------
  62 # configuration options related to the input files
  63 #---------------------------------------------------------------------------
  64 INPUT                  = . \
  65                          mainpage.dox
  66 FILE_PATTERNS          = *.c \
  67                          *.h \
  68                          *.idl
  69 RECURSIVE              = YES
  70 EXCLUDE                = include/includes.h \
  71                          include/proto.h
  72 EXCLUDE_PATTERNS       =
  73 EXAMPLE_PATH           =
  74 EXAMPLE_PATTERNS       =
  75 IMAGE_PATH             =
  76 INPUT_FILTER           =
  77 FILTER_SOURCE_FILES    = NO
  78 #---------------------------------------------------------------------------
  79 # configuration options related to the alphabetical class index
  80 #---------------------------------------------------------------------------
  81 ALPHABETICAL_INDEX     = YES
  82 COLS_IN_ALPHA_INDEX    = 1
  83 IGNORE_PREFIX          =
  84 #---------------------------------------------------------------------------
  85 # configuration options related to the HTML output
  86 #---------------------------------------------------------------------------
  87 GENERATE_HTML          = YES
  88 HTML_OUTPUT            = .
  89 HTML_HEADER            =
  90 HTML_FOOTER            =
  91 HTML_STYLESHEET        =
  92 HTML_ALIGN_MEMBERS     = YES
  93 GENERATE_HTMLHELP      = NO
  94 GENERATE_CHI           = NO
  95 BINARY_TOC             = NO
  96 TOC_EXPAND             = NO
  97 DISABLE_INDEX          = NO
  98 ENUM_VALUES_PER_LINE   = 3
  99 GENERATE_TREEVIEW      = NO
 100 TREEVIEW_WIDTH         = 250
 101 #---------------------------------------------------------------------------
 102 # configuration options related to the LaTeX output
 103 #---------------------------------------------------------------------------
 104 GENERATE_LATEX         = NO
 105 LATEX_OUTPUT           = latex
 106 COMPACT_LATEX          = NO
 107 PAPER_TYPE             = a4wide
 108 EXTRA_PACKAGES         =
 109 LATEX_HEADER           =
 110 PDF_HYPERLINKS         = YES
 111 USE_PDFLATEX           = YES
 112 LATEX_BATCHMODE        = YES
 113 #---------------------------------------------------------------------------
 114 # configuration options related to the RTF output
 115 #---------------------------------------------------------------------------
 116 GENERATE_RTF           = NO
 117 RTF_OUTPUT             = rtf
 118 COMPACT_RTF            = NO
 119 RTF_HYPERLINKS         = NO
 120 RTF_STYLESHEET_FILE    =
 121 RTF_EXTENSIONS_FILE    =
 122 #---------------------------------------------------------------------------
 123 # configuration options related to the man page output
 124 #---------------------------------------------------------------------------
 125 GENERATE_MAN           = NO
 126 MAN_OUTPUT             = man
 127 MAN_EXTENSION          = .3
 128 MAN_LINKS              = NO
 129 #---------------------------------------------------------------------------
 130 # configuration options related to the XML output
 131 #---------------------------------------------------------------------------
 132 GENERATE_XML           = NO
 133 #---------------------------------------------------------------------------
 134 # configuration options related to the preprocessor
 135 #---------------------------------------------------------------------------
 136 ENABLE_PREPROCESSING   = NO
 137 MACRO_EXPANSION        = NO
 138 EXPAND_ONLY_PREDEF     = NO
 139 SEARCH_INCLUDES        = YES
 140 INCLUDE_PATH           =
 141 INCLUDE_FILE_PATTERNS  =
 142 PREDEFINED             =
 143 EXPAND_AS_DEFINED      =
 144 SKIP_FUNCTION_MACROS   = YES
 145 #---------------------------------------------------------------------------
 146 # configuration::additions related to external references
 147 #---------------------------------------------------------------------------
 148 TAGFILES               =
 149 GENERATE_TAGFILE       =
 150 ALLEXTERNALS           = NO
 151 PERL_PATH              = /usr/bin/perl
 152 #---------------------------------------------------------------------------
 153 # configuration options related to the dot tool
 154 #---------------------------------------------------------------------------
 155 HAVE_DOT               = NO
 156 CLASS_GRAPH            = YES
 157 COLLABORATION_GRAPH    = YES
 158 TEMPLATE_RELATIONS     = YES
 159 INCLUDE_GRAPH          = YES
 160 INCLUDED_BY_GRAPH      = YES
 161 GRAPHICAL_HIERARCHY    = YES
 162 DOT_PATH               =
 163 DOTFILE_DIRS           =
 164 MAX_DOT_GRAPH_WIDTH    = 1024
 165 MAX_DOT_GRAPH_HEIGHT   = 1024
 166 GENERATE_LEGEND        = YES
 167 DOT_CLEANUP            = YES
 168 #---------------------------------------------------------------------------
 169 # configuration::additions related to the search engine
 170 #---------------------------------------------------------------------------
 171 SEARCHENGINE           = NO
 172 CGI_NAME               = search.cgi
 173 CGI_URL                =
 174 DOC_URL                =
 175 DOC_ABSPATH            =
 176 BIN_ABSPATH            = /usr/local/bin/
 177 EXT_DOC_PATHS          =