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