Add udev helper to allow access to USB devices for non-root users
[openobex:mainline.git] / doc / Doxyfile
1 # Doxyfile 1.5.3
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = ASCII
7 PROJECT_NAME           = OpenOBEX
8 PROJECT_NUMBER         = 1.4
9 OUTPUT_DIRECTORY       = .
10 CREATE_SUBDIRS         = NO
11 OUTPUT_LANGUAGE        = English
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
14 ABBREVIATE_BRIEF       = "The $name class" \
15                          "The $name widget" \
16                          "The $name file" \
17                          is \
18                          provides \
19                          specifies \
20                          contains \
21                          represents \
22                          a \
23                          an \
24                          the
25 ALWAYS_DETAILED_SEC    = NO
26 INLINE_INHERITED_MEMB  = NO
27 FULL_PATH_NAMES        = NO
28 STRIP_FROM_PATH        = 
29 STRIP_FROM_INC_PATH    = 
30 SHORT_NAMES            = NO
31 JAVADOC_AUTOBRIEF      = YES
32 QT_AUTOBRIEF           = YES
33 MULTILINE_CPP_IS_BRIEF = NO
34 DETAILS_AT_TOP         = NO
35 INHERIT_DOCS           = YES
36 SEPARATE_MEMBER_PAGES  = NO
37 TAB_SIZE               = 8
38 ALIASES                = 
39 OPTIMIZE_OUTPUT_FOR_C  = YES
40 OPTIMIZE_OUTPUT_JAVA   = NO
41 BUILTIN_STL_SUPPORT    = NO
42 CPP_CLI_SUPPORT        = NO
43 DISTRIBUTE_GROUP_DOC   = NO
44 SUBGROUPING            = YES
45 #---------------------------------------------------------------------------
46 # Build related configuration options
47 #---------------------------------------------------------------------------
48 EXTRACT_ALL            = YES
49 EXTRACT_PRIVATE        = NO
50 EXTRACT_STATIC         = NO
51 EXTRACT_LOCAL_CLASSES  = NO
52 EXTRACT_LOCAL_METHODS  = NO
53 EXTRACT_ANON_NSPACES   = NO
54 HIDE_UNDOC_MEMBERS     = NO
55 HIDE_UNDOC_CLASSES     = NO
56 HIDE_FRIEND_COMPOUNDS  = NO
57 HIDE_IN_BODY_DOCS      = NO
58 INTERNAL_DOCS          = NO
59 CASE_SENSE_NAMES       = YES
60 HIDE_SCOPE_NAMES       = NO
61 SHOW_INCLUDE_FILES     = YES
62 INLINE_INFO            = YES
63 SORT_MEMBER_DOCS       = YES
64 SORT_BRIEF_DOCS        = NO
65 SORT_BY_SCOPE_NAME     = NO
66 GENERATE_TODOLIST      = YES
67 GENERATE_TESTLIST      = YES
68 GENERATE_BUGLIST       = YES
69 GENERATE_DEPRECATEDLIST= YES
70 ENABLED_SECTIONS       = 
71 MAX_INITIALIZER_LINES  = 30
72 SHOW_USED_FILES        = YES
73 SHOW_DIRECTORIES       = NO
74 FILE_VERSION_FILTER    = 
75 #---------------------------------------------------------------------------
76 # configuration options related to warning and progress messages
77 #---------------------------------------------------------------------------
78 QUIET                  = NO
79 WARNINGS               = YES
80 WARN_IF_UNDOCUMENTED   = YES
81 WARN_IF_DOC_ERROR      = YES
82 WARN_NO_PARAMDOC       = NO
83 WARN_FORMAT            = "$file:$line: $text"
84 WARN_LOGFILE           = 
85 #---------------------------------------------------------------------------
86 # configuration options related to the input files
87 #---------------------------------------------------------------------------
88 INPUT                  = ../lib/obex.c ../include/openobex/obex.h \
89                          ../include/openobex/obex_const.h openobex.coverpage
90 INPUT_ENCODING         = ASCII
91 FILE_PATTERNS          = *.c *.h
92 RECURSIVE              = NO
93 EXCLUDE                = 
94 EXCLUDE_SYMLINKS       = NO
95 EXCLUDE_PATTERNS       = *_private.h
96 EXCLUDE_SYMBOLS        = 
97 EXAMPLE_PATH           = 
98 EXAMPLE_PATTERNS       = *
99 EXAMPLE_RECURSIVE      = NO
100 IMAGE_PATH             = 
101 INPUT_FILTER           = 
102 FILTER_PATTERNS        = 
103 FILTER_SOURCE_FILES    = NO
104 #---------------------------------------------------------------------------
105 # configuration options related to source browsing
106 #---------------------------------------------------------------------------
107 SOURCE_BROWSER         = NO
108 INLINE_SOURCES         = NO
109 STRIP_CODE_COMMENTS    = YES
110 REFERENCED_BY_RELATION = NO
111 REFERENCES_RELATION    = NO
112 REFERENCES_LINK_SOURCE = YES
113 USE_HTAGS              = NO
114 VERBATIM_HEADERS       = NO
115 #---------------------------------------------------------------------------
116 # configuration options related to the alphabetical class index
117 #---------------------------------------------------------------------------
118 ALPHABETICAL_INDEX     = NO
119 COLS_IN_ALPHA_INDEX    = 5
120 IGNORE_PREFIX          = 
121 #---------------------------------------------------------------------------
122 # configuration options related to the HTML output
123 #---------------------------------------------------------------------------
124 GENERATE_HTML          = YES
125 HTML_OUTPUT            = html
126 HTML_FILE_EXTENSION    = .html
127 HTML_HEADER            = 
128 HTML_FOOTER            = 
129 HTML_STYLESHEET        = 
130 HTML_ALIGN_MEMBERS     = YES
131 GENERATE_HTMLHELP      = NO
132 HTML_DYNAMIC_SECTIONS  = NO
133 CHM_FILE               = 
134 HHC_LOCATION           = 
135 GENERATE_CHI           = NO
136 BINARY_TOC             = NO
137 TOC_EXPAND             = NO
138 DISABLE_INDEX          = NO
139 ENUM_VALUES_PER_LINE   = 4
140 GENERATE_TREEVIEW      = NO
141 TREEVIEW_WIDTH         = 250
142 #---------------------------------------------------------------------------
143 # configuration options related to the LaTeX output
144 #---------------------------------------------------------------------------
145 GENERATE_LATEX         = NO
146 LATEX_OUTPUT           = latex
147 LATEX_CMD_NAME         = latex
148 MAKEINDEX_CMD_NAME     = makeindex
149 COMPACT_LATEX          = NO
150 PAPER_TYPE             = a4wide
151 EXTRA_PACKAGES         = 
152 LATEX_HEADER           = 
153 PDF_HYPERLINKS         = NO
154 USE_PDFLATEX           = NO
155 LATEX_BATCHMODE        = NO
156 LATEX_HIDE_INDICES     = NO
157 #---------------------------------------------------------------------------
158 # configuration options related to the RTF output
159 #---------------------------------------------------------------------------
160 GENERATE_RTF           = NO
161 RTF_OUTPUT             = rtf
162 COMPACT_RTF            = NO
163 RTF_HYPERLINKS         = NO
164 RTF_STYLESHEET_FILE    = 
165 RTF_EXTENSIONS_FILE    = 
166 #---------------------------------------------------------------------------
167 # configuration options related to the man page output
168 #---------------------------------------------------------------------------
169 GENERATE_MAN           = NO
170 MAN_OUTPUT             = man
171 MAN_EXTENSION          = .3
172 MAN_LINKS              = NO
173 #---------------------------------------------------------------------------
174 # configuration options related to the XML output
175 #---------------------------------------------------------------------------
176 GENERATE_XML           = NO
177 XML_OUTPUT             = xml
178 XML_SCHEMA             = 
179 XML_DTD                = 
180 XML_PROGRAMLISTING     = YES
181 #---------------------------------------------------------------------------
182 # configuration options for the AutoGen Definitions output
183 #---------------------------------------------------------------------------
184 GENERATE_AUTOGEN_DEF   = NO
185 #---------------------------------------------------------------------------
186 # configuration options related to the Perl module output
187 #---------------------------------------------------------------------------
188 GENERATE_PERLMOD       = NO
189 PERLMOD_LATEX          = NO
190 PERLMOD_PRETTY         = YES
191 PERLMOD_MAKEVAR_PREFIX = 
192 #---------------------------------------------------------------------------
193 # Configuration options related to the preprocessor   
194 #---------------------------------------------------------------------------
195 ENABLE_PREPROCESSING   = YES
196 MACRO_EXPANSION        = YES
197 EXPAND_ONLY_PREDEF     = YES
198 SEARCH_INCLUDES        = YES
199 INCLUDE_PATH           = 
200 INCLUDE_FILE_PATTERNS  = 
201 PREDEFINED             = "LIB_SYMBOL=" "CALLAPI=" "OPENOBEX_SYMBOL(retval)=retval" HAVE_IRDA HAVE_USB HAVE_USB1 HAVE_BLUETOOTH
202 EXPAND_AS_DEFINED      = 
203 SKIP_FUNCTION_MACROS   = YES
204 #---------------------------------------------------------------------------
205 # Configuration::additions related to external references   
206 #---------------------------------------------------------------------------
207 TAGFILES               = 
208 GENERATE_TAGFILE       = 
209 ALLEXTERNALS           = NO
210 EXTERNAL_GROUPS        = YES
211 PERL_PATH              = /usr/bin/perl
212 #---------------------------------------------------------------------------
213 # Configuration options related to the dot tool   
214 #---------------------------------------------------------------------------
215 CLASS_DIAGRAMS         = YES
216 MSCGEN_PATH            = 
217 HIDE_UNDOC_RELATIONS   = YES
218 HAVE_DOT               = NO
219 CLASS_GRAPH            = YES
220 COLLABORATION_GRAPH    = YES
221 GROUP_GRAPHS           = YES
222 UML_LOOK               = NO
223 TEMPLATE_RELATIONS     = NO
224 INCLUDE_GRAPH          = YES
225 INCLUDED_BY_GRAPH      = YES
226 CALL_GRAPH             = NO
227 CALLER_GRAPH           = NO
228 GRAPHICAL_HIERARCHY    = YES
229 DIRECTORY_GRAPH        = YES
230 DOT_IMAGE_FORMAT       = png
231 DOT_PATH               = 
232 DOTFILE_DIRS           = 
233 DOT_GRAPH_MAX_NODES    = 50
234 MAX_DOT_GRAPH_DEPTH    = 0
235 DOT_TRANSPARENT        = NO
236 DOT_MULTI_TARGETS      = NO
237 GENERATE_LEGEND        = YES
238 DOT_CLEANUP            = YES
239 #---------------------------------------------------------------------------
240 # Configuration::additions related to the search engine   
241 #---------------------------------------------------------------------------
242 SEARCHENGINE           = NO