Doxyfile

   1 # Doxyfile 0.1
   2
   3 #---------------------------------------------------------------------------
   4 # General configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = rsync
   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_BY_RELATION = YES
  45 #---------------------------------------------------------------------------
  46 # configuration options related to warning and progress messages
  47 #---------------------------------------------------------------------------
  48 QUIET                  = NO
  49 WARNINGS               = NO
  50 WARN_IF_UNDOCUMENTED   = NO
  51 WARN_FORMAT            = "$file:$line: $text"
  52 WARN_LOGFILE           =
  53 #---------------------------------------------------------------------------
  54 # configuration options related to the input files
  55 #---------------------------------------------------------------------------
  56 INPUT                  = .
  57 FILE_PATTERNS          = *.c \
  58                          *.h
  59 RECURSIVE              = YES
  60 EXCLUDE                =proto.h
  61 EXCLUDE_PATTERNS       =
  62 EXAMPLE_PATH           =
  63 EXAMPLE_PATTERNS       =
  64 IMAGE_PATH             =
  65 INPUT_FILTER           =
  66 FILTER_SOURCE_FILES    = NO
  67 #---------------------------------------------------------------------------
  68 # configuration options related to the alphabetical class index
  69 #---------------------------------------------------------------------------
  70 ALPHABETICAL_INDEX     = YES
  71 COLS_IN_ALPHA_INDEX    = 3
  72 IGNORE_PREFIX          =
  73 #---------------------------------------------------------------------------
  74 # configuration options related to the HTML output
  75 #---------------------------------------------------------------------------
  76 GENERATE_HTML          = YES
  77 HTML_OUTPUT            = html
  78 HTML_HEADER            =
  79 HTML_FOOTER            =
  80 HTML_STYLESHEET        =
  81 HTML_ALIGN_MEMBERS     = YES
  82 GENERATE_HTMLHELP      = NO
  83 GENERATE_CHI           = NO
  84 BINARY_TOC             = NO
  85 TOC_EXPAND             = NO
  86 DISABLE_INDEX          = NO
  87 ENUM_VALUES_PER_LINE   = 3
  88 GENERATE_TREEVIEW      = NO
  89 TREEVIEW_WIDTH         = 250
  90 #---------------------------------------------------------------------------
  91 # configuration options related to the LaTeX output
  92 #---------------------------------------------------------------------------
  93 GENERATE_LATEX         = NO
  94 LATEX_OUTPUT           = latex
  95 COMPACT_LATEX          = NO
  96 PAPER_TYPE             = a4wide
  97 EXTRA_PACKAGES         =
  98 LATEX_HEADER           =
  99 PDF_HYPERLINKS         = YES
 100 USE_PDFLATEX           = YES
 101 LATEX_BATCHMODE        = YES
 102 #---------------------------------------------------------------------------
 103 # configuration options related to the RTF output
 104 #---------------------------------------------------------------------------
 105 GENERATE_RTF           = NO
 106 RTF_OUTPUT             = rtf
 107 COMPACT_RTF            = NO
 108 RTF_HYPERLINKS         = NO
 109 RTF_STYLESHEET_FILE    =
 110 RTF_EXTENSIONS_FILE    =
 111 #---------------------------------------------------------------------------
 112 # configuration options related to the man page output
 113 #---------------------------------------------------------------------------
 114 GENERATE_MAN           = NO
 115 MAN_OUTPUT             = man
 116 MAN_EXTENSION          = .3
 117 MAN_LINKS              = NO
 118 #---------------------------------------------------------------------------
 119 # configuration options related to the XML output
 120 #---------------------------------------------------------------------------
 121 GENERATE_XML           = NO
 122 #---------------------------------------------------------------------------
 123 # Configuration options related to the preprocessor
 124 #---------------------------------------------------------------------------
 125 ENABLE_PREPROCESSING   = NO
 126 MACRO_EXPANSION        = NO
 127 EXPAND_ONLY_PREDEF     = NO
 128 SEARCH_INCLUDES        = YES
 129 INCLUDE_PATH           =
 130 INCLUDE_FILE_PATTERNS  =
 131 PREDEFINED             =
 132 EXPAND_AS_DEFINED      =
 133 SKIP_FUNCTION_MACROS   = YES
 134 #---------------------------------------------------------------------------
 135 # Configuration::addtions related to external references
 136 #---------------------------------------------------------------------------
 137 TAGFILES               =
 138 GENERATE_TAGFILE       =
 139 ALLEXTERNALS           = NO
 140 PERL_PATH              = /usr/bin/perl
 141 #---------------------------------------------------------------------------
 142 # Configuration options related to the dot tool
 143 #---------------------------------------------------------------------------
 144 HAVE_DOT               = YES
 145 CLASS_GRAPH            = YES
 146 COLLABORATION_GRAPH    = YES
 147 TEMPLATE_RELATIONS     = YES
 148 INCLUDE_GRAPH          = YES
 149 INCLUDED_BY_GRAPH      = YES
 150 GRAPHICAL_HIERARCHY    = YES
 151 DOT_PATH               =
 152 DOTFILE_DIRS           =
 153 MAX_DOT_GRAPH_WIDTH    = 1024
 154 MAX_DOT_GRAPH_HEIGHT   = 1024
 155 GENERATE_LEGEND        = YES
 156 DOT_CLEANUP            = YES
 157 #---------------------------------------------------------------------------
 158 # Configuration::addtions related to the search engine
 159 #---------------------------------------------------------------------------
 160 SEARCHENGINE           = NO
 161 CGI_NAME               = search.cgi
 162 CGI_URL                =
 163 DOC_URL                =
 164 DOC_ABSPATH            =
 165 BIN_ABSPATH            = /usr/local/bin/
 166 EXT_DOC_PATHS          =