libusb 0.2.2 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (101) hide show
  1. data/.gitignore +8 -0
  2. data/.travis.yml +10 -0
  3. data/.yardopts +6 -1
  4. data/Gemfile +16 -0
  5. data/{History.txt → History.md} +28 -16
  6. data/README.md +144 -0
  7. data/Rakefile +28 -24
  8. data/ext/extconf.rb +33 -0
  9. data/ext/libusbx-1.0.14/AUTHORS +50 -0
  10. data/ext/libusbx-1.0.14/COPYING +504 -0
  11. data/ext/libusbx-1.0.14/ChangeLog +139 -0
  12. data/ext/libusbx-1.0.14/INSTALL +234 -0
  13. data/ext/libusbx-1.0.14/Makefile.am +23 -0
  14. data/ext/libusbx-1.0.14/Makefile.in +803 -0
  15. data/ext/libusbx-1.0.14/NEWS +2 -0
  16. data/ext/libusbx-1.0.14/PORTING +94 -0
  17. data/ext/libusbx-1.0.14/README +28 -0
  18. data/ext/libusbx-1.0.14/THANKS +7 -0
  19. data/ext/libusbx-1.0.14/TODO +2 -0
  20. data/ext/libusbx-1.0.14/aclocal.m4 +9480 -0
  21. data/ext/libusbx-1.0.14/compile +143 -0
  22. data/ext/libusbx-1.0.14/config.guess +1501 -0
  23. data/ext/libusbx-1.0.14/config.h.in +116 -0
  24. data/ext/libusbx-1.0.14/config.sub +1705 -0
  25. data/ext/libusbx-1.0.14/configure +14818 -0
  26. data/ext/libusbx-1.0.14/configure.ac +230 -0
  27. data/ext/libusbx-1.0.14/depcomp +630 -0
  28. data/ext/libusbx-1.0.14/doc/Makefile.am +9 -0
  29. data/ext/libusbx-1.0.14/doc/Makefile.in +380 -0
  30. data/ext/libusbx-1.0.14/doc/doxygen.cfg.in +1288 -0
  31. data/ext/libusbx-1.0.14/examples/Makefile.am +18 -0
  32. data/ext/libusbx-1.0.14/examples/Makefile.in +596 -0
  33. data/ext/libusbx-1.0.14/examples/dpfp.c +506 -0
  34. data/ext/libusbx-1.0.14/examples/dpfp_threaded.c +544 -0
  35. data/ext/libusbx-1.0.14/examples/ezusb.c +616 -0
  36. data/ext/libusbx-1.0.14/examples/ezusb.h +107 -0
  37. data/ext/libusbx-1.0.14/examples/fxload.c +261 -0
  38. data/ext/libusbx-1.0.14/examples/getopt/getopt.c +1060 -0
  39. data/ext/libusbx-1.0.14/examples/getopt/getopt.h +180 -0
  40. data/ext/libusbx-1.0.14/examples/getopt/getopt1.c +188 -0
  41. data/ext/libusbx-1.0.14/examples/listdevs.c +63 -0
  42. data/ext/libusbx-1.0.14/examples/xusb.c +1036 -0
  43. data/ext/libusbx-1.0.14/install-sh +520 -0
  44. data/ext/libusbx-1.0.14/libusb-1.0.pc.in +11 -0
  45. data/ext/libusbx-1.0.14/libusb/Makefile.am +56 -0
  46. data/ext/libusbx-1.0.14/libusb/Makefile.in +721 -0
  47. data/ext/libusbx-1.0.14/libusb/core.c +1951 -0
  48. data/ext/libusbx-1.0.14/libusb/descriptor.c +731 -0
  49. data/ext/libusbx-1.0.14/libusb/io.c +2450 -0
  50. data/ext/libusbx-1.0.14/libusb/libusb-1.0.def +126 -0
  51. data/ext/libusbx-1.0.14/libusb/libusb-1.0.rc +59 -0
  52. data/ext/libusbx-1.0.14/libusb/libusb.h +1506 -0
  53. data/ext/libusbx-1.0.14/libusb/libusbi.h +910 -0
  54. data/ext/libusbx-1.0.14/libusb/os/darwin_usb.c +1807 -0
  55. data/ext/libusbx-1.0.14/libusb/os/darwin_usb.h +169 -0
  56. data/ext/libusbx-1.0.14/libusb/os/linux_usbfs.c +2569 -0
  57. data/ext/libusbx-1.0.14/libusb/os/linux_usbfs.h +149 -0
  58. data/ext/libusbx-1.0.14/libusb/os/openbsd_usb.c +727 -0
  59. data/ext/libusbx-1.0.14/libusb/os/poll_posix.h +10 -0
  60. data/ext/libusbx-1.0.14/libusb/os/poll_windows.c +747 -0
  61. data/ext/libusbx-1.0.14/libusb/os/poll_windows.h +114 -0
  62. data/ext/libusbx-1.0.14/libusb/os/threads_posix.c +80 -0
  63. data/ext/libusbx-1.0.14/libusb/os/threads_posix.h +50 -0
  64. data/ext/libusbx-1.0.14/libusb/os/threads_windows.c +211 -0
  65. data/ext/libusbx-1.0.14/libusb/os/threads_windows.h +87 -0
  66. data/ext/libusbx-1.0.14/libusb/os/windows_usb.c +4369 -0
  67. data/ext/libusbx-1.0.14/libusb/os/windows_usb.h +979 -0
  68. data/ext/libusbx-1.0.14/libusb/sync.c +321 -0
  69. data/ext/libusbx-1.0.14/libusb/version.h +18 -0
  70. data/ext/libusbx-1.0.14/libusb/version_nano.h +1 -0
  71. data/ext/libusbx-1.0.14/ltmain.sh +9636 -0
  72. data/ext/libusbx-1.0.14/missing +376 -0
  73. data/lib/libusb.rb +2 -3
  74. data/lib/libusb/call.rb +49 -7
  75. data/lib/libusb/compat.rb +15 -9
  76. data/lib/libusb/configuration.rb +15 -3
  77. data/lib/libusb/constants.rb +19 -6
  78. data/lib/libusb/context.rb +181 -3
  79. data/lib/libusb/dev_handle.rb +91 -40
  80. data/lib/libusb/endpoint.rb +41 -14
  81. data/lib/libusb/eventmachine.rb +183 -0
  82. data/lib/libusb/transfer.rb +21 -8
  83. data/lib/libusb/version_gem.rb +19 -0
  84. data/lib/libusb/{version.rb → version_struct.rb} +0 -0
  85. data/libusb.gemspec +31 -0
  86. data/test/test_libusb_compat.rb +1 -1
  87. data/test/test_libusb_compat_mass_storage.rb +2 -2
  88. data/test/test_libusb_descriptors.rb +1 -1
  89. data/test/test_libusb_event_machine.rb +118 -0
  90. data/test/test_libusb_iso_transfer.rb +6 -1
  91. data/test/test_libusb_mass_storage.rb +9 -3
  92. data/test/test_libusb_mass_storage2.rb +1 -1
  93. data/test/test_libusb_structs.rb +45 -0
  94. data/test/test_libusb_threads.rb +89 -0
  95. data/test/test_libusb_version.rb +4 -0
  96. metadata +109 -44
  97. data/.autotest +0 -23
  98. data/.gemtest +0 -0
  99. data/Manifest.txt +0 -3
  100. data/README.rdoc +0 -115
  101. data/test/test_libusb_keyboard.rb +0 -50
