Fix a comment.
[rsync/qnx.git] / Doxyfile
blob14e8d6118dbef595510f12995e665933b4b814bb
1 # Doxyfile 1.2.15
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 EXTRACT_LOCAL_CLASSES  = YES
14 HIDE_UNDOC_MEMBERS     = NO
15 HIDE_UNDOC_CLASSES     = NO
16 BRIEF_MEMBER_DESC      = YES
17 REPEAT_BRIEF           = YES
18 ALWAYS_DETAILED_SEC    = NO
19 INLINE_INHERITED_MEMB  = NO
20 FULL_PATH_NAMES        = NO
21 STRIP_FROM_PATH        = *source
22 INTERNAL_DOCS          = YES
23 STRIP_CODE_COMMENTS    = NO
24 CASE_SENSE_NAMES       = YES
25 SHORT_NAMES            = NO
26 HIDE_SCOPE_NAMES       = YES
27 VERBATIM_HEADERS       = YES
28 SHOW_INCLUDE_FILES     = YES
29 JAVADOC_AUTOBRIEF      = YES
30 INHERIT_DOCS           = YES
31 INLINE_INFO            = YES
32 SORT_MEMBER_DOCS       = NO
33 DISTRIBUTE_GROUP_DOC   = NO
34 TAB_SIZE               = 8
35 GENERATE_TODOLIST      = YES
36 GENERATE_TESTLIST      = YES
37 GENERATE_BUGLIST       = YES
38 ALIASES                = 
39 ENABLED_SECTIONS       = 
40 MAX_INITIALIZER_LINES  = 30
41 OPTIMIZE_OUTPUT_FOR_C  = YES
42 OPTIMIZE_OUTPUT_JAVA   = NO
43 SHOW_USED_FILES        = YES
44 #---------------------------------------------------------------------------
45 # configuration options related to warning and progress messages
46 #---------------------------------------------------------------------------
47 QUIET                  = NO
48 WARNINGS               = NO
49 WARN_IF_UNDOCUMENTED   = NO
50 WARN_FORMAT            = "$file:$line: $text"
51 WARN_LOGFILE           = 
52 #---------------------------------------------------------------------------
53 # configuration options related to the input files
54 #---------------------------------------------------------------------------
55 INPUT                  = .
56 FILE_PATTERNS          = *.c \
57                          *.h
58 RECURSIVE              = YES
59 EXCLUDE                = proto.h \
60                          zlib \
61                          popt
62 EXCLUDE_SYMLINKS       = NO
63 EXCLUDE_PATTERNS       = 
64 EXAMPLE_PATH           = 
65 EXAMPLE_PATTERNS       = 
66 EXAMPLE_RECURSIVE      = NO
67 IMAGE_PATH             = 
68 INPUT_FILTER           = 
69 FILTER_SOURCE_FILES    = NO
70 #---------------------------------------------------------------------------
71 # configuration options related to source browsing
72 #---------------------------------------------------------------------------
73 SOURCE_BROWSER         = YES
74 INLINE_SOURCES         = YES
75 REFERENCED_BY_RELATION = YES
76 REFERENCES_RELATION    = YES
77 #---------------------------------------------------------------------------
78 # configuration options related to the alphabetical class index
79 #---------------------------------------------------------------------------
80 ALPHABETICAL_INDEX     = YES
81 COLS_IN_ALPHA_INDEX    = 3
82 IGNORE_PREFIX          = 
83 #---------------------------------------------------------------------------
84 # configuration options related to the HTML output
85 #---------------------------------------------------------------------------
86 GENERATE_HTML          = YES
87 HTML_OUTPUT            = html
88 HTML_FILE_EXTENSION    = .html
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 LATEX_CMD_NAME         = latex
107 MAKEINDEX_CMD_NAME     = makeindex
108 COMPACT_LATEX          = NO
109 PAPER_TYPE             = a4wide
110 EXTRA_PACKAGES         = 
111 LATEX_HEADER           = 
112 PDF_HYPERLINKS         = YES
113 USE_PDFLATEX           = YES
114 LATEX_BATCHMODE        = YES
115 #---------------------------------------------------------------------------
116 # configuration options related to the RTF output
117 #---------------------------------------------------------------------------
118 GENERATE_RTF           = NO
119 RTF_OUTPUT             = rtf
120 COMPACT_RTF            = NO
121 RTF_HYPERLINKS         = NO
122 RTF_STYLESHEET_FILE    = 
123 RTF_EXTENSIONS_FILE    = 
124 #---------------------------------------------------------------------------
125 # configuration options related to the man page output
126 #---------------------------------------------------------------------------
127 GENERATE_MAN           = NO
128 MAN_OUTPUT             = man
129 MAN_EXTENSION          = .3
130 MAN_LINKS              = NO
131 #---------------------------------------------------------------------------
132 # configuration options related to the XML output
133 #---------------------------------------------------------------------------
134 GENERATE_XML           = NO
135 #---------------------------------------------------------------------------
136 # configuration options for the AutoGen Definitions output
137 #---------------------------------------------------------------------------
138 GENERATE_AUTOGEN_DEF   = NO
139 #---------------------------------------------------------------------------
140 # Configuration options related to the preprocessor   
141 #---------------------------------------------------------------------------
142 ENABLE_PREPROCESSING   = NO
143 MACRO_EXPANSION        = NO
144 EXPAND_ONLY_PREDEF     = NO
145 SEARCH_INCLUDES        = YES
146 INCLUDE_PATH           = 
147 INCLUDE_FILE_PATTERNS  = 
148 PREDEFINED             = 
149 EXPAND_AS_DEFINED      = 
150 SKIP_FUNCTION_MACROS   = YES
151 #---------------------------------------------------------------------------
152 # Configuration::addtions related to external references   
153 #---------------------------------------------------------------------------
154 TAGFILES               = 
155 GENERATE_TAGFILE       = 
156 ALLEXTERNALS           = NO
157 EXTERNAL_GROUPS        = YES
158 PERL_PATH              = /usr/bin/perl
159 #---------------------------------------------------------------------------
160 # Configuration options related to the dot tool   
161 #---------------------------------------------------------------------------
162 CLASS_DIAGRAMS         = YES
163 HAVE_DOT               = YES
164 CLASS_GRAPH            = YES
165 COLLABORATION_GRAPH    = YES
166 TEMPLATE_RELATIONS     = YES
167 HIDE_UNDOC_RELATIONS   = YES
168 INCLUDE_GRAPH          = YES
169 INCLUDED_BY_GRAPH      = YES
170 GRAPHICAL_HIERARCHY    = YES
171 DOT_IMAGE_FORMAT       = png
172 DOT_PATH               = 
173 DOTFILE_DIRS           = 
174 MAX_DOT_GRAPH_WIDTH    = 1024
175 MAX_DOT_GRAPH_HEIGHT   = 1024
176 GENERATE_LEGEND        = YES
177 DOT_CLEANUP            = YES
178 #---------------------------------------------------------------------------
179 # Configuration::addtions related to the search engine   
180 #---------------------------------------------------------------------------
181 SEARCHENGINE           = NO
182 CGI_NAME               = search.cgi
183 CGI_URL                = 
184 DOC_URL                = 
185 DOC_ABSPATH            = 
186 BIN_ABSPATH            = /usr/local/bin/
187 EXT_DOC_PATHS          =