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