source/Doxyfile

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