@@ -0,0 +1,9 @@
1
+ EXTRA_DIST = doxygen.cfg.in
2
+
3
+ docs: doxygen.cfg
4
+ doxygen $^
5
+
6
+ docs-upload: docs
7
+ ln -s html api-1.0
8
+ scp -r api-1.0 pbatard@web.sourceforge.net:/home/project-web/libusbx/htdocs
9
+ rm -f api-1.0
@@ -0,0 +1,380 @@
1
+ # Makefile.in generated by automake 1.11.1 from Makefile.am.
2
+ # @configure_input@
3
+
4
+ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
5
+ # 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation,
6
+ # Inc.
7
+ # This Makefile.in is free software; the Free Software Foundation
8
+ # gives unlimited permission to copy and/or distribute it,
9
+ # with or without modifications, as long as this notice is preserved.
10
+
11
+ # This program is distributed in the hope that it will be useful,
12
+ # but WITHOUT ANY WARRANTY, to the extent permitted by law; without
13
+ # even the implied warranty of MERCHANTABILITY or FITNESS FOR A
14
+ # PARTICULAR PURPOSE.
15
+
16
+ @SET_MAKE@
17
+ VPATH = @srcdir@
18
+ pkgdatadir = $(datadir)/@PACKAGE@
19
+ pkgincludedir = $(includedir)/@PACKAGE@
20
+ pkglibdir = $(libdir)/@PACKAGE@
21
+ pkglibexecdir = $(libexecdir)/@PACKAGE@
22
+ am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd
23
+ install_sh_DATA = $(install_sh) -c -m 644
24
+ install_sh_PROGRAM = $(install_sh) -c
25
+ install_sh_SCRIPT = $(install_sh) -c
26
+ INSTALL_HEADER = $(INSTALL_DATA)
27
+ transform = $(program_transform_name)
28
+ NORMAL_INSTALL = :
29
+ PRE_INSTALL = :
30
+ POST_INSTALL = :
31
+ NORMAL_UNINSTALL = :
32
+ PRE_UNINSTALL = :
33
+ POST_UNINSTALL = :
34
+ build_triplet = @build@
35
+ host_triplet = @host@
36
+ subdir = doc
37
+ DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \
38
+ $(srcdir)/doxygen.cfg.in
39
+ ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
40
+ am__aclocal_m4_deps = $(top_srcdir)/libusb/version.h \
41
+ $(top_srcdir)/configure.ac
42
+ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
43
+ $(ACLOCAL_M4)
44
+ mkinstalldirs = $(install_sh) -d
45
+ CONFIG_HEADER = $(top_builddir)/config.h
46
+ CONFIG_CLEAN_FILES = doxygen.cfg
47
+ CONFIG_CLEAN_VPATH_FILES =
48
+ AM_V_GEN = $(am__v_GEN_$(V))
49
+ am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY))
50
+ am__v_GEN_0 = @echo " GEN " $@;
51
+ AM_V_at = $(am__v_at_$(V))
52
+ am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY))
53
+ am__v_at_0 = @
54
+ SOURCES =
55
+ DIST_SOURCES =
56
+ DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
57
+ ACLOCAL = @ACLOCAL@
58
+ AMTAR = @AMTAR@
59
+ AM_CFLAGS = @AM_CFLAGS@
60
+ AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@
61
+ AR = @AR@
62
+ AUTOCONF = @AUTOCONF@
63
+ AUTOHEADER = @AUTOHEADER@
64
+ AUTOMAKE = @AUTOMAKE@
65
+ AWK = @AWK@
66
+ CC = @CC@
67
+ CCDEPMODE = @CCDEPMODE@
68
+ CFLAGS = @CFLAGS@
69
+ CPP = @CPP@
70
+ CPPFLAGS = @CPPFLAGS@
71
+ CYGPATH_W = @CYGPATH_W@
72
+ DEFS = @DEFS@
73
+ DEPDIR = @DEPDIR@
74
+ DLLTOOL = @DLLTOOL@
75
+ DSYMUTIL = @DSYMUTIL@
76
+ DUMPBIN = @DUMPBIN@
77
+ ECHO_C = @ECHO_C@
78
+ ECHO_N = @ECHO_N@
79
+ ECHO_T = @ECHO_T@
80
+ EGREP = @EGREP@
81
+ EXEEXT = @EXEEXT@
82
+ FGREP = @FGREP@
83
+ GREP = @GREP@
84
+ INSTALL = @INSTALL@
85
+ INSTALL_DATA = @INSTALL_DATA@
86
+ INSTALL_PROGRAM = @INSTALL_PROGRAM@
87
+ INSTALL_SCRIPT = @INSTALL_SCRIPT@
88
+ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
89
+ LD = @LD@
90
+ LDFLAGS = @LDFLAGS@
91
+ LIBOBJS = @LIBOBJS@
92
+ LIBS = @LIBS@
93
+ LIBTOOL = @LIBTOOL@
94
+ LIPO = @LIPO@
95
+ LN_S = @LN_S@
96
+ LTLDFLAGS = @LTLDFLAGS@
97
+ LTLIBOBJS = @LTLIBOBJS@
98
+ MAINT = @MAINT@
99
+ MAKEINFO = @MAKEINFO@
100
+ MANIFEST_TOOL = @MANIFEST_TOOL@
101
+ MKDIR_P = @MKDIR_P@
102
+ NM = @NM@
103
+ NMEDIT = @NMEDIT@
104
+ OBJDUMP = @OBJDUMP@
105
+ OBJEXT = @OBJEXT@
106
+ OS_DARWIN = @OS_DARWIN@
107
+ OS_LINUX = @OS_LINUX@
108
+ OS_OPENBSD = @OS_OPENBSD@
109
+ OS_WINDOWS = @OS_WINDOWS@
110
+ OTOOL = @OTOOL@
111
+ OTOOL64 = @OTOOL64@
112
+ PACKAGE = @PACKAGE@
113
+ PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@
114
+ PACKAGE_NAME = @PACKAGE_NAME@
115
+ PACKAGE_STRING = @PACKAGE_STRING@
116
+ PACKAGE_TARNAME = @PACKAGE_TARNAME@
117
+ PACKAGE_URL = @PACKAGE_URL@
118
+ PACKAGE_VERSION = @PACKAGE_VERSION@
119
+ PATH_SEPARATOR = @PATH_SEPARATOR@
120
+ PC_LIBS_PRIVATE = @PC_LIBS_PRIVATE@
121
+ RANLIB = @RANLIB@
122
+ RC = @RC@
123
+ SED = @SED@
124
+ SET_MAKE = @SET_MAKE@
125
+ SHELL = @SHELL@
126
+ STRIP = @STRIP@
127
+ THREAD_CFLAGS = @THREAD_CFLAGS@
128
+ VERSION = @VERSION@
129
+ VISIBILITY_CFLAGS = @VISIBILITY_CFLAGS@
130
+ abs_builddir = @abs_builddir@
131
+ abs_srcdir = @abs_srcdir@
132
+ abs_top_builddir = @abs_top_builddir@
133
+ abs_top_srcdir = @abs_top_srcdir@
134
+ ac_ct_AR = @ac_ct_AR@
135
+ ac_ct_CC = @ac_ct_CC@
136
+ ac_ct_DUMPBIN = @ac_ct_DUMPBIN@
137
+ am__include = @am__include@
138
+ am__leading_dot = @am__leading_dot@
139
+ am__quote = @am__quote@
140
+ am__tar = @am__tar@
141
+ am__untar = @am__untar@
142
+ bindir = @bindir@
143
+ build = @build@
144
+ build_alias = @build_alias@
145
+ build_cpu = @build_cpu@
146
+ build_os = @build_os@
147
+ build_vendor = @build_vendor@
148
+ builddir = @builddir@
149
+ datadir = @datadir@
150
+ datarootdir = @datarootdir@
151
+ docdir = @docdir@
152
+ dvidir = @dvidir@
153
+ exec_prefix = @exec_prefix@
154
+ host = @host@
155
+ host_alias = @host_alias@
156
+ host_cpu = @host_cpu@
157
+ host_os = @host_os@
158
+ host_vendor = @host_vendor@
159
+ htmldir = @htmldir@
160
+ includedir = @includedir@
161
+ infodir = @infodir@
162
+ install_sh = @install_sh@
163
+ libdir = @libdir@
164
+ libexecdir = @libexecdir@
165
+ localedir = @localedir@
166
+ localstatedir = @localstatedir@
167
+ mandir = @mandir@
168
+ mkdir_p = @mkdir_p@
169
+ oldincludedir = @oldincludedir@
170
+ pdfdir = @pdfdir@
171
+ prefix = @prefix@
172
+ program_transform_name = @program_transform_name@
173
+ psdir = @psdir@
174
+ sbindir = @sbindir@
175
+ sharedstatedir = @sharedstatedir@
176
+ srcdir = @srcdir@
177
+ sysconfdir = @sysconfdir@
178
+ target_alias = @target_alias@
179
+ top_build_prefix = @top_build_prefix@
180
+ top_builddir = @top_builddir@
181
+ top_srcdir = @top_srcdir@
182
+ EXTRA_DIST = doxygen.cfg.in
183
+ all: all-am
184
+
185
+ .SUFFIXES:
186
+ $(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps)
187
+ @for dep in $?; do \
188
+ case '$(am__configure_deps)' in \
189
+ *$$dep*) \
190
+ ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \
191
+ && { if test -f $@; then exit 0; else break; fi; }; \
192
+ exit 1;; \
193
+ esac; \
194
+ done; \
195
+ echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \
196
+ $(am__cd) $(top_srcdir) && \
197
+ $(AUTOMAKE) --gnu doc/Makefile
198
+ .PRECIOUS: Makefile
199
+ Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
200
+ @case '$?' in \
201
+ *config.status*) \
202
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \
203
+ *) \
204
+ echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \
205
+ cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \
206
+ esac;
207
+
208
+ $(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES)
209
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
210
+
211
+ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps)
212
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
213
+ $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps)
214
+ cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
215
+ $(am__aclocal_m4_deps):
216
+ doxygen.cfg: $(top_builddir)/config.status $(srcdir)/doxygen.cfg.in
217
+ cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@
218
+
219
+ mostlyclean-libtool:
220
+ -rm -f *.lo
221
+
222
+ clean-libtool:
223
+ -rm -rf .libs _libs
224
+ tags: TAGS
225
+ TAGS:
226
+
227
+ ctags: CTAGS
228
+ CTAGS:
229
+
230
+
231
+ distdir: $(DISTFILES)
232
+ @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \
233
+ topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \
234
+ list='$(DISTFILES)'; \
235
+ dist_files=`for file in $$list; do echo $$file; done | \
236
+ sed -e "s|^$$srcdirstrip/||;t" \
237
+ -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \
238
+ case $$dist_files in \
239
+ */*) $(MKDIR_P) `echo "$$dist_files" | \
240
+ sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \
241
+ sort -u` ;; \
242
+ esac; \
243
+ for file in $$dist_files; do \
244
+ if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \
245
+ if test -d $$d/$$file; then \
246
+ dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \
247
+ if test -d "$(distdir)/$$file"; then \
248
+ find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \
249
+ fi; \
250
+ if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \
251
+ cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \
252
+ find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \
253
+ fi; \
254
+ cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \
255
+ else \
256
+ test -f "$(distdir)/$$file" \
257
+ || cp -p $$d/$$file "$(distdir)/$$file" \
258
+ || exit 1; \
259
+ fi; \
260
+ done
261
+ check-am: all-am
262
+ check: check-am
263
+ all-am: Makefile
264
+ installdirs:
265
+ install: install-am
266
+ install-exec: install-exec-am
267
+ install-data: install-data-am
268
+ uninstall: uninstall-am
269
+
270
+ install-am: all-am
271
+ @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
272
+
273
+ installcheck: installcheck-am
274
+ install-strip:
275
+ $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
276
+ install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
277
+ `test -z '$(STRIP)' || \
278
+ echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
279
+ mostlyclean-generic:
280
+
281
+ clean-generic:
282
+
283
+ distclean-generic:
284
+ -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
285
+ -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES)
286
+
287
+ maintainer-clean-generic:
288
+ @echo "This command is intended for maintainers to use"
289
+ @echo "it deletes files that may require special tools to rebuild."
290
+ clean: clean-am
291
+
292
+ clean-am: clean-generic clean-libtool mostlyclean-am
293
+
294
+ distclean: distclean-am
295
+ -rm -f Makefile
296
+ distclean-am: clean-am distclean-generic
297
+
298
+ dvi: dvi-am
299
+
300
+ dvi-am:
301
+
302
+ html: html-am
303
+
304
+ html-am:
305
+
306
+ info: info-am
307
+
308
+ info-am:
309
+
310
+ install-data-am:
311
+
312
+ install-dvi: install-dvi-am
313
+
314
+ install-dvi-am:
315
+
316
+ install-exec-am:
317
+
318
+ install-html: install-html-am
319
+
320
+ install-html-am:
321
+
322
+ install-info: install-info-am
323
+
324
+ install-info-am:
325
+
326
+ install-man:
327
+
328
+ install-pdf: install-pdf-am
329
+
330
+ install-pdf-am:
331
+
332
+ install-ps: install-ps-am
333
+
334
+ install-ps-am:
335
+
336
+ installcheck-am:
337
+
338
+ maintainer-clean: maintainer-clean-am
339
+ -rm -f Makefile
340
+ maintainer-clean-am: distclean-am maintainer-clean-generic
341
+
342
+ mostlyclean: mostlyclean-am
343
+
344
+ mostlyclean-am: mostlyclean-generic mostlyclean-libtool
345
+
346
+ pdf: pdf-am
347
+
348
+ pdf-am:
349
+
350
+ ps: ps-am
351
+
352
+ ps-am:
353
+
354
+ uninstall-am:
355
+
356
+ .MAKE: install-am install-strip
357
+
358
+ .PHONY: all all-am check check-am clean clean-generic clean-libtool \
359
+ distclean distclean-generic distclean-libtool distdir dvi \
360
+ dvi-am html html-am info info-am install install-am \
361
+ install-data install-data-am install-dvi install-dvi-am \
362
+ install-exec install-exec-am install-html install-html-am \
363
+ install-info install-info-am install-man install-pdf \
364
+ install-pdf-am install-ps install-ps-am install-strip \
365
+ installcheck installcheck-am installdirs maintainer-clean \
366
+ maintainer-clean-generic mostlyclean mostlyclean-generic \
367
+ mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am
368
+
369
+
370
+ docs: doxygen.cfg
371
+ doxygen $^
372
+
373
+ docs-upload: docs
374
+ ln -s html api-1.0
375
+ scp -r api-1.0 pbatard@web.sourceforge.net:/home/project-web/libusbx/htdocs
376
+ rm -f api-1.0
377
+
378
+ # Tell versions [3.59,3.63) of GNU make to not export all variables.
379
+ # Otherwise a system limit (for SysV at least) may be exceeded.
380
+ .NOEXPORT:
@@ -0,0 +1,1288 @@
1
+ # Doxyfile 1.5.3
2
+
3
+ # This file describes the settings to be used by the documentation system
4
+ # doxygen (www.doxygen.org) for a project
5
+ #
6
+ # All text after a hash (#) is considered a comment and will be ignored
7
+ # The format is:
8
+ # TAG = value [value, ...]
9
+ # For lists items can also be appended using:
10
+ # TAG += value [value, ...]
11
+ # Values that contain spaces should be placed between quotes (" ")
12
+
13
+ #---------------------------------------------------------------------------
14
+ # Project related configuration options
15
+ #---------------------------------------------------------------------------
16
+
17
+ # This tag specifies the encoding used for all characters in the config file that
18
+ # follow. The default is UTF-8 which is also the encoding used for all text before
19
+ # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20
+ # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
21
+ # possible encodings.
22
+
23
+ DOXYFILE_ENCODING = UTF-8
24
+
25
+ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
+ # by quotes) that should identify the project.
27
+
28
+ PROJECT_NAME =
29
+
30
+ # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31
+ # This could be handy for archiving the generated documentation or
32
+ # if some version control system is used.
33
+
34
+ PROJECT_NUMBER =
35
+
36
+ # Using the PROJECT_BRIEF tag one can provide an optional one line description
37
+ # for a project that appears at the top of each page and should give viewer a
38
+ # quick idea about the purpose of the project. Keep the description short.
39
+
40
+ PROJECT_BRIEF = "eXpand your USB potential"
41
+
42
+ # With the PROJECT_LOGO tag one can specify an logo or icon that is included
43
+ # in the documentation. The maximum height of the logo should not exceed 55
44
+ # pixels and the maximum width should not exceed 200 pixels. Doxygen will
45
+ # copy the logo to the output directory.
46
+
47
+ PROJECT_LOGO = libusbx.png
48
+
49
+ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
50
+ # base path where the generated documentation will be put.
51
+ # If a relative path is entered, it will be relative to the location
52
+ # where doxygen was started. If left blank the current directory will be used.
53
+
54
+ OUTPUT_DIRECTORY =
55
+
56
+ # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
57
+ # 4096 sub-directories (in 2 levels) under the output directory of each output
58
+ # format and will distribute the generated files over these directories.
59
+ # Enabling this option can be useful when feeding doxygen a huge amount of
60
+ # source files, where putting all generated files in the same directory would
61
+ # otherwise cause performance problems for the file system.
62
+
63
+ CREATE_SUBDIRS = NO
64
+
65
+ # The OUTPUT_LANGUAGE tag is used to specify the language in which all
66
+ # documentation generated by doxygen is written. Doxygen will use this
67
+ # information to generate all constant output in the proper language.
68
+ # The default language is English, other supported languages are:
69
+ # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
70
+ # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
71
+ # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
72
+ # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
73
+ # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
74
+
75
+ OUTPUT_LANGUAGE = English
76
+
77
+ # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
78
+ # include brief member descriptions after the members that are listed in
79
+ # the file and class documentation (similar to JavaDoc).
80
+ # Set to NO to disable this.
81
+
82
+ BRIEF_MEMBER_DESC = YES
83
+
84
+ # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
85
+ # the brief description of a member or function before the detailed description.
86
+ # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
87
+ # brief descriptions will be completely suppressed.
88
+
89
+ REPEAT_BRIEF = YES
90
+
91
+ # This tag implements a quasi-intelligent brief description abbreviator
92
+ # that is used to form the text in various listings. Each string
93
+ # in this list, if found as the leading text of the brief description, will be
94
+ # stripped from the text and the result after processing the whole list, is
95
+ # used as the annotated text. Otherwise, the brief description is used as-is.
96
+ # If left blank, the following values are used ("$name" is automatically
97
+ # replaced with the name of the entity): "The $name class" "The $name widget"
98
+ # "The $name file" "is" "provides" "specifies" "contains"
99
+ # "represents" "a" "an" "the"
100
+
101
+ ABBREVIATE_BRIEF =
102
+
103
+ # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
104
+ # Doxygen will generate a detailed section even if there is only a brief
105
+ # description.
106
+
107
+ ALWAYS_DETAILED_SEC = NO
108
+
109
+ # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
110
+ # inherited members of a class in the documentation of that class as if those
111
+ # members were ordinary class members. Constructors, destructors and assignment
112
+ # operators of the base classes will not be shown.
113
+
114
+ INLINE_INHERITED_MEMB = NO
115
+
116
+ # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
117
+ # path before files name in the file list and in the header files. If set
118
+ # to NO the shortest path that makes the file name unique will be used.
119
+
120
+ FULL_PATH_NAMES = NO
121
+
122
+ # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
123
+ # can be used to strip a user-defined part of the path. Stripping is
124
+ # only done if one of the specified strings matches the left-hand part of
125
+ # the path. The tag can be used to show relative paths in the file list.
126
+ # If left blank the directory from which doxygen is run is used as the
127
+ # path to strip.
128
+
129
+ STRIP_FROM_PATH =
130
+
131
+ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
132
+ # the path mentioned in the documentation of a class, which tells
133
+ # the reader which header file to include in order to use a class.
134
+ # If left blank only the name of the header file containing the class
135
+ # definition is used. Otherwise one should specify the include paths that
136
+ # are normally passed to the compiler using the -I flag.
137
+
138
+ STRIP_FROM_INC_PATH =
139
+
140
+ # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
141
+ # (but less readable) file names. This can be useful is your file systems
142
+ # doesn't support long names like on DOS, Mac, or CD-ROM.
143
+
144
+ SHORT_NAMES = NO
145
+
146
+ # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
147
+ # will interpret the first line (until the first dot) of a JavaDoc-style
148
+ # comment as the brief description. If set to NO, the JavaDoc
149
+ # comments will behave just like regular Qt-style comments
150
+ # (thus requiring an explicit @brief command for a brief description.)
151
+
152
+ JAVADOC_AUTOBRIEF = YES
153
+
154
+ # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
155
+ # interpret the first line (until the first dot) of a Qt-style
156
+ # comment as the brief description. If set to NO, the comments
157
+ # will behave just like regular Qt-style comments (thus requiring
158
+ # an explicit \brief command for a brief description.)
159
+
160
+ QT_AUTOBRIEF = NO
161
+
162
+ # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
163
+ # treat a multi-line C++ special comment block (i.e. a block of //! or ///
164
+ # comments) as a brief description. This used to be the default behaviour.
165
+ # The new default is to treat a multi-line C++ comment block as a detailed
166
+ # description. Set this tag to YES if you prefer the old behaviour instead.
167
+
168
+ MULTILINE_CPP_IS_BRIEF = NO
169
+
170
+ # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
171
+ # member inherits the documentation from any documented member that it
172
+ # re-implements.
173
+
174
+ INHERIT_DOCS = YES
175
+
176
+ # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
177
+ # a new page for each member. If set to NO, the documentation of a member will
178
+ # be part of the file/class/namespace that contains it.
179
+
180
+ SEPARATE_MEMBER_PAGES = NO
181
+
182
+ # The TAB_SIZE tag can be used to set the number of spaces in a tab.
183
+ # Doxygen uses this value to replace tabs by spaces in code fragments.
184
+
185
+ TAB_SIZE = 4
186
+
187
+ # This tag can be used to specify a number of aliases that acts
188
+ # as commands in the documentation. An alias has the form "name=value".
189
+ # For example adding "sideeffect=\par Side Effects:\n" will allow you to
190
+ # put the command \sideeffect (or @sideeffect) in the documentation, which
191
+ # will result in a user-defined paragraph with heading "Side Effects:".
192
+ # You can put \n's in the value part of an alias to insert newlines.
193
+
194
+ ALIASES =
195
+
196
+ # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
197
+ # sources only. Doxygen will then generate output that is more tailored for C.
198
+ # For instance, some of the names that are used will be different. The list
199
+ # of all members will be omitted, etc.
200
+
201
+ OPTIMIZE_OUTPUT_FOR_C = YES
202
+
203
+ # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
204
+ # sources only. Doxygen will then generate output that is more tailored for Java.
205
+ # For instance, namespaces will be presented as packages, qualified scopes
206
+ # will look different, etc.
207
+
208
+ OPTIMIZE_OUTPUT_JAVA = NO
209
+
210
+ # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
211
+ # include (a tag file for) the STL sources as input, then you should
212
+ # set this tag to YES in order to let doxygen match functions declarations and
213
+ # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
214
+ # func(std::string) {}). This also make the inheritance and collaboration
215
+ # diagrams that involve STL classes more complete and accurate.
216
+
217
+ BUILTIN_STL_SUPPORT = NO
218
+
219
+ # If you use Microsoft's C++/CLI language, you should set this option to YES to
220
+ # enable parsing support.
221
+
222
+ CPP_CLI_SUPPORT = NO
223
+
224
+ # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
225
+ # tag is set to YES, then doxygen will reuse the documentation of the first
226
+ # member in the group (if any) for the other members of the group. By default
227
+ # all members of a group must be documented explicitly.
228
+
229
+ DISTRIBUTE_GROUP_DOC = NO
230
+
231
+ # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
232
+ # the same type (for instance a group of public functions) to be put as a
233
+ # subgroup of that type (e.g. under the Public Functions section). Set it to
234
+ # NO to prevent subgrouping. Alternatively, this can be done per class using
235
+ # the \nosubgrouping command.
236
+
237
+ SUBGROUPING = YES
238
+
239
+ #---------------------------------------------------------------------------
240
+ # Build related configuration options
241
+ #---------------------------------------------------------------------------
242
+
243
+ # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
244
+ # documentation are documented, even if no documentation was available.
245
+ # Private class members and static file members will be hidden unless
246
+ # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
247
+
248
+ EXTRACT_ALL = NO
249
+
250
+ # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
251
+ # will be included in the documentation.
252
+
253
+ EXTRACT_PRIVATE = NO
254
+
255
+ # If the EXTRACT_STATIC tag is set to YES all static members of a file
256
+ # will be included in the documentation.
257
+
258
+ EXTRACT_STATIC = YES
259
+
260
+ # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
261
+ # defined locally in source files will be included in the documentation.
262
+ # If set to NO only classes defined in header files are included.
263
+
264
+ EXTRACT_LOCAL_CLASSES = YES
265
+
266
+ # This flag is only useful for Objective-C code. When set to YES local
267
+ # methods, which are defined in the implementation section but not in
268
+ # the interface are included in the documentation.
269
+ # If set to NO (the default) only methods in the interface are included.
270
+
271
+ EXTRACT_LOCAL_METHODS = NO
272
+
273
+ # If this flag is set to YES, the members of anonymous namespaces will be extracted
274
+ # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
275
+ # where file will be replaced with the base name of the file that contains the anonymous
276
+ # namespace. By default anonymous namespace are hidden.
277
+
278
+ EXTRACT_ANON_NSPACES = NO
279
+
280
+ # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
281
+ # undocumented members of documented classes, files or namespaces.
282
+ # If set to NO (the default) these members will be included in the
283
+ # various overviews, but no documentation section is generated.
284
+ # This option has no effect if EXTRACT_ALL is enabled.
285
+
286
+ HIDE_UNDOC_MEMBERS = NO
287
+
288
+ # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
289
+ # undocumented classes that are normally visible in the class hierarchy.
290
+ # If set to NO (the default) these classes will be included in the various
291
+ # overviews. This option has no effect if EXTRACT_ALL is enabled.
292
+
293
+ HIDE_UNDOC_CLASSES = NO
294
+
295
+ # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
296
+ # friend (class|struct|union) declarations.
297
+ # If set to NO (the default) these declarations will be included in the
298
+ # documentation.
299
+
300
+ HIDE_FRIEND_COMPOUNDS = NO
301
+
302
+ # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
303
+ # documentation blocks found inside the body of a function.
304
+ # If set to NO (the default) these blocks will be appended to the
305
+ # function's detailed documentation block.
306
+
307
+ HIDE_IN_BODY_DOCS = NO
308
+
309
+ # The INTERNAL_DOCS tag determines if documentation
310
+ # that is typed after a \internal command is included. If the tag is set
311
+ # to NO (the default) then the documentation will be excluded.
312
+ # Set it to YES to include the internal documentation.
313
+
314
+ INTERNAL_DOCS = NO
315
+
316
+ # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
317
+ # file names in lower-case letters. If set to YES upper-case letters are also
318
+ # allowed. This is useful if you have classes or files whose names only differ
319
+ # in case and if your file system supports case sensitive file names. Windows
320
+ # and Mac users are advised to set this option to NO.
321
+
322
+ CASE_SENSE_NAMES = YES
323
+
324
+ # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
325
+ # will show members with their full class and namespace scopes in the
326
+ # documentation. If set to YES the scope will be hidden.
327
+
328
+ HIDE_SCOPE_NAMES = NO
329
+
330
+ # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
331
+ # will put a list of the files that are included by a file in the documentation
332
+ # of that file.
333
+
334
+ SHOW_INCLUDE_FILES = YES
335
+
336
+ # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
337
+ # is inserted in the documentation for inline members.
338
+
339
+ INLINE_INFO = YES
340
+
341
+ # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
342
+ # will sort the (detailed) documentation of file and class members
343
+ # alphabetically by member name. If set to NO the members will appear in
344
+ # declaration order.
345
+
346
+ SORT_MEMBER_DOCS = NO
347
+
348
+ # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
349
+ # brief documentation of file, namespace and class members alphabetically
350
+ # by member name. If set to NO (the default) the members will appear in
351
+ # declaration order.
352
+
353
+ SORT_BRIEF_DOCS = NO
354
+
355
+ # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
356
+ # sorted by fully-qualified names, including namespaces. If set to
357
+ # NO (the default), the class list will be sorted only by class name,
358
+ # not including the namespace part.
359
+ # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
360
+ # Note: This option applies only to the class list, not to the
361
+ # alphabetical list.
362
+
363
+ SORT_BY_SCOPE_NAME = NO
364
+
365
+ # The GENERATE_TODOLIST tag can be used to enable (YES) or
366
+ # disable (NO) the todo list. This list is created by putting \todo
367
+ # commands in the documentation.
368
+
369
+ GENERATE_TODOLIST = YES
370
+
371
+ # The GENERATE_TESTLIST tag can be used to enable (YES) or
372
+ # disable (NO) the test list. This list is created by putting \test
373
+ # commands in the documentation.
374
+
375
+ GENERATE_TESTLIST = YES
376
+
377
+ # The GENERATE_BUGLIST tag can be used to enable (YES) or
378
+ # disable (NO) the bug list. This list is created by putting \bug
379
+ # commands in the documentation.
380
+
381
+ GENERATE_BUGLIST = YES
382
+
383
+ # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
384
+ # disable (NO) the deprecated list. This list is created by putting
385
+ # \deprecated commands in the documentation.
386
+
387
+ GENERATE_DEPRECATEDLIST= YES
388
+
389
+ # The ENABLED_SECTIONS tag can be used to enable conditional
390
+ # documentation sections, marked by \if sectionname ... \endif.
391
+
392
+ ENABLED_SECTIONS =
393
+
394
+ # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
395
+ # the initial value of a variable or define consists of for it to appear in
396
+ # the documentation. If the initializer consists of more lines than specified
397
+ # here it will be hidden. Use a value of 0 to hide initializers completely.
398
+ # The appearance of the initializer of individual variables and defines in the
399
+ # documentation can be controlled using \showinitializer or \hideinitializer
400
+ # command in the documentation regardless of this setting.
401
+
402
+ MAX_INITIALIZER_LINES = 30
403
+
404
+ # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
405
+ # at the bottom of the documentation of classes and structs. If set to YES the
406
+ # list will mention the files that were used to generate the documentation.
407
+
408
+ SHOW_USED_FILES = YES
409
+
410
+ # The FILE_VERSION_FILTER tag can be used to specify a program or script that
411
+ # doxygen should invoke to get the current version for each file (typically from the
412
+ # version control system). Doxygen will invoke the program by executing (via
413
+ # popen()) the command <command> <input-file>, where <command> is the value of
414
+ # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
415
+ # provided by doxygen. Whatever the program writes to standard output
416
+ # is used as the file version. See the manual for examples.
417
+
418
+ FILE_VERSION_FILTER =
419
+
420
+ #---------------------------------------------------------------------------
421
+ # configuration options related to warning and progress messages
422
+ #---------------------------------------------------------------------------
423
+
424
+ # The QUIET tag can be used to turn on/off the messages that are generated
425
+ # by doxygen. Possible values are YES and NO. If left blank NO is used.
426
+
427
+ QUIET = YES
428
+
429
+ # The WARNINGS tag can be used to turn on/off the warning messages that are
430
+ # generated by doxygen. Possible values are YES and NO. If left blank
431
+ # NO is used.
432
+
433
+ WARNINGS = YES
434
+
435
+ # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
436
+ # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
437
+ # automatically be disabled.
438
+
439
+ WARN_IF_UNDOCUMENTED = YES
440
+
441
+ # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
442
+ # potential errors in the documentation, such as not documenting some
443
+ # parameters in a documented function, or documenting parameters that
444
+ # don't exist or using markup commands wrongly.
445
+
446
+ WARN_IF_DOC_ERROR = YES
447
+
448
+ # This WARN_NO_PARAMDOC option can be abled to get warnings for
449
+ # functions that are documented, but have no documentation for their parameters
450
+ # or return value. If set to NO (the default) doxygen will only warn about
451
+ # wrong or incomplete parameter documentation, but not about the absence of
452
+ # documentation.
453
+
454
+ WARN_NO_PARAMDOC = NO
455
+
456
+ # The WARN_FORMAT tag determines the format of the warning messages that
457
+ # doxygen can produce. The string should contain the $file, $line, and $text
458
+ # tags, which will be replaced by the file and line number from which the
459
+ # warning originated and the warning text. Optionally the format may contain
460
+ # $version, which will be replaced by the version of the file (if it could
461
+ # be obtained via FILE_VERSION_FILTER)
462
+
463
+ WARN_FORMAT = "$file:$line: $text"
464
+
465
+ # The WARN_LOGFILE tag can be used to specify a file to which warning
466
+ # and error messages should be written. If left blank the output is written
467
+ # to stderr.
468
+
469
+ WARN_LOGFILE =
470
+
471
+ #---------------------------------------------------------------------------
472
+ # configuration options related to the input files
473
+ #---------------------------------------------------------------------------
474
+
475
+ # The INPUT tag can be used to specify the files and/or directories that contain
476
+ # documented source files. You may enter file names like "myfile.cpp" or
477
+ # directories like "/usr/src/myproject". Separate the files or directories
478
+ # with spaces.
479
+
480
+ INPUT = @top_srcdir@/libusb
481
+
482
+ # This tag can be used to specify the character encoding of the source files that
483
+ # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
484
+ # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
485
+ # See http://www.gnu.org/software/libiconv for the list of possible encodings.
486
+
487
+ INPUT_ENCODING = UTF-8
488
+
489
+ # If the value of the INPUT tag contains directories, you can use the
490
+ # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
491
+ # and *.h) to filter out the source-files in the directories. If left
492
+ # blank the following patterns are tested:
493
+ # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
494
+ # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
495
+
496
+ FILE_PATTERNS =
497
+
498
+ # The RECURSIVE tag can be used to turn specify whether or not subdirectories
499
+ # should be searched for input files as well. Possible values are YES and NO.
500
+ # If left blank NO is used.
501
+
502
+ RECURSIVE = NO
503
+
504
+ # The EXCLUDE tag can be used to specify files and/or directories that should
505
+ # excluded from the INPUT source files. This way you can easily exclude a
506
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
507
+
508
+ EXCLUDE = @top_srcdir@/libusb/libusbi.h
509
+
510
+ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
511
+ # directories that are symbolic links (a Unix filesystem feature) are excluded
512
+ # from the input.
513
+
514
+ EXCLUDE_SYMLINKS = NO
515
+
516
+ # If the value of the INPUT tag contains directories, you can use the
517
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
518
+ # certain files from those directories. Note that the wildcards are matched
519
+ # against the file with absolute path, so to exclude all test directories
520
+ # for example use the pattern */test/*
521
+
522
+ EXCLUDE_PATTERNS =
523
+
524
+ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
525
+ # (namespaces, classes, functions, etc.) that should be excluded from the output.
526
+ # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
527
+ # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
528
+
529
+ EXCLUDE_SYMBOLS =
530
+
531
+ # The EXAMPLE_PATH tag can be used to specify one or more files or
532
+ # directories that contain example code fragments that are included (see
533
+ # the \include command).
534
+
535
+ EXAMPLE_PATH =
536
+
537
+ # If the value of the EXAMPLE_PATH tag contains directories, you can use the
538
+ # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
539
+ # and *.h) to filter out the source-files in the directories. If left
540
+ # blank all files are included.
541
+
542
+ EXAMPLE_PATTERNS =
543
+
544
+ # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
545
+ # searched for input files to be used with the \include or \dontinclude
546
+ # commands irrespective of the value of the RECURSIVE tag.
547
+ # Possible values are YES and NO. If left blank NO is used.
548
+
549
+ EXAMPLE_RECURSIVE = NO
550
+
551
+ # The IMAGE_PATH tag can be used to specify one or more files or
552
+ # directories that contain image that are included in the documentation (see
553
+ # the \image command).
554
+
555
+ IMAGE_PATH =
556
+
557
+ # The INPUT_FILTER tag can be used to specify a program that doxygen should
558
+ # invoke to filter for each input file. Doxygen will invoke the filter program
559
+ # by executing (via popen()) the command <filter> <input-file>, where <filter>
560
+ # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
561
+ # input file. Doxygen will then use the output that the filter program writes
562
+ # to standard output. If FILTER_PATTERNS is specified, this tag will be
563
+ # ignored.
564
+
565
+ INPUT_FILTER =
566
+
567
+ # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
568
+ # basis. Doxygen will compare the file name with each pattern and apply the
569
+ # filter if there is a match. The filters are a list of the form:
570
+ # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
571
+ # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
572
+ # is applied to all files.
573
+
574
+ FILTER_PATTERNS =
575
+
576
+ # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
577
+ # INPUT_FILTER) will be used to filter the input files when producing source
578
+ # files to browse (i.e. when SOURCE_BROWSER is set to YES).
579
+
580
+ FILTER_SOURCE_FILES = NO
581
+
582
+ #---------------------------------------------------------------------------
583
+ # configuration options related to source browsing
584
+ #---------------------------------------------------------------------------
585
+
586
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will
587
+ # be generated. Documented entities will be cross-referenced with these sources.
588
+ # Note: To get rid of all source code in the generated output, make sure also
589
+ # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
590
+ # then you must also enable this option. If you don't then doxygen will produce
591
+ # a warning and turn it on anyway
592
+
593
+ SOURCE_BROWSER = NO
594
+
595
+ # Setting the INLINE_SOURCES tag to YES will include the body
596
+ # of functions and classes directly in the documentation.
597
+
598
+ INLINE_SOURCES = NO
599
+
600
+ # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
601
+ # doxygen to hide any special comment blocks from generated source code
602
+ # fragments. Normal C and C++ comments will always remain visible.
603
+
604
+ STRIP_CODE_COMMENTS = YES
605
+
606
+ # If the REFERENCED_BY_RELATION tag is set to YES (the default)
607
+ # then for each documented function all documented
608
+ # functions referencing it will be listed.
609
+
610
+ REFERENCED_BY_RELATION = NO
611
+
612
+ # If the REFERENCES_RELATION tag is set to YES (the default)
613
+ # then for each documented function all documented entities
614
+ # called/used by that function will be listed.
615
+
616
+ REFERENCES_RELATION = NO
617
+
618
+ # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
619
+ # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
620
+ # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
621
+ # link to the source code. Otherwise they will link to the documentstion.
622
+
623
+ REFERENCES_LINK_SOURCE = YES
624
+
625
+ # If the USE_HTAGS tag is set to YES then the references to source code
626
+ # will point to the HTML generated by the htags(1) tool instead of doxygen
627
+ # built-in source browser. The htags tool is part of GNU's global source
628
+ # tagging system (see http://www.gnu.org/software/global/global.html). You
629
+ # will need version 4.8.6 or higher.
630
+
631
+ USE_HTAGS = NO
632
+
633
+ # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
634
+ # will generate a verbatim copy of the header file for each class for
635
+ # which an include is specified. Set to NO to disable this.
636
+
637
+ VERBATIM_HEADERS = YES
638
+
639
+ #---------------------------------------------------------------------------
640
+ # configuration options related to the alphabetical class index
641
+ #---------------------------------------------------------------------------
642
+
643
+ # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
644
+ # of all compounds will be generated. Enable this if the project
645
+ # contains a lot of classes, structs, unions or interfaces.
646
+
647
+ ALPHABETICAL_INDEX = YES
648
+
649
+ # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
650
+ # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
651
+ # in which this list will be split (can be a number in the range [1..20])
652
+
653
+ COLS_IN_ALPHA_INDEX = 5
654
+
655
+ # In case all classes in a project start with a common prefix, all
656
+ # classes will be put under the same header in the alphabetical index.
657
+ # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
658
+ # should be ignored while generating the index headers.
659
+
660
+ IGNORE_PREFIX =
661
+
662
+ #---------------------------------------------------------------------------
663
+ # configuration options related to the HTML output
664
+ #---------------------------------------------------------------------------
665
+
666
+ # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
667
+ # generate HTML output.
668
+
669
+ GENERATE_HTML = YES
670
+
671
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
672
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
673
+ # put in front of it. If left blank `html' will be used as the default path.
674
+
675
+ HTML_OUTPUT = html
676
+
677
+ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
678
+ # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
679
+ # doxygen will generate files with .html extension.
680
+
681
+ HTML_FILE_EXTENSION = .html
682
+
683
+ # The HTML_HEADER tag can be used to specify a personal HTML header for
684
+ # each generated HTML page. If it is left blank doxygen will generate a
685
+ # standard header.
686
+
687
+ HTML_HEADER =
688
+
689
+ # The HTML_FOOTER tag can be used to specify a personal HTML footer for
690
+ # each generated HTML page. If it is left blank doxygen will generate a
691
+ # standard footer.
692
+
693
+ HTML_FOOTER =
694
+
695
+ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
696
+ # style sheet that is used by each HTML page. It can be used to
697
+ # fine-tune the look of the HTML output. If the tag is left blank doxygen
698
+ # will generate a default style sheet. Note that doxygen will try to copy
699
+ # the style sheet file to the HTML output directory, so don't put your own
700
+ # stylesheet in the HTML output directory as well, or it will be erased!
701
+
702
+ HTML_STYLESHEET =
703
+
704
+ # If the GENERATE_HTMLHELP tag is set to YES, additional index files
705
+ # will be generated that can be used as input for tools like the
706
+ # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
707
+ # of the generated HTML documentation.
708
+
709
+ GENERATE_HTMLHELP = NO
710
+
711
+ # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
712
+ # documentation will contain sections that can be hidden and shown after the
713
+ # page has loaded. For this to work a browser that supports
714
+ # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
715
+ # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
716
+
717
+ HTML_DYNAMIC_SECTIONS = YES
718
+
719
+ # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
720
+ # be used to specify the file name of the resulting .chm file. You
721
+ # can add a path in front of the file if the result should not be
722
+ # written to the html output directory.
723
+
724
+ CHM_FILE =
725
+
726
+ # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
727
+ # be used to specify the location (absolute path including file name) of
728
+ # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
729
+ # the HTML help compiler on the generated index.hhp.
730
+
731
+ HHC_LOCATION =
732
+
733
+ # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
734
+ # controls if a separate .chi index file is generated (YES) or that
735
+ # it should be included in the master .chm file (NO).
736
+
737
+ GENERATE_CHI = NO
738
+
739
+ # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
740
+ # controls whether a binary table of contents is generated (YES) or a
741
+ # normal table of contents (NO) in the .chm file.
742
+
743
+ BINARY_TOC = NO
744
+
745
+ # The TOC_EXPAND flag can be set to YES to add extra items for group members
746
+ # to the contents of the HTML help documentation and to the tree view.
747
+
748
+ TOC_EXPAND = NO
749
+
750
+ # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
751
+ # top of each HTML page. The value NO (the default) enables the index and
752
+ # the value YES disables it.
753
+
754
+ DISABLE_INDEX = NO
755
+
756
+ # This tag can be used to set the number of enum values (range [1..20])
757
+ # that doxygen will group on one line in the generated HTML documentation.
758
+
759
+ ENUM_VALUES_PER_LINE = 4
760
+
761
+ # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
762
+ # generated containing a tree-like index structure (just like the one that
763
+ # is generated for HTML Help). For this to work a browser that supports
764
+ # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
765
+ # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
766
+ # probably better off using the HTML help feature.
767
+
768
+ GENERATE_TREEVIEW = NO
769
+
770
+ # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
771
+ # used to set the initial width (in pixels) of the frame in which the tree
772
+ # is shown.
773
+
774
+ TREEVIEW_WIDTH = 250
775
+
776
+ #---------------------------------------------------------------------------
777
+ # configuration options related to the LaTeX output
778
+ #---------------------------------------------------------------------------
779
+
780
+ # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
781
+ # generate Latex output.
782
+
783
+ GENERATE_LATEX = NO
784
+
785
+ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
786
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
787
+ # put in front of it. If left blank `latex' will be used as the default path.
788
+
789
+ LATEX_OUTPUT = latex
790
+
791
+ # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
792
+ # invoked. If left blank `latex' will be used as the default command name.
793
+
794
+ LATEX_CMD_NAME = latex
795
+
796
+ # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
797
+ # generate index for LaTeX. If left blank `makeindex' will be used as the
798
+ # default command name.
799
+
800
+ MAKEINDEX_CMD_NAME = makeindex
801
+
802
+ # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
803
+ # LaTeX documents. This may be useful for small projects and may help to
804
+ # save some trees in general.
805
+
806
+ COMPACT_LATEX = NO
807
+
808
+ # The PAPER_TYPE tag can be used to set the paper type that is used
809
+ # by the printer. Possible values are: a4, a4wide, letter, legal and
810
+ # executive. If left blank a4wide will be used.
811
+
812
+ PAPER_TYPE = a4wide
813
+
814
+ # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
815
+ # packages that should be included in the LaTeX output.
816
+
817
+ EXTRA_PACKAGES =
818
+
819
+ # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
820
+ # the generated latex document. The header should contain everything until
821
+ # the first chapter. If it is left blank doxygen will generate a
822
+ # standard header. Notice: only use this tag if you know what you are doing!
823
+
824
+ LATEX_HEADER =
825
+
826
+ # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
827
+ # is prepared for conversion to pdf (using ps2pdf). The pdf file will
828
+ # contain links (just like the HTML output) instead of page references
829
+ # This makes the output suitable for online browsing using a pdf viewer.
830
+
831
+ PDF_HYPERLINKS = NO
832
+
833
+ # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
834
+ # plain latex in the generated Makefile. Set this option to YES to get a
835
+ # higher quality PDF documentation.
836
+
837
+ USE_PDFLATEX = NO
838
+
839
+ # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
840
+ # command to the generated LaTeX files. This will instruct LaTeX to keep
841
+ # running if errors occur, instead of asking the user for help.
842
+ # This option is also used when generating formulas in HTML.
843
+
844
+ LATEX_BATCHMODE = NO
845
+
846
+ # If LATEX_HIDE_INDICES is set to YES then doxygen will not
847
+ # include the index chapters (such as File Index, Compound Index, etc.)
848
+ # in the output.
849
+
850
+ LATEX_HIDE_INDICES = NO
851
+
852
+ #---------------------------------------------------------------------------
853
+ # configuration options related to the RTF output
854
+ #---------------------------------------------------------------------------
855
+
856
+ # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
857
+ # The RTF output is optimized for Word 97 and may not look very pretty with
858
+ # other RTF readers or editors.
859
+
860
+ GENERATE_RTF = NO
861
+
862
+ # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
863
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
864
+ # put in front of it. If left blank `rtf' will be used as the default path.
865
+
866
+ RTF_OUTPUT = rtf
867
+
868
+ # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
869
+ # RTF documents. This may be useful for small projects and may help to
870
+ # save some trees in general.
871
+
872
+ COMPACT_RTF = NO
873
+
874
+ # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
875
+ # will contain hyperlink fields. The RTF file will
876
+ # contain links (just like the HTML output) instead of page references.
877
+ # This makes the output suitable for online browsing using WORD or other
878
+ # programs which support those fields.
879
+ # Note: wordpad (write) and others do not support links.
880
+
881
+ RTF_HYPERLINKS = NO
882
+
883
+ # Load stylesheet definitions from file. Syntax is similar to doxygen's
884
+ # config file, i.e. a series of assignments. You only have to provide
885
+ # replacements, missing definitions are set to their default value.
886
+
887
+ RTF_STYLESHEET_FILE =
888
+
889
+ # Set optional variables used in the generation of an rtf document.
890
+ # Syntax is similar to doxygen's config file.
891
+
892
+ RTF_EXTENSIONS_FILE =
893
+
894
+ #---------------------------------------------------------------------------
895
+ # configuration options related to the man page output
896
+ #---------------------------------------------------------------------------
897
+
898
+ # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
899
+ # generate man pages
900
+
901
+ GENERATE_MAN = NO
902
+
903
+ # The MAN_OUTPUT tag is used to specify where the man pages will be put.
904
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
905
+ # put in front of it. If left blank `man' will be used as the default path.
906
+
907
+ MAN_OUTPUT = man
908
+
909
+ # The MAN_EXTENSION tag determines the extension that is added to
910
+ # the generated man pages (default is the subroutine's section .3)
911
+
912
+ MAN_EXTENSION = .3
913
+
914
+ # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
915
+ # then it will generate one additional man file for each entity
916
+ # documented in the real man page(s). These additional files
917
+ # only source the real man page, but without them the man command
918
+ # would be unable to find the correct page. The default is NO.
919
+
920
+ MAN_LINKS = NO
921
+
922
+ #---------------------------------------------------------------------------
923
+ # configuration options related to the XML output
924
+ #---------------------------------------------------------------------------
925
+
926
+ # If the GENERATE_XML tag is set to YES Doxygen will
927
+ # generate an XML file that captures the structure of
928
+ # the code including all documentation.
929
+
930
+ GENERATE_XML = NO
931
+
932
+ # The XML_OUTPUT tag is used to specify where the XML pages will be put.
933
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
934
+ # put in front of it. If left blank `xml' will be used as the default path.
935
+
936
+ XML_OUTPUT = xml
937
+
938
+ # The XML_SCHEMA tag can be used to specify an XML schema,
939
+ # which can be used by a validating XML parser to check the
940
+ # syntax of the XML files.
941
+
942
+ XML_SCHEMA =
943
+
944
+ # The XML_DTD tag can be used to specify an XML DTD,
945
+ # which can be used by a validating XML parser to check the
946
+ # syntax of the XML files.
947
+
948
+ XML_DTD =
949
+
950
+ # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
951
+ # dump the program listings (including syntax highlighting
952
+ # and cross-referencing information) to the XML output. Note that
953
+ # enabling this will significantly increase the size of the XML output.
954
+
955
+ XML_PROGRAMLISTING = YES
956
+
957
+ #---------------------------------------------------------------------------
958
+ # configuration options for the AutoGen Definitions output
959
+ #---------------------------------------------------------------------------
960
+
961
+ # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
962
+ # generate an AutoGen Definitions (see autogen.sf.net) file
963
+ # that captures the structure of the code including all
964
+ # documentation. Note that this feature is still experimental
965
+ # and incomplete at the moment.
966
+
967
+ GENERATE_AUTOGEN_DEF = NO
968
+
969
+ #---------------------------------------------------------------------------
970
+ # configuration options related to the Perl module output
971
+ #---------------------------------------------------------------------------
972
+
973
+ # If the GENERATE_PERLMOD tag is set to YES Doxygen will
974
+ # generate a Perl module file that captures the structure of
975
+ # the code including all documentation. Note that this
976
+ # feature is still experimental and incomplete at the
977
+ # moment.
978
+
979
+ GENERATE_PERLMOD = NO
980
+
981
+ # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
982
+ # the necessary Makefile rules, Perl scripts and LaTeX code to be able
983
+ # to generate PDF and DVI output from the Perl module output.
984
+
985
+ PERLMOD_LATEX = NO
986
+
987
+ # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
988
+ # nicely formatted so it can be parsed by a human reader. This is useful
989
+ # if you want to understand what is going on. On the other hand, if this
990
+ # tag is set to NO the size of the Perl module output will be much smaller
991
+ # and Perl will parse it just the same.
992
+
993
+ PERLMOD_PRETTY = YES
994
+
995
+ # The names of the make variables in the generated doxyrules.make file
996
+ # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
997
+ # This is useful so different doxyrules.make files included by the same
998
+ # Makefile don't overwrite each other's variables.
999
+
1000
+ PERLMOD_MAKEVAR_PREFIX =
1001
+
1002
+ #---------------------------------------------------------------------------
1003
+ # Configuration options related to the preprocessor
1004
+ #---------------------------------------------------------------------------
1005
+
1006
+ # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1007
+ # evaluate all C-preprocessor directives found in the sources and include
1008
+ # files.
1009
+
1010
+ ENABLE_PREPROCESSING = YES
1011
+
1012
+ # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1013
+ # names in the source code. If set to NO (the default) only conditional
1014
+ # compilation will be performed. Macro expansion can be done in a controlled
1015
+ # way by setting EXPAND_ONLY_PREDEF to YES.
1016
+
1017
+ MACRO_EXPANSION = YES
1018
+
1019
+ # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1020
+ # then the macro expansion is limited to the macros specified with the
1021
+ # PREDEFINED and EXPAND_AS_DEFINED tags.
1022
+
1023
+ EXPAND_ONLY_PREDEF = YES
1024
+
1025
+ # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1026
+ # in the INCLUDE_PATH (see below) will be search if a #include is found.
1027
+
1028
+ SEARCH_INCLUDES = YES
1029
+
1030
+ # The INCLUDE_PATH tag can be used to specify one or more directories that
1031
+ # contain include files that are not input files but should be processed by
1032
+ # the preprocessor.
1033
+
1034
+ INCLUDE_PATH =
1035
+
1036
+ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1037
+ # patterns (like *.h and *.hpp) to filter out the header-files in the
1038
+ # directories. If left blank, the patterns specified with FILE_PATTERNS will
1039
+ # be used.
1040
+
1041
+ INCLUDE_FILE_PATTERNS =
1042
+
1043
+ # The PREDEFINED tag can be used to specify one or more macro names that
1044
+ # are defined before the preprocessor is started (similar to the -D option of
1045
+ # gcc). The argument of the tag is a list of macros of the form: name
1046
+ # or name=definition (no spaces). If the definition and the = are
1047
+ # omitted =1 is assumed. To prevent a macro definition from being
1048
+ # undefined via #undef or recursively expanded use the := operator
1049
+ # instead of the = operator.
1050
+
1051
+ PREDEFINED = API_EXPORTED= LIBUSB_CALL= DEFAULT_VISIBILITY=
1052
+
1053
+ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1054
+ # this tag can be used to specify a list of macro names that should be expanded.
1055
+ # The macro definition that is found in the sources will be used.
1056
+ # Use the PREDEFINED tag if you want to use a different macro definition.
1057
+
1058
+ EXPAND_AS_DEFINED =
1059
+
1060
+ # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1061
+ # doxygen's preprocessor will remove all function-like macros that are alone
1062
+ # on a line, have an all uppercase name, and do not end with a semicolon. Such
1063
+ # function macros are typically used for boiler-plate code, and will confuse
1064
+ # the parser if not removed.
1065
+
1066
+ SKIP_FUNCTION_MACROS = YES
1067
+
1068
+ #---------------------------------------------------------------------------
1069
+ # Configuration::additions related to external references
1070
+ #---------------------------------------------------------------------------
1071
+
1072
+ # The TAGFILES option can be used to specify one or more tagfiles.
1073
+ # Optionally an initial location of the external documentation
1074
+ # can be added for each tagfile. The format of a tag file without
1075
+ # this location is as follows:
1076
+ # TAGFILES = file1 file2 ...
1077
+ # Adding location for the tag files is done as follows:
1078
+ # TAGFILES = file1=loc1 "file2 = loc2" ...
1079
+ # where "loc1" and "loc2" can be relative or absolute paths or
1080
+ # URLs. If a location is present for each tag, the installdox tool
1081
+ # does not have to be run to correct the links.
1082
+ # Note that each tag file must have a unique name
1083
+ # (where the name does NOT include the path)
1084
+ # If a tag file is not located in the directory in which doxygen
1085
+ # is run, you must also specify the path to the tagfile here.
1086
+
1087
+ TAGFILES =
1088
+
1089
+ # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1090
+ # a tag file that is based on the input files it reads.
1091
+
1092
+ GENERATE_TAGFILE =
1093
+
1094
+ # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1095
+ # in the class index. If set to NO only the inherited external classes
1096
+ # will be listed.
1097
+
1098
+ ALLEXTERNALS = NO
1099
+
1100
+ # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1101
+ # in the modules index. If set to NO, only the current project's groups will
1102
+ # be listed.
1103
+
1104
+ EXTERNAL_GROUPS = YES
1105
+
1106
+ # The PERL_PATH should be the absolute path and name of the perl script
1107
+ # interpreter (i.e. the result of `which perl').
1108
+
1109
+ PERL_PATH = /usr/bin/perl
1110
+
1111
+ #---------------------------------------------------------------------------
1112
+ # Configuration options related to the dot tool
1113
+ #---------------------------------------------------------------------------
1114
+
1115
+ # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1116
+ # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1117
+ # or super classes. Setting the tag to NO turns the diagrams off. Note that
1118
+ # this option is superseded by the HAVE_DOT option below. This is only a
1119
+ # fallback. It is recommended to install and use dot, since it yields more
1120
+ # powerful graphs.
1121
+
1122
+ CLASS_DIAGRAMS = YES
1123
+
1124
+ # You can define message sequence charts within doxygen comments using the \msc
1125
+ # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1126
+ # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1127
+ # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1128
+ # be found in the default search path.
1129
+
1130
+ MSCGEN_PATH =
1131
+
1132
+ # If set to YES, the inheritance and collaboration graphs will hide
1133
+ # inheritance and usage relations if the target is undocumented
1134
+ # or is not a class.
1135
+
1136
+ HIDE_UNDOC_RELATIONS = YES
1137
+
1138
+ # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1139
+ # available from the path. This tool is part of Graphviz, a graph visualization
1140
+ # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1141
+ # have no effect if this option is set to NO (the default)
1142
+
1143
+ HAVE_DOT = NO
1144
+
1145
+ # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1146
+ # will generate a graph for each documented class showing the direct and
1147
+ # indirect inheritance relations. Setting this tag to YES will force the
1148
+ # the CLASS_DIAGRAMS tag to NO.
1149
+
1150
+ CLASS_GRAPH = YES
1151
+
1152
+ # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1153
+ # will generate a graph for each documented class showing the direct and
1154
+ # indirect implementation dependencies (inheritance, containment, and
1155
+ # class references variables) of the class with other documented classes.
1156
+
1157
+ COLLABORATION_GRAPH = YES
1158
+
1159
+ # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1160
+ # will generate a graph for groups, showing the direct groups dependencies
1161
+
1162
+ GROUP_GRAPHS = YES
1163
+
1164
+ # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1165
+ # collaboration diagrams in a style similar to the OMG's Unified Modeling
1166
+ # Language.
1167
+
1168
+ UML_LOOK = NO
1169
+
1170
+ # If set to YES, the inheritance and collaboration graphs will show the
1171
+ # relations between templates and their instances.
1172
+
1173
+ TEMPLATE_RELATIONS = NO
1174
+
1175
+ # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1176
+ # tags are set to YES then doxygen will generate a graph for each documented
1177
+ # file showing the direct and indirect include dependencies of the file with
1178
+ # other documented files.
1179
+
1180
+ INCLUDE_GRAPH = YES
1181
+
1182
+ # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1183
+ # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1184
+ # documented header file showing the documented files that directly or
1185
+ # indirectly include this file.
1186
+
1187
+ INCLUDED_BY_GRAPH = YES
1188
+
1189
+ # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1190
+ # generate a call dependency graph for every global function or class method.
1191
+ # Note that enabling this option will significantly increase the time of a run.
1192
+ # So in most cases it will be better to enable call graphs for selected
1193
+ # functions only using the \callgraph command.
1194
+
1195
+ CALL_GRAPH = NO
1196
+
1197
+ # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1198
+ # generate a caller dependency graph for every global function or class method.
1199
+ # Note that enabling this option will significantly increase the time of a run.
1200
+ # So in most cases it will be better to enable caller graphs for selected
1201
+ # functions only using the \callergraph command.
1202
+
1203
+ CALLER_GRAPH = NO
1204
+
1205
+ # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1206
+ # will graphical hierarchy of all classes instead of a textual one.
1207
+
1208
+ GRAPHICAL_HIERARCHY = YES
1209
+
1210
+ # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1211
+ # then doxygen will show the dependencies a directory has on other directories
1212
+ # in a graphical way. The dependency relations are determined by the #include
1213
+ # relations between the files in the directories.
1214
+
1215
+ DIRECTORY_GRAPH = YES
1216
+
1217
+ # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1218
+ # generated by dot. Possible values are png, jpg, or gif
1219
+ # If left blank png will be used.
1220
+
1221
+ DOT_IMAGE_FORMAT = png
1222
+
1223
+ # The tag DOT_PATH can be used to specify the path where the dot tool can be
1224
+ # found. If left blank, it is assumed the dot tool can be found in the path.
1225
+
1226
+ DOT_PATH =
1227
+
1228
+ # The DOTFILE_DIRS tag can be used to specify one or more directories that
1229
+ # contain dot files that are included in the documentation (see the
1230
+ # \dotfile command).
1231
+
1232
+ DOTFILE_DIRS =
1233
+
1234
+ # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1235
+ # nodes that will be shown in the graph. If the number of nodes in a graph
1236
+ # becomes larger than this value, doxygen will truncate the graph, which is
1237
+ # visualized by representing a node as a red box. Note that doxygen if the number
1238
+ # of direct children of the root node in a graph is already larger than
1239
+ # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1240
+ # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1241
+
1242
+ DOT_GRAPH_MAX_NODES = 50
1243
+
1244
+ # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1245
+ # graphs generated by dot. A depth value of 3 means that only nodes reachable
1246
+ # from the root by following a path via at most 3 edges will be shown. Nodes
1247
+ # that lay further from the root node will be omitted. Note that setting this
1248
+ # option to 1 or 2 may greatly reduce the computation time needed for large
1249
+ # code bases. Also note that the size of a graph can be further restricted by
1250
+ # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1251
+
1252
+ MAX_DOT_GRAPH_DEPTH = 0
1253
+
1254
+ # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1255
+ # background. This is disabled by default, which results in a white background.
1256
+ # Warning: Depending on the platform used, enabling this option may lead to
1257
+ # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1258
+ # read).
1259
+
1260
+ DOT_TRANSPARENT = NO
1261
+
1262
+ # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1263
+ # files in one run (i.e. multiple -o and -T options on the command line). This
1264
+ # makes dot run faster, but since only newer versions of dot (>1.8.10)
1265
+ # support this, this feature is disabled by default.
1266
+
1267
+ DOT_MULTI_TARGETS = NO
1268
+
1269
+ # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1270
+ # generate a legend page explaining the meaning of the various boxes and
1271
+ # arrows in the dot generated graphs.
1272
+
1273
+ GENERATE_LEGEND = YES
1274
+
1275
+ # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1276
+ # remove the intermediate dot files that are used to generate
1277
+ # the various graphs.
1278
+
1279
+ DOT_CLEANUP = YES
1280
+
1281
+ #---------------------------------------------------------------------------
1282
+ # Configuration::additions related to the search engine
1283
+ #---------------------------------------------------------------------------
1284
+
1285
+ # The SEARCHENGINE tag specifies whether or not a search engine should be
1286
+ # used. If set to NO the values of all tags below this one will be ignored.
1287
+
1288
+ SEARCHENGINE = NO