Fix checkpatch and doxygen issues in microdia-sysfs.c
[microdia.git] / Doxyfile
blobe9c518d03ff2ff04a6bf5b164b2909f4b1dfecc2
1 # Doxyfile 1.5.3
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           = "Microdia Webcam Driver"
8 PROJECT_NUMBER         = 00.00.01
9 OUTPUT_DIRECTORY       = ./doc
10 CREATE_SUBDIRS         = YES
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      = NO
32 QT_AUTOBRIEF           = NO
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            = NO
49 EXTRACT_PRIVATE        = NO
50 EXTRACT_STATIC         = YES
51 EXTRACT_LOCAL_CLASSES  = YES
52 EXTRACT_LOCAL_METHODS  = NO
53 EXTRACT_ANON_NSPACES   = NO
54 HIDE_UNDOC_MEMBERS     = YES
55 HIDE_UNDOC_CLASSES     = YES
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                  = ./
89 INPUT_ENCODING         = UTF-8
90 FILE_PATTERNS          = *.c \
91                          *.cc \
92                          *.cxx \
93                          *.cpp \
94                          *.c++ \
95                          *.d \
96                          *.java \
97                          *.ii \
98                          *.ixx \
99                          *.ipp \
100                          *.i++ \
101                          *.inl \
102                          *.h \
103                          *.hh \
104                          *.hxx \
105                          *.hpp \
106                          *.h++ \
107                          *.idl \
108                          *.odl \
109                          *.cs \
110                          *.php \
111                          *.php3 \
112                          *.inc \
113                          *.m \
114                          *.mm \
115                          *.dox \
116                          *.py \
117                          *.C \
118                          *.CC \
119                          *.C++ \
120                          *.II \
121                          *.I++ \
122                          *.H \
123                          *.HH \
124                          *.H++ \
125                          *.CS \
126                          *.PHP \
127                          *.PHP3 \
128                          *.M \
129                          *.MM \
130                          *.PY
131 RECURSIVE              = YES
132 EXCLUDE                = 
133 EXCLUDE_SYMLINKS       = NO
134 EXCLUDE_PATTERNS       = *.mod.c
135 EXCLUDE_SYMBOLS        = 
136 EXAMPLE_PATH           = 
137 EXAMPLE_PATTERNS       = *
138 EXAMPLE_RECURSIVE      = NO
139 IMAGE_PATH             = 
140 INPUT_FILTER           = 
141 FILTER_PATTERNS        = 
142 FILTER_SOURCE_FILES    = NO
143 #---------------------------------------------------------------------------
144 # configuration options related to source browsing
145 #---------------------------------------------------------------------------
146 SOURCE_BROWSER         = YES
147 INLINE_SOURCES         = NO
148 STRIP_CODE_COMMENTS    = YES
149 REFERENCED_BY_RELATION = YES
150 REFERENCES_RELATION    = YES
151 REFERENCES_LINK_SOURCE = YES
152 USE_HTAGS              = NO
153 VERBATIM_HEADERS       = YES
154 #---------------------------------------------------------------------------
155 # configuration options related to the alphabetical class index
156 #---------------------------------------------------------------------------
157 ALPHABETICAL_INDEX     = NO
158 COLS_IN_ALPHA_INDEX    = 5
159 IGNORE_PREFIX          = 
160 #---------------------------------------------------------------------------
161 # configuration options related to the HTML output
162 #---------------------------------------------------------------------------
163 GENERATE_HTML          = YES
164 HTML_OUTPUT            = html
165 HTML_FILE_EXTENSION    = .html
166 HTML_HEADER            = 
167 HTML_FOOTER            = 
168 HTML_STYLESHEET        = 
169 HTML_ALIGN_MEMBERS     = YES
170 GENERATE_HTMLHELP      = NO
171 HTML_DYNAMIC_SECTIONS  = NO
172 CHM_FILE               = 
173 HHC_LOCATION           = 
174 GENERATE_CHI           = NO
175 BINARY_TOC             = NO
176 TOC_EXPAND             = NO
177 DISABLE_INDEX          = NO
178 ENUM_VALUES_PER_LINE   = 4
179 GENERATE_TREEVIEW      = YES
180 TREEVIEW_WIDTH         = 250
181 #---------------------------------------------------------------------------
182 # configuration options related to the LaTeX output
183 #---------------------------------------------------------------------------
184 GENERATE_LATEX         = NO
185 LATEX_OUTPUT           = latex
186 LATEX_CMD_NAME         = latex
187 MAKEINDEX_CMD_NAME     = makeindex
188 COMPACT_LATEX          = NO
189 PAPER_TYPE             = a4wide
190 EXTRA_PACKAGES         = 
191 LATEX_HEADER           = 
192 PDF_HYPERLINKS         = NO
193 USE_PDFLATEX           = NO
194 LATEX_BATCHMODE        = NO
195 LATEX_HIDE_INDICES     = NO
196 #---------------------------------------------------------------------------
197 # configuration options related to the RTF output
198 #---------------------------------------------------------------------------
199 GENERATE_RTF           = NO
200 RTF_OUTPUT             = rtf
201 COMPACT_RTF            = NO
202 RTF_HYPERLINKS         = NO
203 RTF_STYLESHEET_FILE    = 
204 RTF_EXTENSIONS_FILE    = 
205 #---------------------------------------------------------------------------
206 # configuration options related to the man page output
207 #---------------------------------------------------------------------------
208 GENERATE_MAN           = NO
209 MAN_OUTPUT             = man
210 MAN_EXTENSION          = .3
211 MAN_LINKS              = NO
212 #---------------------------------------------------------------------------
213 # configuration options related to the XML output
214 #---------------------------------------------------------------------------
215 GENERATE_XML           = NO
216 XML_OUTPUT             = xml
217 XML_SCHEMA             = 
218 XML_DTD                = 
219 XML_PROGRAMLISTING     = YES
220 #---------------------------------------------------------------------------
221 # configuration options for the AutoGen Definitions output
222 #---------------------------------------------------------------------------
223 GENERATE_AUTOGEN_DEF   = NO
224 #---------------------------------------------------------------------------
225 # configuration options related to the Perl module output
226 #---------------------------------------------------------------------------
227 GENERATE_PERLMOD       = NO
228 PERLMOD_LATEX          = NO
229 PERLMOD_PRETTY         = YES
230 PERLMOD_MAKEVAR_PREFIX = 
231 #---------------------------------------------------------------------------
232 # Configuration options related to the preprocessor   
233 #---------------------------------------------------------------------------
234 ENABLE_PREPROCESSING   = YES
235 MACRO_EXPANSION        = NO
236 EXPAND_ONLY_PREDEF     = NO
237 SEARCH_INCLUDES        = YES
238 INCLUDE_PATH           = 
239 INCLUDE_FILE_PATTERNS  = 
240 PREDEFINED             = 
241 EXPAND_AS_DEFINED      = 
242 SKIP_FUNCTION_MACROS   = YES
243 #---------------------------------------------------------------------------
244 # Configuration::additions related to external references   
245 #---------------------------------------------------------------------------
246 TAGFILES               = 
247 GENERATE_TAGFILE       = 
248 ALLEXTERNALS           = NO
249 EXTERNAL_GROUPS        = YES
250 PERL_PATH              = /usr/bin/perl
251 #---------------------------------------------------------------------------
252 # Configuration options related to the dot tool   
253 #---------------------------------------------------------------------------
254 CLASS_DIAGRAMS         = NO
255 MSCGEN_PATH            = 
256 HIDE_UNDOC_RELATIONS   = YES
257 HAVE_DOT               = YES
258 CLASS_GRAPH            = YES
259 COLLABORATION_GRAPH    = YES
260 GROUP_GRAPHS           = YES
261 UML_LOOK               = NO
262 TEMPLATE_RELATIONS     = NO
263 INCLUDE_GRAPH          = YES
264 INCLUDED_BY_GRAPH      = YES
265 CALL_GRAPH             = YES
266 CALLER_GRAPH           = YES
267 GRAPHICAL_HIERARCHY    = YES
268 DIRECTORY_GRAPH        = YES
269 DOT_IMAGE_FORMAT       = png
270 DOT_PATH               = 
271 DOTFILE_DIRS           = 
272 DOT_GRAPH_MAX_NODES    = 50
273 MAX_DOT_GRAPH_DEPTH    = 1000
274 DOT_TRANSPARENT        = NO
275 DOT_MULTI_TARGETS      = NO
276 GENERATE_LEGEND        = YES
277 DOT_CLEANUP            = YES
278 #---------------------------------------------------------------------------
279 # Configuration::additions related to the search engine   
280 #---------------------------------------------------------------------------
281 SEARCHENGINE           = NO