libusb 0.5.0 → 0.5.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data.tar.gz.sig +0 -0
  4. data/.travis.yml +1 -0
  5. data/History.md +8 -0
  6. data/README.md +5 -15
  7. data/Rakefile +8 -1
  8. data/ext/extconf.rb +49 -12
  9. data/ext/{libusb-1.0.19 → libusb-1.0.20}/AUTHORS +12 -1
  10. data/ext/{libusb-1.0.19 → libusb-1.0.20}/COPYING +0 -0
  11. data/ext/{libusb-1.0.19 → libusb-1.0.20}/ChangeLog +18 -2
  12. data/ext/{libusb-1.0.19 → libusb-1.0.20}/INSTALL +0 -0
  13. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Makefile.am +0 -0
  14. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Makefile.in +31 -18
  15. data/ext/{libusb-1.0.19 → libusb-1.0.20}/NEWS +0 -0
  16. data/ext/{libusb-1.0.19 → libusb-1.0.20}/PORTING +0 -0
  17. data/ext/{libusb-1.0.19 → libusb-1.0.20}/README +5 -3
  18. data/ext/{libusb-1.0.19 → libusb-1.0.20}/TODO +0 -0
  19. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Xcode/common.xcconfig +0 -0
  20. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Xcode/config.h +0 -0
  21. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Xcode/debug.xcconfig +0 -0
  22. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Xcode/libusb.xcconfig +0 -0
  23. data/ext/libusb-1.0.20/Xcode/libusb.xcodeproj/project.pbxproj +865 -0
  24. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Xcode/libusb_debug.xcconfig +0 -0
  25. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Xcode/libusb_release.xcconfig +0 -0
  26. data/ext/{libusb-1.0.19 → libusb-1.0.20}/Xcode/release.xcconfig +0 -0
  27. data/ext/{libusb-1.0.19 → libusb-1.0.20}/aclocal.m4 +35 -32
  28. data/ext/{libusb-1.0.19 → libusb-1.0.20}/android/README +0 -0
  29. data/ext/{libusb-1.0.19 → libusb-1.0.20}/android/config.h +0 -0
  30. data/ext/{libusb-1.0.19 → libusb-1.0.20}/android/jni/Android.mk +0 -0
  31. data/ext/{libusb-1.0.19 → libusb-1.0.20}/android/jni/Application.mk +0 -0
  32. data/ext/{libusb-1.0.19 → libusb-1.0.20}/android/jni/examples.mk +0 -0
  33. data/ext/{libusb-1.0.19 → libusb-1.0.20}/android/jni/libusb.mk +0 -0
  34. data/ext/{libusb-1.0.19 → libusb-1.0.20}/android/jni/tests.mk +0 -0
  35. data/ext/{libusb-1.0.19 → libusb-1.0.20}/compile +1 -1
  36. data/ext/{libusb-1.0.19 → libusb-1.0.20}/config.guess +13 -160
  37. data/ext/{libusb-1.0.19 → libusb-1.0.20}/config.h.in +6 -0
  38. data/ext/{libusb-1.0.19 → libusb-1.0.20}/config.sub +26 -12
  39. data/ext/{libusb-1.0.19 → libusb-1.0.20}/configure +244 -20
  40. data/ext/{libusb-1.0.19 → libusb-1.0.20}/configure.ac +27 -4
  41. data/ext/{libusb-1.0.19 → libusb-1.0.20}/depcomp +1 -1
  42. data/ext/{libusb-1.0.19 → libusb-1.0.20}/doc/Makefile.am +0 -0
  43. data/ext/{libusb-1.0.19 → libusb-1.0.20}/doc/Makefile.in +19 -6
  44. data/ext/libusb-1.0.20/doc/doxygen.cfg.in +2334 -0
  45. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/Makefile.am +0 -0
  46. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/Makefile.in +19 -6
  47. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/dpfp.c +0 -0
  48. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/dpfp_threaded.c +15 -10
  49. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/ezusb.c +0 -0
  50. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/ezusb.h +0 -0
  51. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/fxload.c +28 -7
  52. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/getopt/getopt.c +0 -0
  53. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/getopt/getopt.h +0 -0
  54. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/getopt/getopt1.c +0 -0
  55. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/hotplugtest.c +21 -3
  56. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/listdevs.c +0 -0
  57. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/sam3u_benchmark.c +0 -0
  58. data/ext/{libusb-1.0.19 → libusb-1.0.20}/examples/xusb.c +2 -1
  59. data/ext/{libusb-1.0.19 → libusb-1.0.20}/install-sh +170 -196
  60. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb-1.0.pc.in +0 -0
  61. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/Makefile.am +15 -0
  62. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/Makefile.in +192 -53
  63. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/core.c +218 -100
  64. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/descriptor.c +3 -1
  65. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/hotplug.c +26 -9
  66. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/hotplug.h +8 -0
  67. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/io.c +432 -290
  68. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/libusb-1.0.def +2 -0
  69. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/libusb-1.0.rc +0 -0
  70. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/libusb.h +11 -10
  71. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/libusbi.h +106 -29
  72. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/darwin_usb.c +27 -67
  73. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/darwin_usb.h +3 -7
  74. data/ext/libusb-1.0.20/libusb/os/haiku/Makefile.am +5 -0
  75. data/ext/libusb-1.0.20/libusb/os/haiku/Makefile.in +810 -0
  76. data/ext/libusb-1.0.20/libusb/os/haiku/aclocal.m4 +1193 -0
  77. data/ext/libusb-1.0.20/libusb/os/haiku/compile +347 -0
  78. data/ext/libusb-1.0.20/libusb/os/haiku/config.guess +1421 -0
  79. data/ext/libusb-1.0.20/libusb/os/haiku/config.sub +1807 -0
  80. data/ext/libusb-1.0.20/libusb/os/haiku/configure +17579 -0
  81. data/ext/libusb-1.0.20/libusb/os/haiku/configure.ac +8 -0
  82. data/ext/libusb-1.0.20/libusb/os/haiku/depcomp +791 -0
  83. data/ext/libusb-1.0.20/libusb/os/haiku/haiku_pollfs.cpp +378 -0
  84. data/ext/libusb-1.0.20/libusb/os/haiku/haiku_usb.h +112 -0
  85. data/ext/libusb-1.0.20/libusb/os/haiku/haiku_usb_backend.cpp +550 -0
  86. data/ext/libusb-1.0.20/libusb/os/haiku/haiku_usb_raw.cpp +255 -0
  87. data/ext/libusb-1.0.20/libusb/os/haiku/haiku_usb_raw.h +180 -0
  88. data/ext/libusb-1.0.20/libusb/os/haiku/install-sh +501 -0
  89. data/ext/{libusb-1.0.19 → libusb-1.0.20/libusb/os/haiku}/ltmain.sh +0 -0
  90. data/ext/{libusb-1.0.19 → libusb-1.0.20/libusb/os/haiku}/m4/libtool.m4 +0 -0
  91. data/ext/{libusb-1.0.19 → libusb-1.0.20/libusb/os/haiku}/m4/ltoptions.m4 +0 -0
  92. data/ext/{libusb-1.0.19 → libusb-1.0.20/libusb/os/haiku}/m4/ltsugar.m4 +0 -0
  93. data/ext/{libusb-1.0.19 → libusb-1.0.20/libusb/os/haiku}/m4/ltversion.m4 +0 -0
  94. data/ext/{libusb-1.0.19 → libusb-1.0.20/libusb/os/haiku}/m4/lt~obsolete.m4 +0 -0
  95. data/ext/{libusb-1.0.19 → libusb-1.0.20/libusb/os/haiku}/missing +1 -1
  96. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/linux_netlink.c +4 -4
  97. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/linux_udev.c +1 -2
  98. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/linux_usbfs.c +46 -49
  99. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/linux_usbfs.h +1 -1
  100. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/netbsd_usb.c +9 -73
  101. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/openbsd_usb.c +9 -73
  102. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/poll_posix.c +2 -0
  103. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/poll_posix.h +0 -0
  104. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/poll_windows.c +3 -1
  105. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/poll_windows.h +0 -0
  106. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/threads_posix.c +3 -3
  107. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/threads_posix.h +0 -0
  108. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/threads_windows.c +3 -1
  109. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/threads_windows.h +0 -0
  110. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/wince_usb.c +87 -250
  111. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/wince_usb.h +0 -0
  112. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/windows_common.h +1 -1
  113. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/windows_usb.c +267 -181
  114. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/os/windows_usb.h +22 -7
  115. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/strerror.c +5 -2
  116. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/sync.c +2 -1
  117. data/ext/{libusb-1.0.19 → libusb-1.0.20}/libusb/version.h +1 -1
  118. data/ext/libusb-1.0.20/libusb/version_nano.h +1 -0
  119. data/ext/libusb-1.0.20/ltmain.sh +9655 -0
  120. data/ext/libusb-1.0.20/m4/libtool.m4 +7992 -0
  121. data/ext/libusb-1.0.20/m4/ltoptions.m4 +384 -0
  122. data/ext/libusb-1.0.20/m4/ltsugar.m4 +123 -0
  123. data/ext/libusb-1.0.20/m4/ltversion.m4 +23 -0
  124. data/ext/libusb-1.0.20/m4/lt~obsolete.m4 +98 -0
  125. data/ext/libusb-1.0.20/missing +215 -0
  126. data/ext/{libusb-1.0.19 → libusb-1.0.20}/tests/Makefile.am +0 -0
  127. data/ext/{libusb-1.0.19 → libusb-1.0.20}/tests/Makefile.in +19 -6
  128. data/ext/{libusb-1.0.19 → libusb-1.0.20}/tests/libusb_testlib.h +0 -0
  129. data/ext/{libusb-1.0.19 → libusb-1.0.20}/tests/stress.c +0 -0
  130. data/ext/{libusb-1.0.19 → libusb-1.0.20}/tests/testlib.c +0 -0
  131. data/lib/libusb.rb +1 -0
  132. data/lib/libusb/call.rb +1 -0
  133. data/lib/libusb/context.rb +5 -2
  134. data/lib/libusb/stdio.rb +25 -0
  135. data/lib/libusb/version_gem.rb +1 -1
  136. data/libusb.gemspec +2 -1
  137. metadata +152 -115
  138. metadata.gz.sig +0 -0
  139. data/ext/libusb-1.0.19/Xcode/libusb.xcodeproj/project.pbxproj +0 -1
  140. data/ext/libusb-1.0.19/doc/doxygen.cfg.in +0 -1288
  141. data/ext/libusb-1.0.19/libusb/version_nano.h +0 -1
@@ -89,6 +89,12 @@ case $host in
89
89
  backend="windows"
90
90
  threads="posix"
91
91
  ;;
92
+ *-haiku*)
93
+ AC_MSG_RESULT([Haiku])
94
+ AC_CONFIG_SUBDIRS([libusb/os/haiku])
95
+ backend="haiku"
96
+ threads="posix"
97
+ ;;
92
98
  *)
93
99
  AC_MSG_ERROR([unsupported operating system])
94
100
  esac
@@ -121,9 +127,6 @@ linux)
121
127
 
122
128
  case $is_backend_android in
123
129
  yes)
124
- dnl some pthread functions is in libc
125
- THREAD_CFLAGS="-c"
126
- LIBS="${LIBS} -c"
127
130
  dnl there are gettimeofday function but configure doesn't seem to be able to find it.
128
131
  AC_DEFINE([HAVE_GETTIMEOFDAY], [1], [Define if you have gettimeofday])
129
132
  ;;
@@ -168,6 +171,14 @@ windows)
168
171
  LIBS=""
169
172
  LTLDFLAGS="${LTLDFLAGS} -avoid-version -Wl,--add-stdcall-alias"
170
173
  AC_DEFINE([POLL_NFDS_TYPE],[unsigned int],[type of second poll() argument])
174
+ AC_DEFINE([WINVER], 0x0501, [Oldest Windows version supported])
175
+ ;;
176
+ haiku)
177
+ AC_DEFINE(OS_HAIKU, 1, [Haiku backend])
178
+ AC_SUBST(OS_HAIKU)
179
+ LIBS="${LIBS} -lbe"
180
+ AC_CHECK_HEADERS([poll.h])
181
+ AC_DEFINE([POLL_NFDS_TYPE],[nfds_t],[type of second poll() argument])
171
182
  ;;
172
183
  esac
173
184
 
@@ -178,6 +189,7 @@ AM_CONDITIONAL(OS_DARWIN, test "x$backend" = xdarwin)
178
189
  AM_CONDITIONAL(OS_OPENBSD, test "x$backend" = xopenbsd)
179
190
  AM_CONDITIONAL(OS_NETBSD, test "x$backend" = xnetbsd)
180
191
  AM_CONDITIONAL(OS_WINDOWS, test "x$backend" = xwindows)
192
+ AM_CONDITIONAL(OS_HAIKU, test "x$backend" = xhaiku)
181
193
  AM_CONDITIONAL(THREADS_POSIX, test "x$threads" = xposix)
182
194
  AM_CONDITIONAL(CREATE_IMPORT_LIB, test "x$create_import_lib" = "xyes")
183
195
  AM_CONDITIONAL(USE_UDEV, test "x$enable_udev" = xyes)
@@ -288,7 +300,18 @@ AC_CHECK_HEADERS([sys/time.h])
288
300
  AC_CHECK_FUNCS(gettimeofday)
289
301
  AC_CHECK_HEADERS([signal.h])
290
302
 
291
- AM_CFLAGS="${AM_CFLAGS} -std=gnu99 -Wall -Wundef -Wunused -Wstrict-prototypes -Werror-implicit-function-declaration $nopointersign_cflags -Wshadow ${THREAD_CFLAGS} ${VISIBILITY_CFLAGS}"
303
+ # check for -std=gnu99 compiler support
304
+ saved_cflags="$CFLAGS"
305
+ CFLAGS="-std=gnu99"
306
+ AC_MSG_CHECKING([whether CC supports -std=gnu99])
307
+ AC_COMPILE_IFELSE([AC_LANG_PROGRAM([])],
308
+ [AC_MSG_RESULT([yes])]
309
+ [AM_CFLAGS="${AM_CFLAGS} -std=gnu99"],
310
+ [AC_MSG_RESULT([no])]
311
+ )
312
+ CFLAGS="$saved_cflags"
313
+
314
+ AM_CFLAGS="${AM_CFLAGS} -Wall -Wundef -Wunused -Wstrict-prototypes -Werror-implicit-function-declaration $nopointersign_cflags -Wshadow ${THREAD_CFLAGS} ${VISIBILITY_CFLAGS}"
292
315
 
293
316
  AC_SUBST(AM_CFLAGS)
294
317
  AC_SUBST(LTLDFLAGS)
@@ -3,7 +3,7 @@
3
3
 
4
4
  scriptversion=2013-05-30.07; # UTC
5
5
 
6
- # Copyright (C) 1999-2013 Free Software Foundation, Inc.
6
+ # Copyright (C) 1999-2014 Free Software Foundation, Inc.
7
7
 
8
8
  # This program is free software; you can redistribute it and/or modify
9
9
  # it under the terms of the GNU General Public License as published by
@@ -1,7 +1,7 @@
1
- # Makefile.in generated by automake 1.14.1 from Makefile.am.
1
+ # Makefile.in generated by automake 1.15 from Makefile.am.
2
2
  # @configure_input@
3
3
 
4
- # Copyright (C) 1994-2013 Free Software Foundation, Inc.
4
+ # Copyright (C) 1994-2014 Free Software Foundation, Inc.
5
5
 
6
6
  # This Makefile.in is free software; the Free Software Foundation
7
7
  # gives unlimited permission to copy and/or distribute it,
@@ -14,7 +14,17 @@
14
14
 
15
15
  @SET_MAKE@
16
16
  VPATH = @srcdir@
17
- am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)'
17
+ am__is_gnu_make = { \
18
+ if test -z '$(MAKELEVEL)'; then \
19
+ false; \
20
+ elif test -n '$(MAKE_HOST)'; then \
21
+ true; \
22
+ elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \
23
+ true; \
24
+ else \
25
+ false; \
26
+ fi; \
27
+ }
18
28
  am__make_running_with_option = \
19
29
  case $${target_option-} in \
20
30
  ?) ;; \
@@ -78,8 +88,6 @@ POST_UNINSTALL = :
78
88
  build_triplet = @build@
79
89
  host_triplet = @host@
80
90
  subdir = doc
81
- DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \
82
- $(srcdir)/doxygen.cfg.in
83
91
  ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
84
92
  am__aclocal_m4_deps = $(top_srcdir)/m4/libtool.m4 \
85
93
  $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \
@@ -87,6 +95,7 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/libtool.m4 \
87
95
  $(top_srcdir)/libusb/version.h $(top_srcdir)/configure.ac
88
96
  am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
89
97
  $(ACLOCAL_M4)
98
+ DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON)
90
99
  mkinstalldirs = $(install_sh) -d
91
100
  CONFIG_HEADER = $(top_builddir)/config.h
92
101
  CONFIG_CLEAN_FILES = doxygen.cfg
@@ -111,6 +120,7 @@ am__can_run_installinfo = \
111
120
  *) (install-info --version) >/dev/null 2>&1;; \
112
121
  esac
113
122
  am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
123
+ am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/doxygen.cfg.in
114
124
  DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
115
125
  ACLOCAL = @ACLOCAL@
116
126
  AMTAR = @AMTAR@
@@ -162,6 +172,7 @@ NMEDIT = @NMEDIT@
162
172
  OBJDUMP = @OBJDUMP@
163
173
  OBJEXT = @OBJEXT@
164
174
  OS_DARWIN = @OS_DARWIN@
175
+ OS_HAIKU = @OS_HAIKU@
165
176
  OS_LINUX = @OS_LINUX@
166
177
  OS_NETBSD = @OS_NETBSD@
167
178
  OS_OPENBSD = @OS_OPENBSD@
@@ -231,6 +242,7 @@ psdir = @psdir@
231
242
  sbindir = @sbindir@
232
243
  sharedstatedir = @sharedstatedir@
233
244
  srcdir = @srcdir@
245
+ subdirs = @subdirs@
234
246
  sysconfdir = @sysconfdir@
235
247
  target_alias = @target_alias@
236
248
  top_build_prefix = @top_build_prefix@
@@ -252,7 +264,6 @@ $(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__confi
252
264
  echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \
253
265
  $(am__cd) $(top_srcdir) && \
254
266
  $(AUTOMAKE) --gnu doc/Makefile
255
- .PRECIOUS: Makefile
256
267
  Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
257
268
  @case '$?' in \
258
269
  *config.status*) \
@@ -429,6 +440,8 @@ uninstall-am:
429
440
  mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \
430
441
  tags-am uninstall uninstall-am
431
442
 
443
+ .PRECIOUS: Makefile
444
+
432
445
 
433
446
  docs: doxygen.cfg
434
447
  doxygen $^
@@ -0,0 +1,2334 @@
1
+ # Doxyfile 1.8.8
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 double hash (##) is considered a comment and is placed in
7
+ # front of the TAG it is preceding.
8
+ #
9
+ # All text after a single hash (#) is considered a comment and will be ignored.
10
+ # The format is:
11
+ # TAG = value [value, ...]
12
+ # For lists, items can also be appended using:
13
+ # TAG += value [value, ...]
14
+ # Values that contain spaces should be placed between quotes (\" \").
15
+
16
+ #---------------------------------------------------------------------------
17
+ # Project related configuration options
18
+ #---------------------------------------------------------------------------
19
+
20
+ # This tag specifies the encoding used for all characters in the config file
21
+ # that follow. The default is UTF-8 which is also the encoding used for all text
22
+ # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23
+ # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24
+ # for the list of possible encodings.
25
+ # The default value is: UTF-8.
26
+
27
+ DOXYFILE_ENCODING = UTF-8
28
+
29
+ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30
+ # double-quotes, unless you are using Doxywizard) that should identify the
31
+ # project for which the documentation is generated. This name is used in the
32
+ # title of most generated pages and in a few other places.
33
+ # The default value is: My Project.
34
+
35
+ PROJECT_NAME =
36
+
37
+ # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38
+ # could be handy for archiving the generated documentation or if some version
39
+ # control system is used.
40
+
41
+ PROJECT_NUMBER =
42
+
43
+ # Using the PROJECT_BRIEF tag one can provide an optional one line description
44
+ # for a project that appears at the top of each page and should give viewer a
45
+ # quick idea about the purpose of the project. Keep the description short.
46
+
47
+ PROJECT_BRIEF = "A cross-platform user library to access USB devices"
48
+
49
+ # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50
+ # the documentation. The maximum height of the logo should not exceed 55 pixels
51
+ # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52
+ # to the output directory.
53
+
54
+ PROJECT_LOGO = libusb.png
55
+
56
+ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57
+ # into which the generated documentation will be written. If a relative path is
58
+ # entered, it will be relative to the location where doxygen was started. If
59
+ # left blank the current directory will be used.
60
+
61
+ OUTPUT_DIRECTORY =
62
+
63
+ # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64
+ # directories (in 2 levels) under the output directory of each output format and
65
+ # will distribute the generated files over these directories. Enabling this
66
+ # option can be useful when feeding doxygen a huge amount of source files, where
67
+ # putting all generated files in the same directory would otherwise causes
68
+ # performance problems for the file system.
69
+ # The default value is: NO.
70
+
71
+ CREATE_SUBDIRS = NO
72
+
73
+ # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74
+ # characters to appear in the names of generated files. If set to NO, non-ASCII
75
+ # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76
+ # U+3044.
77
+ # The default value is: NO.
78
+
79
+ ALLOW_UNICODE_NAMES = NO
80
+
81
+ # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82
+ # documentation generated by doxygen is written. Doxygen will use this
83
+ # information to generate all constant output in the proper language.
84
+ # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85
+ # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86
+ # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87
+ # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88
+ # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89
+ # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90
+ # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91
+ # Ukrainian and Vietnamese.
92
+ # The default value is: English.
93
+
94
+ OUTPUT_LANGUAGE = English
95
+
96
+ # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
97
+ # descriptions after the members that are listed in the file and class
98
+ # documentation (similar to Javadoc). Set to NO to disable this.
99
+ # The default value is: YES.
100
+
101
+ BRIEF_MEMBER_DESC = YES
102
+
103
+ # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
104
+ # description of a member or function before the detailed description
105
+ #
106
+ # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107
+ # brief descriptions will be completely suppressed.
108
+ # The default value is: YES.
109
+
110
+ REPEAT_BRIEF = YES
111
+
112
+ # This tag implements a quasi-intelligent brief description abbreviator that is
113
+ # used to form the text in various listings. Each string in this list, if found
114
+ # as the leading text of the brief description, will be stripped from the text
115
+ # and the result, after processing the whole list, is used as the annotated
116
+ # text. Otherwise, the brief description is used as-is. If left blank, the
117
+ # following values are used ($name is automatically replaced with the name of
118
+ # the entity):The $name class, The $name widget, The $name file, is, provides,
119
+ # specifies, contains, represents, a, an and the.
120
+
121
+ ABBREVIATE_BRIEF =
122
+
123
+ # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124
+ # doxygen will generate a detailed section even if there is only a brief
125
+ # description.
126
+ # The default value is: NO.
127
+
128
+ ALWAYS_DETAILED_SEC = NO
129
+
130
+ # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131
+ # inherited members of a class in the documentation of that class as if those
132
+ # members were ordinary class members. Constructors, destructors and assignment
133
+ # operators of the base classes will not be shown.
134
+ # The default value is: NO.
135
+
136
+ INLINE_INHERITED_MEMB = NO
137
+
138
+ # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139
+ # before files name in the file list and in the header files. If set to NO the
140
+ # shortest path that makes the file name unique will be used
141
+ # The default value is: YES.
142
+
143
+ FULL_PATH_NAMES = NO
144
+
145
+ # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146
+ # Stripping is only done if one of the specified strings matches the left-hand
147
+ # part of the path. The tag can be used to show relative paths in the file list.
148
+ # If left blank the directory from which doxygen is run is used as the path to
149
+ # strip.
150
+ #
151
+ # Note that you can specify absolute paths here, but also relative paths, which
152
+ # will be relative from the directory where doxygen is started.
153
+ # This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
+
155
+ STRIP_FROM_PATH =
156
+
157
+ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158
+ # path mentioned in the documentation of a class, which tells the reader which
159
+ # header file to include in order to use a class. If left blank only the name of
160
+ # the header file containing the class definition is used. Otherwise one should
161
+ # specify the list of include paths that are normally passed to the compiler
162
+ # using the -I flag.
163
+
164
+ STRIP_FROM_INC_PATH =
165
+
166
+ # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167
+ # less readable) file names. This can be useful is your file systems doesn't
168
+ # support long names like on DOS, Mac, or CD-ROM.
169
+ # The default value is: NO.
170
+
171
+ SHORT_NAMES = NO
172
+
173
+ # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174
+ # first line (until the first dot) of a Javadoc-style comment as the brief
175
+ # description. If set to NO, the Javadoc-style will behave just like regular Qt-
176
+ # style comments (thus requiring an explicit @brief command for a brief
177
+ # description.)
178
+ # The default value is: NO.
179
+
180
+ JAVADOC_AUTOBRIEF = YES
181
+
182
+ # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183
+ # line (until the first dot) of a Qt-style comment as the brief description. If
184
+ # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185
+ # requiring an explicit \brief command for a brief description.)
186
+ # The default value is: NO.
187
+
188
+ QT_AUTOBRIEF = NO
189
+
190
+ # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191
+ # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192
+ # a brief description. This used to be the default behavior. The new default is
193
+ # to treat a multi-line C++ comment block as a detailed description. Set this
194
+ # tag to YES if you prefer the old behavior instead.
195
+ #
196
+ # Note that setting this tag to YES also means that rational rose comments are
197
+ # not recognized any more.
198
+ # The default value is: NO.
199
+
200
+ MULTILINE_CPP_IS_BRIEF = NO
201
+
202
+ # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203
+ # documentation from any documented member that it re-implements.
204
+ # The default value is: YES.
205
+
206
+ INHERIT_DOCS = YES
207
+
208
+ # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209
+ # new page for each member. If set to NO, the documentation of a member will be
210
+ # part of the file/class/namespace that contains it.
211
+ # The default value is: NO.
212
+
213
+ SEPARATE_MEMBER_PAGES = NO
214
+
215
+ # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216
+ # uses this value to replace tabs by spaces in code fragments.
217
+ # Minimum value: 1, maximum value: 16, default value: 4.
218
+
219
+ TAB_SIZE = 4
220
+
221
+ # This tag can be used to specify a number of aliases that act as commands in
222
+ # the documentation. An alias has the form:
223
+ # name=value
224
+ # For example adding
225
+ # "sideeffect=@par Side Effects:\n"
226
+ # will allow you to put the command \sideeffect (or @sideeffect) in the
227
+ # documentation, which will result in a user-defined paragraph with heading
228
+ # "Side Effects:". You can put \n's in the value part of an alias to insert
229
+ # newlines.
230
+
231
+ ALIASES =
232
+
233
+ # This tag can be used to specify a number of word-keyword mappings (TCL only).
234
+ # A mapping has the form "name=value". For example adding "class=itcl::class"
235
+ # will allow you to use the command class in the itcl::class meaning.
236
+
237
+ TCL_SUBST =
238
+
239
+ # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240
+ # only. Doxygen will then generate output that is more tailored for C. For
241
+ # instance, some of the names that are used will be different. The list of all
242
+ # members will be omitted, etc.
243
+ # The default value is: NO.
244
+
245
+ OPTIMIZE_OUTPUT_FOR_C = YES
246
+
247
+ # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248
+ # Python sources only. Doxygen will then generate output that is more tailored
249
+ # for that language. For instance, namespaces will be presented as packages,
250
+ # qualified scopes will look different, etc.
251
+ # The default value is: NO.
252
+
253
+ OPTIMIZE_OUTPUT_JAVA = NO
254
+
255
+ # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256
+ # sources. Doxygen will then generate output that is tailored for Fortran.
257
+ # The default value is: NO.
258
+
259
+ OPTIMIZE_FOR_FORTRAN = NO
260
+
261
+ # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262
+ # sources. Doxygen will then generate output that is tailored for VHDL.
263
+ # The default value is: NO.
264
+
265
+ OPTIMIZE_OUTPUT_VHDL = NO
266
+
267
+ # Doxygen selects the parser to use depending on the extension of the files it
268
+ # parses. With this tag you can assign which parser to use for a given
269
+ # extension. Doxygen has a built-in mapping, but you can override or extend it
270
+ # using this tag. The format is ext=language, where ext is a file extension, and
271
+ # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272
+ # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273
+ # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274
+ # Fortran. In the later case the parser tries to guess whether the code is fixed
275
+ # or free formatted code, this is the default for Fortran type files), VHDL. For
276
+ # instance to make doxygen treat .inc files as Fortran files (default is PHP),
277
+ # and .f files as C (default is Fortran), use: inc=Fortran f=C.
278
+ #
279
+ # Note For files without extension you can use no_extension as a placeholder.
280
+ #
281
+ # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282
+ # the files are not read by doxygen.
283
+
284
+ EXTENSION_MAPPING =
285
+
286
+ # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287
+ # according to the Markdown format, which allows for more readable
288
+ # documentation. See http://daringfireball.net/projects/markdown/ for details.
289
+ # The output of markdown processing is further processed by doxygen, so you can
290
+ # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291
+ # case of backward compatibilities issues.
292
+ # The default value is: YES.
293
+
294
+ MARKDOWN_SUPPORT = YES
295
+
296
+ # When enabled doxygen tries to link words that correspond to documented
297
+ # classes, or namespaces to their corresponding documentation. Such a link can
298
+ # be prevented in individual cases by by putting a % sign in front of the word
299
+ # or globally by setting AUTOLINK_SUPPORT to NO.
300
+ # The default value is: YES.
301
+
302
+ AUTOLINK_SUPPORT = YES
303
+
304
+ # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305
+ # to include (a tag file for) the STL sources as input, then you should set this
306
+ # tag to YES in order to let doxygen match functions declarations and
307
+ # definitions whose arguments contain STL classes (e.g. func(std::string);
308
+ # versus func(std::string) {}). This also make the inheritance and collaboration
309
+ # diagrams that involve STL classes more complete and accurate.
310
+ # The default value is: NO.
311
+
312
+ BUILTIN_STL_SUPPORT = NO
313
+
314
+ # If you use Microsoft's C++/CLI language, you should set this option to YES to
315
+ # enable parsing support.
316
+ # The default value is: NO.
317
+
318
+ CPP_CLI_SUPPORT = NO
319
+
320
+ # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321
+ # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322
+ # will parse them like normal C++ but will assume all classes use public instead
323
+ # of private inheritance when no explicit protection keyword is present.
324
+ # The default value is: NO.
325
+
326
+ SIP_SUPPORT = NO
327
+
328
+ # For Microsoft's IDL there are propget and propput attributes to indicate
329
+ # getter and setter methods for a property. Setting this option to YES will make
330
+ # doxygen to replace the get and set methods by a property in the documentation.
331
+ # This will only work if the methods are indeed getting or setting a simple
332
+ # type. If this is not the case, or you want to show the methods anyway, you
333
+ # should set this option to NO.
334
+ # The default value is: YES.
335
+
336
+ IDL_PROPERTY_SUPPORT = YES
337
+
338
+ # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339
+ # tag is set to YES, then doxygen will reuse the documentation of the first
340
+ # member in the group (if any) for the other members of the group. By default
341
+ # all members of a group must be documented explicitly.
342
+ # The default value is: NO.
343
+
344
+ DISTRIBUTE_GROUP_DOC = NO
345
+
346
+ # Set the SUBGROUPING tag to YES to allow class member groups of the same type
347
+ # (for instance a group of public functions) to be put as a subgroup of that
348
+ # type (e.g. under the Public Functions section). Set it to NO to prevent
349
+ # subgrouping. Alternatively, this can be done per class using the
350
+ # \nosubgrouping command.
351
+ # The default value is: YES.
352
+
353
+ SUBGROUPING = YES
354
+
355
+ # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356
+ # are shown inside the group in which they are included (e.g. using \ingroup)
357
+ # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
358
+ # and RTF).
359
+ #
360
+ # Note that this feature does not work in combination with
361
+ # SEPARATE_MEMBER_PAGES.
362
+ # The default value is: NO.
363
+
364
+ INLINE_GROUPED_CLASSES = NO
365
+
366
+ # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
367
+ # with only public data fields or simple typedef fields will be shown inline in
368
+ # the documentation of the scope in which they are defined (i.e. file,
369
+ # namespace, or group documentation), provided this scope is documented. If set
370
+ # to NO, structs, classes, and unions are shown on a separate page (for HTML and
371
+ # Man pages) or section (for LaTeX and RTF).
372
+ # The default value is: NO.
373
+
374
+ INLINE_SIMPLE_STRUCTS = NO
375
+
376
+ # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
377
+ # enum is documented as struct, union, or enum with the name of the typedef. So
378
+ # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379
+ # with name TypeT. When disabled the typedef will appear as a member of a file,
380
+ # namespace, or class. And the struct will be named TypeS. This can typically be
381
+ # useful for C code in case the coding convention dictates that all compound
382
+ # types are typedef'ed and only the typedef is referenced, never the tag name.
383
+ # The default value is: NO.
384
+
385
+ TYPEDEF_HIDES_STRUCT = NO
386
+
387
+ # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
388
+ # cache is used to resolve symbols given their name and scope. Since this can be
389
+ # an expensive process and often the same symbol appears multiple times in the
390
+ # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391
+ # doxygen will become slower. If the cache is too large, memory is wasted. The
392
+ # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393
+ # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394
+ # symbols. At the end of a run doxygen will report the cache usage and suggest
395
+ # the optimal cache size from a speed point of view.
396
+ # Minimum value: 0, maximum value: 9, default value: 0.
397
+
398
+ LOOKUP_CACHE_SIZE = 0
399
+
400
+ #---------------------------------------------------------------------------
401
+ # Build related configuration options
402
+ #---------------------------------------------------------------------------
403
+
404
+ # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
405
+ # documentation are documented, even if no documentation was available. Private
406
+ # class members and static file members will be hidden unless the
407
+ # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
408
+ # Note: This will also disable the warnings about undocumented members that are
409
+ # normally produced when WARNINGS is set to YES.
410
+ # The default value is: NO.
411
+
412
+ EXTRACT_ALL = NO
413
+
414
+ # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
415
+ # be included in the documentation.
416
+ # The default value is: NO.
417
+
418
+ EXTRACT_PRIVATE = NO
419
+
420
+ # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
421
+ # scope will be included in the documentation.
422
+ # The default value is: NO.
423
+
424
+ EXTRACT_PACKAGE = NO
425
+
426
+ # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
427
+ # included in the documentation.
428
+ # The default value is: NO.
429
+
430
+ EXTRACT_STATIC = YES
431
+
432
+ # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
433
+ # locally in source files will be included in the documentation. If set to NO
434
+ # only classes defined in header files are included. Does not have any effect
435
+ # for Java sources.
436
+ # The default value is: YES.
437
+
438
+ EXTRACT_LOCAL_CLASSES = YES
439
+
440
+ # This flag is only useful for Objective-C code. When set to YES local methods,
441
+ # which are defined in the implementation section but not in the interface are
442
+ # included in the documentation. If set to NO only methods in the interface are
443
+ # included.
444
+ # The default value is: NO.
445
+
446
+ EXTRACT_LOCAL_METHODS = NO
447
+
448
+ # If this flag is set to YES, the members of anonymous namespaces will be
449
+ # extracted and appear in the documentation as a namespace called
450
+ # 'anonymous_namespace{file}', where file will be replaced with the base name of
451
+ # the file that contains the anonymous namespace. By default anonymous namespace
452
+ # are hidden.
453
+ # The default value is: NO.
454
+
455
+ EXTRACT_ANON_NSPACES = NO
456
+
457
+ # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
458
+ # undocumented members inside documented classes or files. If set to NO these
459
+ # members will be included in the various overviews, but no documentation
460
+ # section is generated. This option has no effect if EXTRACT_ALL is enabled.
461
+ # The default value is: NO.
462
+
463
+ HIDE_UNDOC_MEMBERS = NO
464
+
465
+ # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466
+ # undocumented classes that are normally visible in the class hierarchy. If set
467
+ # to NO these classes will be included in the various overviews. This option has
468
+ # no effect if EXTRACT_ALL is enabled.
469
+ # The default value is: NO.
470
+
471
+ HIDE_UNDOC_CLASSES = NO
472
+
473
+ # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
474
+ # (class|struct|union) declarations. If set to NO these declarations will be
475
+ # included in the documentation.
476
+ # The default value is: NO.
477
+
478
+ HIDE_FRIEND_COMPOUNDS = NO
479
+
480
+ # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
481
+ # documentation blocks found inside the body of a function. If set to NO these
482
+ # blocks will be appended to the function's detailed documentation block.
483
+ # The default value is: NO.
484
+
485
+ HIDE_IN_BODY_DOCS = NO
486
+
487
+ # The INTERNAL_DOCS tag determines if documentation that is typed after a
488
+ # \internal command is included. If the tag is set to NO then the documentation
489
+ # will be excluded. Set it to YES to include the internal documentation.
490
+ # The default value is: NO.
491
+
492
+ INTERNAL_DOCS = NO
493
+
494
+ # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
495
+ # names in lower-case letters. If set to YES upper-case letters are also
496
+ # allowed. This is useful if you have classes or files whose names only differ
497
+ # in case and if your file system supports case sensitive file names. Windows
498
+ # and Mac users are advised to set this option to NO.
499
+ # The default value is: system dependent.
500
+
501
+ CASE_SENSE_NAMES = YES
502
+
503
+ # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
504
+ # their full class and namespace scopes in the documentation. If set to YES the
505
+ # scope will be hidden.
506
+ # The default value is: NO.
507
+
508
+ HIDE_SCOPE_NAMES = NO
509
+
510
+ # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
511
+ # the files that are included by a file in the documentation of that file.
512
+ # The default value is: YES.
513
+
514
+ SHOW_INCLUDE_FILES = YES
515
+
516
+ # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
517
+ # grouped member an include statement to the documentation, telling the reader
518
+ # which file to include in order to use the member.
519
+ # The default value is: NO.
520
+
521
+ SHOW_GROUPED_MEMB_INC = NO
522
+
523
+ # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
524
+ # files with double quotes in the documentation rather than with sharp brackets.
525
+ # The default value is: NO.
526
+
527
+ FORCE_LOCAL_INCLUDES = NO
528
+
529
+ # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
530
+ # documentation for inline members.
531
+ # The default value is: YES.
532
+
533
+ INLINE_INFO = YES
534
+
535
+ # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
536
+ # (detailed) documentation of file and class members alphabetically by member
537
+ # name. If set to NO the members will appear in declaration order.
538
+ # The default value is: YES.
539
+
540
+ SORT_MEMBER_DOCS = NO
541
+
542
+ # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
543
+ # descriptions of file, namespace and class members alphabetically by member
544
+ # name. If set to NO the members will appear in declaration order. Note that
545
+ # this will also influence the order of the classes in the class list.
546
+ # The default value is: NO.
547
+
548
+ SORT_BRIEF_DOCS = NO
549
+
550
+ # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
551
+ # (brief and detailed) documentation of class members so that constructors and
552
+ # destructors are listed first. If set to NO the constructors will appear in the
553
+ # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
554
+ # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
555
+ # member documentation.
556
+ # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
557
+ # detailed member documentation.
558
+ # The default value is: NO.
559
+
560
+ SORT_MEMBERS_CTORS_1ST = NO
561
+
562
+ # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
563
+ # of group names into alphabetical order. If set to NO the group names will
564
+ # appear in their defined order.
565
+ # The default value is: NO.
566
+
567
+ SORT_GROUP_NAMES = NO
568
+
569
+ # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
570
+ # fully-qualified names, including namespaces. If set to NO, the class list will
571
+ # be sorted only by class name, not including the namespace part.
572
+ # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
573
+ # Note: This option applies only to the class list, not to the alphabetical
574
+ # list.
575
+ # The default value is: NO.
576
+
577
+ SORT_BY_SCOPE_NAME = NO
578
+
579
+ # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
580
+ # type resolution of all parameters of a function it will reject a match between
581
+ # the prototype and the implementation of a member function even if there is
582
+ # only one candidate or it is obvious which candidate to choose by doing a
583
+ # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
584
+ # accept a match between prototype and implementation in such cases.
585
+ # The default value is: NO.
586
+
587
+ STRICT_PROTO_MATCHING = NO
588
+
589
+ # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
590
+ # todo list. This list is created by putting \todo commands in the
591
+ # documentation.
592
+ # The default value is: YES.
593
+
594
+ GENERATE_TODOLIST = YES
595
+
596
+ # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
597
+ # test list. This list is created by putting \test commands in the
598
+ # documentation.
599
+ # The default value is: YES.
600
+
601
+ GENERATE_TESTLIST = YES
602
+
603
+ # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
604
+ # list. This list is created by putting \bug commands in the documentation.
605
+ # The default value is: YES.
606
+
607
+ GENERATE_BUGLIST = YES
608
+
609
+ # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
610
+ # the deprecated list. This list is created by putting \deprecated commands in
611
+ # the documentation.
612
+ # The default value is: YES.
613
+
614
+ GENERATE_DEPRECATEDLIST= YES
615
+
616
+ # The ENABLED_SECTIONS tag can be used to enable conditional documentation
617
+ # sections, marked by \if <section_label> ... \endif and \cond <section_label>
618
+ # ... \endcond blocks.
619
+
620
+ ENABLED_SECTIONS =
621
+
622
+ # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
623
+ # initial value of a variable or macro / define can have for it to appear in the
624
+ # documentation. If the initializer consists of more lines than specified here
625
+ # it will be hidden. Use a value of 0 to hide initializers completely. The
626
+ # appearance of the value of individual variables and macros / defines can be
627
+ # controlled using \showinitializer or \hideinitializer command in the
628
+ # documentation regardless of this setting.
629
+ # Minimum value: 0, maximum value: 10000, default value: 30.
630
+
631
+ MAX_INITIALIZER_LINES = 30
632
+
633
+ # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
634
+ # the bottom of the documentation of classes and structs. If set to YES the list
635
+ # will mention the files that were used to generate the documentation.
636
+ # The default value is: YES.
637
+
638
+ SHOW_USED_FILES = YES
639
+
640
+ # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
641
+ # will remove the Files entry from the Quick Index and from the Folder Tree View
642
+ # (if specified).
643
+ # The default value is: YES.
644
+
645
+ SHOW_FILES = YES
646
+
647
+ # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
648
+ # page. This will remove the Namespaces entry from the Quick Index and from the
649
+ # Folder Tree View (if specified).
650
+ # The default value is: YES.
651
+
652
+ SHOW_NAMESPACES = YES
653
+
654
+ # The FILE_VERSION_FILTER tag can be used to specify a program or script that
655
+ # doxygen should invoke to get the current version for each file (typically from
656
+ # the version control system). Doxygen will invoke the program by executing (via
657
+ # popen()) the command command input-file, where command is the value of the
658
+ # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
659
+ # by doxygen. Whatever the program writes to standard output is used as the file
660
+ # version. For an example see the documentation.
661
+
662
+ FILE_VERSION_FILTER =
663
+
664
+ # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
665
+ # by doxygen. The layout file controls the global structure of the generated
666
+ # output files in an output format independent way. To create the layout file
667
+ # that represents doxygen's defaults, run doxygen with the -l option. You can
668
+ # optionally specify a file name after the option, if omitted DoxygenLayout.xml
669
+ # will be used as the name of the layout file.
670
+ #
671
+ # Note that if you run doxygen from a directory containing a file called
672
+ # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
673
+ # tag is left empty.
674
+
675
+ LAYOUT_FILE =
676
+
677
+ # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
678
+ # the reference definitions. This must be a list of .bib files. The .bib
679
+ # extension is automatically appended if omitted. This requires the bibtex tool
680
+ # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
681
+ # For LaTeX the style of the bibliography can be controlled using
682
+ # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
683
+ # search path. See also \cite for info how to create references.
684
+
685
+ CITE_BIB_FILES =
686
+
687
+ #---------------------------------------------------------------------------
688
+ # Configuration options related to warning and progress messages
689
+ #---------------------------------------------------------------------------
690
+
691
+ # The QUIET tag can be used to turn on/off the messages that are generated to
692
+ # standard output by doxygen. If QUIET is set to YES this implies that the
693
+ # messages are off.
694
+ # The default value is: NO.
695
+
696
+ QUIET = YES
697
+
698
+ # The WARNINGS tag can be used to turn on/off the warning messages that are
699
+ # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
700
+ # this implies that the warnings are on.
701
+ #
702
+ # Tip: Turn warnings on while writing the documentation.
703
+ # The default value is: YES.
704
+
705
+ WARNINGS = YES
706
+
707
+ # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
708
+ # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
709
+ # will automatically be disabled.
710
+ # The default value is: YES.
711
+
712
+ WARN_IF_UNDOCUMENTED = YES
713
+
714
+ # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
715
+ # potential errors in the documentation, such as not documenting some parameters
716
+ # in a documented function, or documenting parameters that don't exist or using
717
+ # markup commands wrongly.
718
+ # The default value is: YES.
719
+
720
+ WARN_IF_DOC_ERROR = YES
721
+
722
+ # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
723
+ # are documented, but have no documentation for their parameters or return
724
+ # value. If set to NO doxygen will only warn about wrong or incomplete parameter
725
+ # documentation, but not about the absence of documentation.
726
+ # The default value is: NO.
727
+
728
+ WARN_NO_PARAMDOC = NO
729
+
730
+ # The WARN_FORMAT tag determines the format of the warning messages that doxygen
731
+ # can produce. The string should contain the $file, $line, and $text tags, which
732
+ # will be replaced by the file and line number from which the warning originated
733
+ # and the warning text. Optionally the format may contain $version, which will
734
+ # be replaced by the version of the file (if it could be obtained via
735
+ # FILE_VERSION_FILTER)
736
+ # The default value is: $file:$line: $text.
737
+
738
+ WARN_FORMAT = "$file:$line: $text"
739
+
740
+ # The WARN_LOGFILE tag can be used to specify a file to which warning and error
741
+ # messages should be written. If left blank the output is written to standard
742
+ # error (stderr).
743
+
744
+ WARN_LOGFILE =
745
+
746
+ #---------------------------------------------------------------------------
747
+ # Configuration options related to the input files
748
+ #---------------------------------------------------------------------------
749
+
750
+ # The INPUT tag is used to specify the files and/or directories that contain
751
+ # documented source files. You may enter file names like myfile.cpp or
752
+ # directories like /usr/src/myproject. Separate the files or directories with
753
+ # spaces.
754
+ # Note: If this tag is empty the current directory is searched.
755
+
756
+ INPUT = @top_srcdir@/libusb
757
+
758
+ # This tag can be used to specify the character encoding of the source files
759
+ # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
760
+ # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
761
+ # documentation (see: http://www.gnu.org/software/libiconv) for the list of
762
+ # possible encodings.
763
+ # The default value is: UTF-8.
764
+
765
+ INPUT_ENCODING = UTF-8
766
+
767
+ # If the value of the INPUT tag contains directories, you can use the
768
+ # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
769
+ # *.h) to filter out the source-files in the directories. If left blank the
770
+ # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
771
+ # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
772
+ # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
773
+ # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
774
+ # *.qsf, *.as and *.js.
775
+
776
+ FILE_PATTERNS =
777
+
778
+ # The RECURSIVE tag can be used to specify whether or not subdirectories should
779
+ # be searched for input files as well.
780
+ # The default value is: NO.
781
+
782
+ RECURSIVE = NO
783
+
784
+ # The EXCLUDE tag can be used to specify files and/or directories that should be
785
+ # excluded from the INPUT source files. This way you can easily exclude a
786
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
787
+ #
788
+ # Note that relative paths are relative to the directory from which doxygen is
789
+ # run.
790
+
791
+ EXCLUDE = @top_srcdir@/libusb/libusbi.h \
792
+ @top_srcdir@/libusb/hotplug.h
793
+
794
+ # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
795
+ # directories that are symbolic links (a Unix file system feature) are excluded
796
+ # from the input.
797
+ # The default value is: NO.
798
+
799
+ EXCLUDE_SYMLINKS = NO
800
+
801
+ # If the value of the INPUT tag contains directories, you can use the
802
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
803
+ # certain files from those directories.
804
+ #
805
+ # Note that the wildcards are matched against the file with absolute path, so to
806
+ # exclude all test directories for example use the pattern */test/*
807
+
808
+ EXCLUDE_PATTERNS =
809
+
810
+ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
811
+ # (namespaces, classes, functions, etc.) that should be excluded from the
812
+ # output. The symbol name can be a fully qualified name, a word, or if the
813
+ # wildcard * is used, a substring. Examples: ANamespace, AClass,
814
+ # AClass::ANamespace, ANamespace::*Test
815
+ #
816
+ # Note that the wildcards are matched against the file with absolute path, so to
817
+ # exclude all test directories use the pattern */test/*
818
+
819
+ EXCLUDE_SYMBOLS =
820
+
821
+ # The EXAMPLE_PATH tag can be used to specify one or more files or directories
822
+ # that contain example code fragments that are included (see the \include
823
+ # command).
824
+
825
+ EXAMPLE_PATH =
826
+
827
+ # If the value of the EXAMPLE_PATH tag contains directories, you can use the
828
+ # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
829
+ # *.h) to filter out the source-files in the directories. If left blank all
830
+ # files are included.
831
+
832
+ EXAMPLE_PATTERNS =
833
+
834
+ # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
835
+ # searched for input files to be used with the \include or \dontinclude commands
836
+ # irrespective of the value of the RECURSIVE tag.
837
+ # The default value is: NO.
838
+
839
+ EXAMPLE_RECURSIVE = NO
840
+
841
+ # The IMAGE_PATH tag can be used to specify one or more files or directories
842
+ # that contain images that are to be included in the documentation (see the
843
+ # \image command).
844
+
845
+ IMAGE_PATH =
846
+
847
+ # The INPUT_FILTER tag can be used to specify a program that doxygen should
848
+ # invoke to filter for each input file. Doxygen will invoke the filter program
849
+ # by executing (via popen()) the command:
850
+ #
851
+ # <filter> <input-file>
852
+ #
853
+ # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
854
+ # name of an input file. Doxygen will then use the output that the filter
855
+ # program writes to standard output. If FILTER_PATTERNS is specified, this tag
856
+ # will be ignored.
857
+ #
858
+ # Note that the filter must not add or remove lines; it is applied before the
859
+ # code is scanned, but not when the output code is generated. If lines are added
860
+ # or removed, the anchors will not be placed correctly.
861
+
862
+ INPUT_FILTER =
863
+
864
+ # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
865
+ # basis. Doxygen will compare the file name with each pattern and apply the
866
+ # filter if there is a match. The filters are a list of the form: pattern=filter
867
+ # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
868
+ # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
869
+ # patterns match the file name, INPUT_FILTER is applied.
870
+
871
+ FILTER_PATTERNS =
872
+
873
+ # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
874
+ # INPUT_FILTER ) will also be used to filter the input files that are used for
875
+ # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
876
+ # The default value is: NO.
877
+
878
+ FILTER_SOURCE_FILES = NO
879
+
880
+ # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
881
+ # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
882
+ # it is also possible to disable source filtering for a specific pattern using
883
+ # *.ext= (so without naming a filter).
884
+ # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
885
+
886
+ FILTER_SOURCE_PATTERNS =
887
+
888
+ # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
889
+ # is part of the input, its contents will be placed on the main page
890
+ # (index.html). This can be useful if you have a project on for instance GitHub
891
+ # and want to reuse the introduction page also for the doxygen output.
892
+
893
+ USE_MDFILE_AS_MAINPAGE =
894
+
895
+ #---------------------------------------------------------------------------
896
+ # Configuration options related to source browsing
897
+ #---------------------------------------------------------------------------
898
+
899
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
900
+ # generated. Documented entities will be cross-referenced with these sources.
901
+ #
902
+ # Note: To get rid of all source code in the generated output, make sure that
903
+ # also VERBATIM_HEADERS is set to NO.
904
+ # The default value is: NO.
905
+
906
+ SOURCE_BROWSER = NO
907
+
908
+ # Setting the INLINE_SOURCES tag to YES will include the body of functions,
909
+ # classes and enums directly into the documentation.
910
+ # The default value is: NO.
911
+
912
+ INLINE_SOURCES = NO
913
+
914
+ # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
915
+ # special comment blocks from generated source code fragments. Normal C, C++ and
916
+ # Fortran comments will always remain visible.
917
+ # The default value is: YES.
918
+
919
+ STRIP_CODE_COMMENTS = YES
920
+
921
+ # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
922
+ # function all documented functions referencing it will be listed.
923
+ # The default value is: NO.
924
+
925
+ REFERENCED_BY_RELATION = NO
926
+
927
+ # If the REFERENCES_RELATION tag is set to YES then for each documented function
928
+ # all documented entities called/used by that function will be listed.
929
+ # The default value is: NO.
930
+
931
+ REFERENCES_RELATION = NO
932
+
933
+ # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
934
+ # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
935
+ # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
936
+ # link to the documentation.
937
+ # The default value is: YES.
938
+
939
+ REFERENCES_LINK_SOURCE = YES
940
+
941
+ # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
942
+ # source code will show a tooltip with additional information such as prototype,
943
+ # brief description and links to the definition and documentation. Since this
944
+ # will make the HTML file larger and loading of large files a bit slower, you
945
+ # can opt to disable this feature.
946
+ # The default value is: YES.
947
+ # This tag requires that the tag SOURCE_BROWSER is set to YES.
948
+
949
+ SOURCE_TOOLTIPS = YES
950
+
951
+ # If the USE_HTAGS tag is set to YES then the references to source code will
952
+ # point to the HTML generated by the htags(1) tool instead of doxygen built-in
953
+ # source browser. The htags tool is part of GNU's global source tagging system
954
+ # (see http://www.gnu.org/software/global/global.html). You will need version
955
+ # 4.8.6 or higher.
956
+ #
957
+ # To use it do the following:
958
+ # - Install the latest version of global
959
+ # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
960
+ # - Make sure the INPUT points to the root of the source tree
961
+ # - Run doxygen as normal
962
+ #
963
+ # Doxygen will invoke htags (and that will in turn invoke gtags), so these
964
+ # tools must be available from the command line (i.e. in the search path).
965
+ #
966
+ # The result: instead of the source browser generated by doxygen, the links to
967
+ # source code will now point to the output of htags.
968
+ # The default value is: NO.
969
+ # This tag requires that the tag SOURCE_BROWSER is set to YES.
970
+
971
+ USE_HTAGS = NO
972
+
973
+ # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
974
+ # verbatim copy of the header file for each class for which an include is
975
+ # specified. Set to NO to disable this.
976
+ # See also: Section \class.
977
+ # The default value is: YES.
978
+
979
+ VERBATIM_HEADERS = YES
980
+
981
+ #---------------------------------------------------------------------------
982
+ # Configuration options related to the alphabetical class index
983
+ #---------------------------------------------------------------------------
984
+
985
+ # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
986
+ # compounds will be generated. Enable this if the project contains a lot of
987
+ # classes, structs, unions or interfaces.
988
+ # The default value is: YES.
989
+
990
+ ALPHABETICAL_INDEX = YES
991
+
992
+ # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
993
+ # which the alphabetical index list will be split.
994
+ # Minimum value: 1, maximum value: 20, default value: 5.
995
+ # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
996
+
997
+ COLS_IN_ALPHA_INDEX = 5
998
+
999
+ # In case all classes in a project start with a common prefix, all classes will
1000
+ # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1001
+ # can be used to specify a prefix (or a list of prefixes) that should be ignored
1002
+ # while generating the index headers.
1003
+ # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1004
+
1005
+ IGNORE_PREFIX =
1006
+
1007
+ #---------------------------------------------------------------------------
1008
+ # Configuration options related to the HTML output
1009
+ #---------------------------------------------------------------------------
1010
+
1011
+ # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1012
+ # The default value is: YES.
1013
+
1014
+ GENERATE_HTML = YES
1015
+
1016
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1017
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1018
+ # it.
1019
+ # The default directory is: html.
1020
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1021
+
1022
+ HTML_OUTPUT = html
1023
+
1024
+ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1025
+ # generated HTML page (for example: .htm, .php, .asp).
1026
+ # The default value is: .html.
1027
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1028
+
1029
+ HTML_FILE_EXTENSION = .html
1030
+
1031
+ # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1032
+ # each generated HTML page. If the tag is left blank doxygen will generate a
1033
+ # standard header.
1034
+ #
1035
+ # To get valid HTML the header file that includes any scripts and style sheets
1036
+ # that doxygen needs, which is dependent on the configuration options used (e.g.
1037
+ # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1038
+ # default header using
1039
+ # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1040
+ # YourConfigFile
1041
+ # and then modify the file new_header.html. See also section "Doxygen usage"
1042
+ # for information on how to generate the default header that doxygen normally
1043
+ # uses.
1044
+ # Note: The header is subject to change so you typically have to regenerate the
1045
+ # default header when upgrading to a newer version of doxygen. For a description
1046
+ # of the possible markers and block names see the documentation.
1047
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1048
+
1049
+ HTML_HEADER =
1050
+
1051
+ # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1052
+ # generated HTML page. If the tag is left blank doxygen will generate a standard
1053
+ # footer. See HTML_HEADER for more information on how to generate a default
1054
+ # footer and what special commands can be used inside the footer. See also
1055
+ # section "Doxygen usage" for information on how to generate the default footer
1056
+ # that doxygen normally uses.
1057
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1058
+
1059
+ HTML_FOOTER =
1060
+
1061
+ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1062
+ # sheet that is used by each HTML page. It can be used to fine-tune the look of
1063
+ # the HTML output. If left blank doxygen will generate a default style sheet.
1064
+ # See also section "Doxygen usage" for information on how to generate the style
1065
+ # sheet that doxygen normally uses.
1066
+ # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1067
+ # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1068
+ # obsolete.
1069
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1070
+
1071
+ HTML_STYLESHEET =
1072
+
1073
+ # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1074
+ # cascading style sheets that are included after the standard style sheets
1075
+ # created by doxygen. Using this option one can overrule certain style aspects.
1076
+ # This is preferred over using HTML_STYLESHEET since it does not replace the
1077
+ # standard style sheet and is therefor more robust against future updates.
1078
+ # Doxygen will copy the style sheet files to the output directory.
1079
+ # Note: The order of the extra stylesheet files is of importance (e.g. the last
1080
+ # stylesheet in the list overrules the setting of the previous ones in the
1081
+ # list). For an example see the documentation.
1082
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1083
+
1084
+ HTML_EXTRA_STYLESHEET =
1085
+
1086
+ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1087
+ # other source files which should be copied to the HTML output directory. Note
1088
+ # that these files will be copied to the base HTML output directory. Use the
1089
+ # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1090
+ # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1091
+ # files will be copied as-is; there are no commands or markers available.
1092
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1093
+
1094
+ HTML_EXTRA_FILES =
1095
+
1096
+ # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1097
+ # will adjust the colors in the stylesheet and background images according to
1098
+ # this color. Hue is specified as an angle on a colorwheel, see
1099
+ # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1100
+ # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1101
+ # purple, and 360 is red again.
1102
+ # Minimum value: 0, maximum value: 359, default value: 220.
1103
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1104
+
1105
+ HTML_COLORSTYLE_HUE = 220
1106
+
1107
+ # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1108
+ # in the HTML output. For a value of 0 the output will use grayscales only. A
1109
+ # value of 255 will produce the most vivid colors.
1110
+ # Minimum value: 0, maximum value: 255, default value: 100.
1111
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1112
+
1113
+ HTML_COLORSTYLE_SAT = 100
1114
+
1115
+ # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1116
+ # luminance component of the colors in the HTML output. Values below 100
1117
+ # gradually make the output lighter, whereas values above 100 make the output
1118
+ # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1119
+ # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1120
+ # change the gamma.
1121
+ # Minimum value: 40, maximum value: 240, default value: 80.
1122
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1123
+
1124
+ HTML_COLORSTYLE_GAMMA = 80
1125
+
1126
+ # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1127
+ # page will contain the date and time when the page was generated. Setting this
1128
+ # to NO can help when comparing the output of multiple runs.
1129
+ # The default value is: YES.
1130
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1131
+
1132
+ HTML_TIMESTAMP = YES
1133
+
1134
+ # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1135
+ # documentation will contain sections that can be hidden and shown after the
1136
+ # page has loaded.
1137
+ # The default value is: NO.
1138
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1139
+
1140
+ HTML_DYNAMIC_SECTIONS = YES
1141
+
1142
+ # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1143
+ # shown in the various tree structured indices initially; the user can expand
1144
+ # and collapse entries dynamically later on. Doxygen will expand the tree to
1145
+ # such a level that at most the specified number of entries are visible (unless
1146
+ # a fully collapsed tree already exceeds this amount). So setting the number of
1147
+ # entries 1 will produce a full collapsed tree by default. 0 is a special value
1148
+ # representing an infinite number of entries and will result in a full expanded
1149
+ # tree by default.
1150
+ # Minimum value: 0, maximum value: 9999, default value: 100.
1151
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1152
+
1153
+ HTML_INDEX_NUM_ENTRIES = 100
1154
+
1155
+ # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1156
+ # generated that can be used as input for Apple's Xcode 3 integrated development
1157
+ # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1158
+ # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1159
+ # Makefile in the HTML output directory. Running make will produce the docset in
1160
+ # that directory and running make install will install the docset in
1161
+ # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1162
+ # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1163
+ # for more information.
1164
+ # The default value is: NO.
1165
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1166
+
1167
+ GENERATE_DOCSET = NO
1168
+
1169
+ # This tag determines the name of the docset feed. A documentation feed provides
1170
+ # an umbrella under which multiple documentation sets from a single provider
1171
+ # (such as a company or product suite) can be grouped.
1172
+ # The default value is: Doxygen generated docs.
1173
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1174
+
1175
+ DOCSET_FEEDNAME = "Doxygen generated docs"
1176
+
1177
+ # This tag specifies a string that should uniquely identify the documentation
1178
+ # set bundle. This should be a reverse domain-name style string, e.g.
1179
+ # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1180
+ # The default value is: org.doxygen.Project.
1181
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1182
+
1183
+ DOCSET_BUNDLE_ID = org.doxygen.Project
1184
+
1185
+ # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1186
+ # the documentation publisher. This should be a reverse domain-name style
1187
+ # string, e.g. com.mycompany.MyDocSet.documentation.
1188
+ # The default value is: org.doxygen.Publisher.
1189
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1190
+
1191
+ DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1192
+
1193
+ # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1194
+ # The default value is: Publisher.
1195
+ # This tag requires that the tag GENERATE_DOCSET is set to YES.
1196
+
1197
+ DOCSET_PUBLISHER_NAME = Publisher
1198
+
1199
+ # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1200
+ # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1201
+ # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1202
+ # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1203
+ # Windows.
1204
+ #
1205
+ # The HTML Help Workshop contains a compiler that can convert all HTML output
1206
+ # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1207
+ # files are now used as the Windows 98 help format, and will replace the old
1208
+ # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1209
+ # HTML files also contain an index, a table of contents, and you can search for
1210
+ # words in the documentation. The HTML workshop also contains a viewer for
1211
+ # compressed HTML files.
1212
+ # The default value is: NO.
1213
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1214
+
1215
+ GENERATE_HTMLHELP = NO
1216
+
1217
+ # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1218
+ # file. You can add a path in front of the file if the result should not be
1219
+ # written to the html output directory.
1220
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1221
+
1222
+ CHM_FILE =
1223
+
1224
+ # The HHC_LOCATION tag can be used to specify the location (absolute path
1225
+ # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1226
+ # doxygen will try to run the HTML help compiler on the generated index.hhp.
1227
+ # The file has to be specified with full path.
1228
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1229
+
1230
+ HHC_LOCATION =
1231
+
1232
+ # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1233
+ # YES) or that it should be included in the master .chm file ( NO).
1234
+ # The default value is: NO.
1235
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1236
+
1237
+ GENERATE_CHI = NO
1238
+
1239
+ # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1240
+ # and project file content.
1241
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1242
+
1243
+ CHM_INDEX_ENCODING =
1244
+
1245
+ # The BINARY_TOC flag controls whether a binary table of contents is generated (
1246
+ # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1247
+ # enables the Previous and Next buttons.
1248
+ # The default value is: NO.
1249
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1250
+
1251
+ BINARY_TOC = NO
1252
+
1253
+ # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1254
+ # the table of contents of the HTML help documentation and to the tree view.
1255
+ # The default value is: NO.
1256
+ # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1257
+
1258
+ TOC_EXPAND = NO
1259
+
1260
+ # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1261
+ # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1262
+ # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1263
+ # (.qch) of the generated HTML documentation.
1264
+ # The default value is: NO.
1265
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1266
+
1267
+ GENERATE_QHP = NO
1268
+
1269
+ # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1270
+ # the file name of the resulting .qch file. The path specified is relative to
1271
+ # the HTML output folder.
1272
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1273
+
1274
+ QCH_FILE =
1275
+
1276
+ # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1277
+ # Project output. For more information please see Qt Help Project / Namespace
1278
+ # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1279
+ # The default value is: org.doxygen.Project.
1280
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1281
+
1282
+ QHP_NAMESPACE = org.doxygen.Project
1283
+
1284
+ # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1285
+ # Help Project output. For more information please see Qt Help Project / Virtual
1286
+ # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1287
+ # folders).
1288
+ # The default value is: doc.
1289
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1290
+
1291
+ QHP_VIRTUAL_FOLDER = doc
1292
+
1293
+ # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1294
+ # filter to add. For more information please see Qt Help Project / Custom
1295
+ # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1296
+ # filters).
1297
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1298
+
1299
+ QHP_CUST_FILTER_NAME =
1300
+
1301
+ # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1302
+ # custom filter to add. For more information please see Qt Help Project / Custom
1303
+ # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1304
+ # filters).
1305
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1306
+
1307
+ QHP_CUST_FILTER_ATTRS =
1308
+
1309
+ # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1310
+ # project's filter section matches. Qt Help Project / Filter Attributes (see:
1311
+ # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1312
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1313
+
1314
+ QHP_SECT_FILTER_ATTRS =
1315
+
1316
+ # The QHG_LOCATION tag can be used to specify the location of Qt's
1317
+ # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1318
+ # generated .qhp file.
1319
+ # This tag requires that the tag GENERATE_QHP is set to YES.
1320
+
1321
+ QHG_LOCATION =
1322
+
1323
+ # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1324
+ # generated, together with the HTML files, they form an Eclipse help plugin. To
1325
+ # install this plugin and make it available under the help contents menu in
1326
+ # Eclipse, the contents of the directory containing the HTML and XML files needs
1327
+ # to be copied into the plugins directory of eclipse. The name of the directory
1328
+ # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1329
+ # After copying Eclipse needs to be restarted before the help appears.
1330
+ # The default value is: NO.
1331
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1332
+
1333
+ GENERATE_ECLIPSEHELP = NO
1334
+
1335
+ # A unique identifier for the Eclipse help plugin. When installing the plugin
1336
+ # the directory name containing the HTML and XML files should also have this
1337
+ # name. Each documentation set should have its own identifier.
1338
+ # The default value is: org.doxygen.Project.
1339
+ # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1340
+
1341
+ ECLIPSE_DOC_ID = org.doxygen.Project
1342
+
1343
+ # If you want full control over the layout of the generated HTML pages it might
1344
+ # be necessary to disable the index and replace it with your own. The
1345
+ # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1346
+ # of each HTML page. A value of NO enables the index and the value YES disables
1347
+ # it. Since the tabs in the index contain the same information as the navigation
1348
+ # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1349
+ # The default value is: NO.
1350
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1351
+
1352
+ DISABLE_INDEX = NO
1353
+
1354
+ # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1355
+ # structure should be generated to display hierarchical information. If the tag
1356
+ # value is set to YES, a side panel will be generated containing a tree-like
1357
+ # index structure (just like the one that is generated for HTML Help). For this
1358
+ # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1359
+ # (i.e. any modern browser). Windows users are probably better off using the
1360
+ # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1361
+ # further fine-tune the look of the index. As an example, the default style
1362
+ # sheet generated by doxygen has an example that shows how to put an image at
1363
+ # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1364
+ # the same information as the tab index, you could consider setting
1365
+ # DISABLE_INDEX to YES when enabling this option.
1366
+ # The default value is: NO.
1367
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1368
+
1369
+ GENERATE_TREEVIEW = NO
1370
+
1371
+ # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1372
+ # doxygen will group on one line in the generated HTML documentation.
1373
+ #
1374
+ # Note that a value of 0 will completely suppress the enum values from appearing
1375
+ # in the overview section.
1376
+ # Minimum value: 0, maximum value: 20, default value: 4.
1377
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1378
+
1379
+ ENUM_VALUES_PER_LINE = 4
1380
+
1381
+ # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1382
+ # to set the initial width (in pixels) of the frame in which the tree is shown.
1383
+ # Minimum value: 0, maximum value: 1500, default value: 250.
1384
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1385
+
1386
+ TREEVIEW_WIDTH = 250
1387
+
1388
+ # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1389
+ # external symbols imported via tag files in a separate window.
1390
+ # The default value is: NO.
1391
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1392
+
1393
+ EXT_LINKS_IN_WINDOW = NO
1394
+
1395
+ # Use this tag to change the font size of LaTeX formulas included as images in
1396
+ # the HTML documentation. When you change the font size after a successful
1397
+ # doxygen run you need to manually remove any form_*.png images from the HTML
1398
+ # output directory to force them to be regenerated.
1399
+ # Minimum value: 8, maximum value: 50, default value: 10.
1400
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1401
+
1402
+ FORMULA_FONTSIZE = 10
1403
+
1404
+ # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1405
+ # generated for formulas are transparent PNGs. Transparent PNGs are not
1406
+ # supported properly for IE 6.0, but are supported on all modern browsers.
1407
+ #
1408
+ # Note that when changing this option you need to delete any form_*.png files in
1409
+ # the HTML output directory before the changes have effect.
1410
+ # The default value is: YES.
1411
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1412
+
1413
+ FORMULA_TRANSPARENT = YES
1414
+
1415
+ # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1416
+ # http://www.mathjax.org) which uses client side Javascript for the rendering
1417
+ # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1418
+ # installed or if you want to formulas look prettier in the HTML output. When
1419
+ # enabled you may also need to install MathJax separately and configure the path
1420
+ # to it using the MATHJAX_RELPATH option.
1421
+ # The default value is: NO.
1422
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1423
+
1424
+ USE_MATHJAX = NO
1425
+
1426
+ # When MathJax is enabled you can set the default output format to be used for
1427
+ # the MathJax output. See the MathJax site (see:
1428
+ # http://docs.mathjax.org/en/latest/output.html) for more details.
1429
+ # Possible values are: HTML-CSS (which is slower, but has the best
1430
+ # compatibility), NativeMML (i.e. MathML) and SVG.
1431
+ # The default value is: HTML-CSS.
1432
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1433
+
1434
+ MATHJAX_FORMAT = HTML-CSS
1435
+
1436
+ # When MathJax is enabled you need to specify the location relative to the HTML
1437
+ # output directory using the MATHJAX_RELPATH option. The destination directory
1438
+ # should contain the MathJax.js script. For instance, if the mathjax directory
1439
+ # is located at the same level as the HTML output directory, then
1440
+ # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1441
+ # Content Delivery Network so you can quickly see the result without installing
1442
+ # MathJax. However, it is strongly recommended to install a local copy of
1443
+ # MathJax from http://www.mathjax.org before deployment.
1444
+ # The default value is: http://cdn.mathjax.org/mathjax/latest.
1445
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1446
+
1447
+ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1448
+
1449
+ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1450
+ # extension names that should be enabled during MathJax rendering. For example
1451
+ # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1452
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1453
+
1454
+ MATHJAX_EXTENSIONS =
1455
+
1456
+ # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1457
+ # of code that will be used on startup of the MathJax code. See the MathJax site
1458
+ # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1459
+ # example see the documentation.
1460
+ # This tag requires that the tag USE_MATHJAX is set to YES.
1461
+
1462
+ MATHJAX_CODEFILE =
1463
+
1464
+ # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1465
+ # the HTML output. The underlying search engine uses javascript and DHTML and
1466
+ # should work on any modern browser. Note that when using HTML help
1467
+ # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1468
+ # there is already a search function so this one should typically be disabled.
1469
+ # For large projects the javascript based search engine can be slow, then
1470
+ # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1471
+ # search using the keyboard; to jump to the search box use <access key> + S
1472
+ # (what the <access key> is depends on the OS and browser, but it is typically
1473
+ # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1474
+ # key> to jump into the search results window, the results can be navigated
1475
+ # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1476
+ # the search. The filter options can be selected when the cursor is inside the
1477
+ # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1478
+ # to select a filter and <Enter> or <escape> to activate or cancel the filter
1479
+ # option.
1480
+ # The default value is: YES.
1481
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1482
+
1483
+ SEARCHENGINE = NO
1484
+
1485
+ # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1486
+ # implemented using a web server instead of a web client using Javascript. There
1487
+ # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1488
+ # setting. When disabled, doxygen will generate a PHP script for searching and
1489
+ # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1490
+ # and searching needs to be provided by external tools. See the section
1491
+ # "External Indexing and Searching" for details.
1492
+ # The default value is: NO.
1493
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1494
+
1495
+ SERVER_BASED_SEARCH = NO
1496
+
1497
+ # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1498
+ # script for searching. Instead the search results are written to an XML file
1499
+ # which needs to be processed by an external indexer. Doxygen will invoke an
1500
+ # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1501
+ # search results.
1502
+ #
1503
+ # Doxygen ships with an example indexer ( doxyindexer) and search engine
1504
+ # (doxysearch.cgi) which are based on the open source search engine library
1505
+ # Xapian (see: http://xapian.org/).
1506
+ #
1507
+ # See the section "External Indexing and Searching" for details.
1508
+ # The default value is: NO.
1509
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1510
+
1511
+ EXTERNAL_SEARCH = NO
1512
+
1513
+ # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1514
+ # which will return the search results when EXTERNAL_SEARCH is enabled.
1515
+ #
1516
+ # Doxygen ships with an example indexer ( doxyindexer) and search engine
1517
+ # (doxysearch.cgi) which are based on the open source search engine library
1518
+ # Xapian (see: http://xapian.org/). See the section "External Indexing and
1519
+ # Searching" for details.
1520
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1521
+
1522
+ SEARCHENGINE_URL =
1523
+
1524
+ # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1525
+ # search data is written to a file for indexing by an external tool. With the
1526
+ # SEARCHDATA_FILE tag the name of this file can be specified.
1527
+ # The default file is: searchdata.xml.
1528
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1529
+
1530
+ SEARCHDATA_FILE = searchdata.xml
1531
+
1532
+ # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1533
+ # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1534
+ # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1535
+ # projects and redirect the results back to the right project.
1536
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1537
+
1538
+ EXTERNAL_SEARCH_ID =
1539
+
1540
+ # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1541
+ # projects other than the one defined by this configuration file, but that are
1542
+ # all added to the same external search index. Each project needs to have a
1543
+ # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1544
+ # to a relative location where the documentation can be found. The format is:
1545
+ # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1546
+ # This tag requires that the tag SEARCHENGINE is set to YES.
1547
+
1548
+ EXTRA_SEARCH_MAPPINGS =
1549
+
1550
+ #---------------------------------------------------------------------------
1551
+ # Configuration options related to the LaTeX output
1552
+ #---------------------------------------------------------------------------
1553
+
1554
+ # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1555
+ # The default value is: YES.
1556
+
1557
+ GENERATE_LATEX = NO
1558
+
1559
+ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1560
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1561
+ # it.
1562
+ # The default directory is: latex.
1563
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1564
+
1565
+ LATEX_OUTPUT = latex
1566
+
1567
+ # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1568
+ # invoked.
1569
+ #
1570
+ # Note that when enabling USE_PDFLATEX this option is only used for generating
1571
+ # bitmaps for formulas in the HTML output, but not in the Makefile that is
1572
+ # written to the output directory.
1573
+ # The default file is: latex.
1574
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1575
+
1576
+ LATEX_CMD_NAME = latex
1577
+
1578
+ # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1579
+ # index for LaTeX.
1580
+ # The default file is: makeindex.
1581
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1582
+
1583
+ MAKEINDEX_CMD_NAME = makeindex
1584
+
1585
+ # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1586
+ # documents. This may be useful for small projects and may help to save some
1587
+ # trees in general.
1588
+ # The default value is: NO.
1589
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1590
+
1591
+ COMPACT_LATEX = NO
1592
+
1593
+ # The PAPER_TYPE tag can be used to set the paper type that is used by the
1594
+ # printer.
1595
+ # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1596
+ # 14 inches) and executive (7.25 x 10.5 inches).
1597
+ # The default value is: a4.
1598
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1599
+
1600
+ PAPER_TYPE = a4wide
1601
+
1602
+ # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1603
+ # that should be included in the LaTeX output. To get the times font for
1604
+ # instance you can specify
1605
+ # EXTRA_PACKAGES=times
1606
+ # If left blank no extra packages will be included.
1607
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1608
+
1609
+ EXTRA_PACKAGES =
1610
+
1611
+ # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1612
+ # generated LaTeX document. The header should contain everything until the first
1613
+ # chapter. If it is left blank doxygen will generate a standard header. See
1614
+ # section "Doxygen usage" for information on how to let doxygen write the
1615
+ # default header to a separate file.
1616
+ #
1617
+ # Note: Only use a user-defined header if you know what you are doing! The
1618
+ # following commands have a special meaning inside the header: $title,
1619
+ # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1620
+ # $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
1621
+ # for the replacement values of the other commands the user is refered to
1622
+ # HTML_HEADER.
1623
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1624
+
1625
+ LATEX_HEADER =
1626
+
1627
+ # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1628
+ # generated LaTeX document. The footer should contain everything after the last
1629
+ # chapter. If it is left blank doxygen will generate a standard footer. See
1630
+ # LATEX_HEADER for more information on how to generate a default footer and what
1631
+ # special commands can be used inside the footer.
1632
+ #
1633
+ # Note: Only use a user-defined footer if you know what you are doing!
1634
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1635
+
1636
+ LATEX_FOOTER =
1637
+
1638
+ # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1639
+ # other source files which should be copied to the LATEX_OUTPUT output
1640
+ # directory. Note that the files will be copied as-is; there are no commands or
1641
+ # markers available.
1642
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1643
+
1644
+ LATEX_EXTRA_FILES =
1645
+
1646
+ # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1647
+ # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1648
+ # contain links (just like the HTML output) instead of page references. This
1649
+ # makes the output suitable for online browsing using a PDF viewer.
1650
+ # The default value is: YES.
1651
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1652
+
1653
+ PDF_HYPERLINKS = NO
1654
+
1655
+ # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1656
+ # the PDF file directly from the LaTeX files. Set this option to YES to get a
1657
+ # higher quality PDF documentation.
1658
+ # The default value is: YES.
1659
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1660
+
1661
+ USE_PDFLATEX = NO
1662
+
1663
+ # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1664
+ # command to the generated LaTeX files. This will instruct LaTeX to keep running
1665
+ # if errors occur, instead of asking the user for help. This option is also used
1666
+ # when generating formulas in HTML.
1667
+ # The default value is: NO.
1668
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1669
+
1670
+ LATEX_BATCHMODE = NO
1671
+
1672
+ # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1673
+ # index chapters (such as File Index, Compound Index, etc.) in the output.
1674
+ # The default value is: NO.
1675
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1676
+
1677
+ LATEX_HIDE_INDICES = NO
1678
+
1679
+ # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1680
+ # code with syntax highlighting in the LaTeX output.
1681
+ #
1682
+ # Note that which sources are shown also depends on other settings such as
1683
+ # SOURCE_BROWSER.
1684
+ # The default value is: NO.
1685
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1686
+
1687
+ LATEX_SOURCE_CODE = NO
1688
+
1689
+ # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1690
+ # bibliography, e.g. plainnat, or ieeetr. See
1691
+ # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1692
+ # The default value is: plain.
1693
+ # This tag requires that the tag GENERATE_LATEX is set to YES.
1694
+
1695
+ LATEX_BIB_STYLE = plain
1696
+
1697
+ #---------------------------------------------------------------------------
1698
+ # Configuration options related to the RTF output
1699
+ #---------------------------------------------------------------------------
1700
+
1701
+ # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1702
+ # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1703
+ # readers/editors.
1704
+ # The default value is: NO.
1705
+
1706
+ GENERATE_RTF = NO
1707
+
1708
+ # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1709
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1710
+ # it.
1711
+ # The default directory is: rtf.
1712
+ # This tag requires that the tag GENERATE_RTF is set to YES.
1713
+
1714
+ RTF_OUTPUT = rtf
1715
+
1716
+ # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1717
+ # documents. This may be useful for small projects and may help to save some
1718
+ # trees in general.
1719
+ # The default value is: NO.
1720
+ # This tag requires that the tag GENERATE_RTF is set to YES.
1721
+
1722
+ COMPACT_RTF = NO
1723
+
1724
+ # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1725
+ # contain hyperlink fields. The RTF file will contain links (just like the HTML
1726
+ # output) instead of page references. This makes the output suitable for online
1727
+ # browsing using Word or some other Word compatible readers that support those
1728
+ # fields.
1729
+ #
1730
+ # Note: WordPad (write) and others do not support links.
1731
+ # The default value is: NO.
1732
+ # This tag requires that the tag GENERATE_RTF is set to YES.
1733
+
1734
+ RTF_HYPERLINKS = NO
1735
+
1736
+ # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1737
+ # file, i.e. a series of assignments. You only have to provide replacements,
1738
+ # missing definitions are set to their default value.
1739
+ #
1740
+ # See also section "Doxygen usage" for information on how to generate the
1741
+ # default style sheet that doxygen normally uses.
1742
+ # This tag requires that the tag GENERATE_RTF is set to YES.
1743
+
1744
+ RTF_STYLESHEET_FILE =
1745
+
1746
+ # Set optional variables used in the generation of an RTF document. Syntax is
1747
+ # similar to doxygen's config file. A template extensions file can be generated
1748
+ # using doxygen -e rtf extensionFile.
1749
+ # This tag requires that the tag GENERATE_RTF is set to YES.
1750
+
1751
+ RTF_EXTENSIONS_FILE =
1752
+
1753
+ #---------------------------------------------------------------------------
1754
+ # Configuration options related to the man page output
1755
+ #---------------------------------------------------------------------------
1756
+
1757
+ # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1758
+ # classes and files.
1759
+ # The default value is: NO.
1760
+
1761
+ GENERATE_MAN = NO
1762
+
1763
+ # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1764
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1765
+ # it. A directory man3 will be created inside the directory specified by
1766
+ # MAN_OUTPUT.
1767
+ # The default directory is: man.
1768
+ # This tag requires that the tag GENERATE_MAN is set to YES.
1769
+
1770
+ MAN_OUTPUT = man
1771
+
1772
+ # The MAN_EXTENSION tag determines the extension that is added to the generated
1773
+ # man pages. In case the manual section does not start with a number, the number
1774
+ # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1775
+ # optional.
1776
+ # The default value is: .3.
1777
+ # This tag requires that the tag GENERATE_MAN is set to YES.
1778
+
1779
+ MAN_EXTENSION = .3
1780
+
1781
+ # The MAN_SUBDIR tag determines the name of the directory created within
1782
+ # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1783
+ # MAN_EXTENSION with the initial . removed.
1784
+ # This tag requires that the tag GENERATE_MAN is set to YES.
1785
+
1786
+ MAN_SUBDIR =
1787
+
1788
+ # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1789
+ # will generate one additional man file for each entity documented in the real
1790
+ # man page(s). These additional files only source the real man page, but without
1791
+ # them the man command would be unable to find the correct page.
1792
+ # The default value is: NO.
1793
+ # This tag requires that the tag GENERATE_MAN is set to YES.
1794
+
1795
+ MAN_LINKS = NO
1796
+
1797
+ #---------------------------------------------------------------------------
1798
+ # Configuration options related to the XML output
1799
+ #---------------------------------------------------------------------------
1800
+
1801
+ # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1802
+ # captures the structure of the code including all documentation.
1803
+ # The default value is: NO.
1804
+
1805
+ GENERATE_XML = NO
1806
+
1807
+ # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1808
+ # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1809
+ # it.
1810
+ # The default directory is: xml.
1811
+ # This tag requires that the tag GENERATE_XML is set to YES.
1812
+
1813
+ XML_OUTPUT = xml
1814
+
1815
+ # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1816
+ # listings (including syntax highlighting and cross-referencing information) to
1817
+ # the XML output. Note that enabling this will significantly increase the size
1818
+ # of the XML output.
1819
+ # The default value is: YES.
1820
+ # This tag requires that the tag GENERATE_XML is set to YES.
1821
+
1822
+ XML_PROGRAMLISTING = YES
1823
+
1824
+ #---------------------------------------------------------------------------
1825
+ # Configuration options related to the DOCBOOK output
1826
+ #---------------------------------------------------------------------------
1827
+
1828
+ # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1829
+ # that can be used to generate PDF.
1830
+ # The default value is: NO.
1831
+
1832
+ GENERATE_DOCBOOK = NO
1833
+
1834
+ # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1835
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1836
+ # front of it.
1837
+ # The default directory is: docbook.
1838
+ # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1839
+
1840
+ DOCBOOK_OUTPUT = docbook
1841
+
1842
+ # If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
1843
+ # program listings (including syntax highlighting and cross-referencing
1844
+ # information) to the DOCBOOK output. Note that enabling this will significantly
1845
+ # increase the size of the DOCBOOK output.
1846
+ # The default value is: NO.
1847
+ # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1848
+
1849
+ DOCBOOK_PROGRAMLISTING = NO
1850
+
1851
+ #---------------------------------------------------------------------------
1852
+ # Configuration options for the AutoGen Definitions output
1853
+ #---------------------------------------------------------------------------
1854
+
1855
+ # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1856
+ # Definitions (see http://autogen.sf.net) file that captures the structure of
1857
+ # the code including all documentation. Note that this feature is still
1858
+ # experimental and incomplete at the moment.
1859
+ # The default value is: NO.
1860
+
1861
+ GENERATE_AUTOGEN_DEF = NO
1862
+
1863
+ #---------------------------------------------------------------------------
1864
+ # Configuration options related to the Perl module output
1865
+ #---------------------------------------------------------------------------
1866
+
1867
+ # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1868
+ # file that captures the structure of the code including all documentation.
1869
+ #
1870
+ # Note that this feature is still experimental and incomplete at the moment.
1871
+ # The default value is: NO.
1872
+
1873
+ GENERATE_PERLMOD = NO
1874
+
1875
+ # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1876
+ # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1877
+ # output from the Perl module output.
1878
+ # The default value is: NO.
1879
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1880
+
1881
+ PERLMOD_LATEX = NO
1882
+
1883
+ # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1884
+ # formatted so it can be parsed by a human reader. This is useful if you want to
1885
+ # understand what is going on. On the other hand, if this tag is set to NO the
1886
+ # size of the Perl module output will be much smaller and Perl will parse it
1887
+ # just the same.
1888
+ # The default value is: YES.
1889
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1890
+
1891
+ PERLMOD_PRETTY = YES
1892
+
1893
+ # The names of the make variables in the generated doxyrules.make file are
1894
+ # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1895
+ # so different doxyrules.make files included by the same Makefile don't
1896
+ # overwrite each other's variables.
1897
+ # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1898
+
1899
+ PERLMOD_MAKEVAR_PREFIX =
1900
+
1901
+ #---------------------------------------------------------------------------
1902
+ # Configuration options related to the preprocessor
1903
+ #---------------------------------------------------------------------------
1904
+
1905
+ # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1906
+ # C-preprocessor directives found in the sources and include files.
1907
+ # The default value is: YES.
1908
+
1909
+ ENABLE_PREPROCESSING = YES
1910
+
1911
+ # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1912
+ # in the source code. If set to NO only conditional compilation will be
1913
+ # performed. Macro expansion can be done in a controlled way by setting
1914
+ # EXPAND_ONLY_PREDEF to YES.
1915
+ # The default value is: NO.
1916
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1917
+
1918
+ MACRO_EXPANSION = YES
1919
+
1920
+ # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1921
+ # the macro expansion is limited to the macros specified with the PREDEFINED and
1922
+ # EXPAND_AS_DEFINED tags.
1923
+ # The default value is: NO.
1924
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1925
+
1926
+ EXPAND_ONLY_PREDEF = YES
1927
+
1928
+ # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1929
+ # INCLUDE_PATH will be searched if a #include is found.
1930
+ # The default value is: YES.
1931
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1932
+
1933
+ SEARCH_INCLUDES = YES
1934
+
1935
+ # The INCLUDE_PATH tag can be used to specify one or more directories that
1936
+ # contain include files that are not input files but should be processed by the
1937
+ # preprocessor.
1938
+ # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1939
+
1940
+ INCLUDE_PATH =
1941
+
1942
+ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1943
+ # patterns (like *.h and *.hpp) to filter out the header-files in the
1944
+ # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1945
+ # used.
1946
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1947
+
1948
+ INCLUDE_FILE_PATTERNS =
1949
+
1950
+ # The PREDEFINED tag can be used to specify one or more macro names that are
1951
+ # defined before the preprocessor is started (similar to the -D option of e.g.
1952
+ # gcc). The argument of the tag is a list of macros of the form: name or
1953
+ # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1954
+ # is assumed. To prevent a macro definition from being undefined via #undef or
1955
+ # recursively expanded use the := operator instead of the = operator.
1956
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1957
+
1958
+ PREDEFINED = API_EXPORTED= \
1959
+ LIBUSB_CALL= \
1960
+ DEFAULT_VISIBILITY=
1961
+
1962
+ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1963
+ # tag can be used to specify a list of macro names that should be expanded. The
1964
+ # macro definition that is found in the sources will be used. Use the PREDEFINED
1965
+ # tag if you want to use a different macro definition that overrules the
1966
+ # definition found in the source code.
1967
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1968
+
1969
+ EXPAND_AS_DEFINED =
1970
+
1971
+ # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1972
+ # remove all references to function-like macros that are alone on a line, have
1973
+ # an all uppercase name, and do not end with a semicolon. Such function macros
1974
+ # are typically used for boiler-plate code, and will confuse the parser if not
1975
+ # removed.
1976
+ # The default value is: YES.
1977
+ # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1978
+
1979
+ SKIP_FUNCTION_MACROS = YES
1980
+
1981
+ #---------------------------------------------------------------------------
1982
+ # Configuration options related to external references
1983
+ #---------------------------------------------------------------------------
1984
+
1985
+ # The TAGFILES tag can be used to specify one or more tag files. For each tag
1986
+ # file the location of the external documentation should be added. The format of
1987
+ # a tag file without this location is as follows:
1988
+ # TAGFILES = file1 file2 ...
1989
+ # Adding location for the tag files is done as follows:
1990
+ # TAGFILES = file1=loc1 "file2 = loc2" ...
1991
+ # where loc1 and loc2 can be relative or absolute paths or URLs. See the
1992
+ # section "Linking to external documentation" for more information about the use
1993
+ # of tag files.
1994
+ # Note: Each tag file must have a unique name (where the name does NOT include
1995
+ # the path). If a tag file is not located in the directory in which doxygen is
1996
+ # run, you must also specify the path to the tagfile here.
1997
+
1998
+ TAGFILES =
1999
+
2000
+ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2001
+ # tag file that is based on the input files it reads. See section "Linking to
2002
+ # external documentation" for more information about the usage of tag files.
2003
+
2004
+ GENERATE_TAGFILE =
2005
+
2006
+ # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2007
+ # class index. If set to NO only the inherited external classes will be listed.
2008
+ # The default value is: NO.
2009
+
2010
+ ALLEXTERNALS = NO
2011
+
2012
+ # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2013
+ # the modules index. If set to NO, only the current project's groups will be
2014
+ # listed.
2015
+ # The default value is: YES.
2016
+
2017
+ EXTERNAL_GROUPS = YES
2018
+
2019
+ # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2020
+ # the related pages index. If set to NO, only the current project's pages will
2021
+ # be listed.
2022
+ # The default value is: YES.
2023
+
2024
+ EXTERNAL_PAGES = YES
2025
+
2026
+ # The PERL_PATH should be the absolute path and name of the perl script
2027
+ # interpreter (i.e. the result of 'which perl').
2028
+ # The default file (with absolute path) is: /usr/bin/perl.
2029
+
2030
+ PERL_PATH = /usr/bin/perl
2031
+
2032
+ #---------------------------------------------------------------------------
2033
+ # Configuration options related to the dot tool
2034
+ #---------------------------------------------------------------------------
2035
+
2036
+ # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2037
+ # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2038
+ # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2039
+ # disabled, but it is recommended to install and use dot, since it yields more
2040
+ # powerful graphs.
2041
+ # The default value is: YES.
2042
+
2043
+ CLASS_DIAGRAMS = YES
2044
+
2045
+ # You can define message sequence charts within doxygen comments using the \msc
2046
+ # command. Doxygen will then run the mscgen tool (see:
2047
+ # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2048
+ # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2049
+ # the mscgen tool resides. If left empty the tool is assumed to be found in the
2050
+ # default search path.
2051
+
2052
+ MSCGEN_PATH =
2053
+
2054
+ # You can include diagrams made with dia in doxygen documentation. Doxygen will
2055
+ # then run dia to produce the diagram and insert it in the documentation. The
2056
+ # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2057
+ # If left empty dia is assumed to be found in the default search path.
2058
+
2059
+ DIA_PATH =
2060
+
2061
+ # If set to YES, the inheritance and collaboration graphs will hide inheritance
2062
+ # and usage relations if the target is undocumented or is not a class.
2063
+ # The default value is: YES.
2064
+
2065
+ HIDE_UNDOC_RELATIONS = YES
2066
+
2067
+ # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2068
+ # available from the path. This tool is part of Graphviz (see:
2069
+ # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2070
+ # Bell Labs. The other options in this section have no effect if this option is
2071
+ # set to NO
2072
+ # The default value is: NO.
2073
+
2074
+ HAVE_DOT = NO
2075
+
2076
+ # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2077
+ # to run in parallel. When set to 0 doxygen will base this on the number of
2078
+ # processors available in the system. You can set it explicitly to a value
2079
+ # larger than 0 to get control over the balance between CPU load and processing
2080
+ # speed.
2081
+ # Minimum value: 0, maximum value: 32, default value: 0.
2082
+ # This tag requires that the tag HAVE_DOT is set to YES.
2083
+
2084
+ DOT_NUM_THREADS = 0
2085
+
2086
+ # When you want a differently looking font in the dot files that doxygen
2087
+ # generates you can specify the font name using DOT_FONTNAME. You need to make
2088
+ # sure dot is able to find the font, which can be done by putting it in a
2089
+ # standard location or by setting the DOTFONTPATH environment variable or by
2090
+ # setting DOT_FONTPATH to the directory containing the font.
2091
+ # The default value is: Helvetica.
2092
+ # This tag requires that the tag HAVE_DOT is set to YES.
2093
+
2094
+ DOT_FONTNAME = Helvetica
2095
+
2096
+ # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2097
+ # dot graphs.
2098
+ # Minimum value: 4, maximum value: 24, default value: 10.
2099
+ # This tag requires that the tag HAVE_DOT is set to YES.
2100
+
2101
+ DOT_FONTSIZE = 10
2102
+
2103
+ # By default doxygen will tell dot to use the default font as specified with
2104
+ # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2105
+ # the path where dot can find it using this tag.
2106
+ # This tag requires that the tag HAVE_DOT is set to YES.
2107
+
2108
+ DOT_FONTPATH =
2109
+
2110
+ # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2111
+ # each documented class showing the direct and indirect inheritance relations.
2112
+ # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2113
+ # The default value is: YES.
2114
+ # This tag requires that the tag HAVE_DOT is set to YES.
2115
+
2116
+ CLASS_GRAPH = YES
2117
+
2118
+ # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2119
+ # graph for each documented class showing the direct and indirect implementation
2120
+ # dependencies (inheritance, containment, and class references variables) of the
2121
+ # class with other documented classes.
2122
+ # The default value is: YES.
2123
+ # This tag requires that the tag HAVE_DOT is set to YES.
2124
+
2125
+ COLLABORATION_GRAPH = YES
2126
+
2127
+ # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2128
+ # groups, showing the direct groups dependencies.
2129
+ # The default value is: YES.
2130
+ # This tag requires that the tag HAVE_DOT is set to YES.
2131
+
2132
+ GROUP_GRAPHS = YES
2133
+
2134
+ # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2135
+ # collaboration diagrams in a style similar to the OMG's Unified Modeling
2136
+ # Language.
2137
+ # The default value is: NO.
2138
+ # This tag requires that the tag HAVE_DOT is set to YES.
2139
+
2140
+ UML_LOOK = NO
2141
+
2142
+ # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2143
+ # class node. If there are many fields or methods and many nodes the graph may
2144
+ # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2145
+ # number of items for each type to make the size more manageable. Set this to 0
2146
+ # for no limit. Note that the threshold may be exceeded by 50% before the limit
2147
+ # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2148
+ # but if the number exceeds 15, the total amount of fields shown is limited to
2149
+ # 10.
2150
+ # Minimum value: 0, maximum value: 100, default value: 10.
2151
+ # This tag requires that the tag HAVE_DOT is set to YES.
2152
+
2153
+ UML_LIMIT_NUM_FIELDS = 10
2154
+
2155
+ # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2156
+ # collaboration graphs will show the relations between templates and their
2157
+ # instances.
2158
+ # The default value is: NO.
2159
+ # This tag requires that the tag HAVE_DOT is set to YES.
2160
+
2161
+ TEMPLATE_RELATIONS = NO
2162
+
2163
+ # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2164
+ # YES then doxygen will generate a graph for each documented file showing the
2165
+ # direct and indirect include dependencies of the file with other documented
2166
+ # files.
2167
+ # The default value is: YES.
2168
+ # This tag requires that the tag HAVE_DOT is set to YES.
2169
+
2170
+ INCLUDE_GRAPH = YES
2171
+
2172
+ # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2173
+ # set to YES then doxygen will generate a graph for each documented file showing
2174
+ # the direct and indirect include dependencies of the file with other documented
2175
+ # files.
2176
+ # The default value is: YES.
2177
+ # This tag requires that the tag HAVE_DOT is set to YES.
2178
+
2179
+ INCLUDED_BY_GRAPH = YES
2180
+
2181
+ # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2182
+ # dependency graph for every global function or class method.
2183
+ #
2184
+ # Note that enabling this option will significantly increase the time of a run.
2185
+ # So in most cases it will be better to enable call graphs for selected
2186
+ # functions only using the \callgraph command.
2187
+ # The default value is: NO.
2188
+ # This tag requires that the tag HAVE_DOT is set to YES.
2189
+
2190
+ CALL_GRAPH = NO
2191
+
2192
+ # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2193
+ # dependency graph for every global function or class method.
2194
+ #
2195
+ # Note that enabling this option will significantly increase the time of a run.
2196
+ # So in most cases it will be better to enable caller graphs for selected
2197
+ # functions only using the \callergraph command.
2198
+ # The default value is: NO.
2199
+ # This tag requires that the tag HAVE_DOT is set to YES.
2200
+
2201
+ CALLER_GRAPH = NO
2202
+
2203
+ # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2204
+ # hierarchy of all classes instead of a textual one.
2205
+ # The default value is: YES.
2206
+ # This tag requires that the tag HAVE_DOT is set to YES.
2207
+
2208
+ GRAPHICAL_HIERARCHY = YES
2209
+
2210
+ # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2211
+ # dependencies a directory has on other directories in a graphical way. The
2212
+ # dependency relations are determined by the #include relations between the
2213
+ # files in the directories.
2214
+ # The default value is: YES.
2215
+ # This tag requires that the tag HAVE_DOT is set to YES.
2216
+
2217
+ DIRECTORY_GRAPH = YES
2218
+
2219
+ # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2220
+ # generated by dot.
2221
+ # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2222
+ # to make the SVG files visible in IE 9+ (other browsers do not have this
2223
+ # requirement).
2224
+ # Possible values are: png, jpg, gif and svg.
2225
+ # The default value is: png.
2226
+ # This tag requires that the tag HAVE_DOT is set to YES.
2227
+
2228
+ DOT_IMAGE_FORMAT = png
2229
+
2230
+ # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2231
+ # enable generation of interactive SVG images that allow zooming and panning.
2232
+ #
2233
+ # Note that this requires a modern browser other than Internet Explorer. Tested
2234
+ # and working are Firefox, Chrome, Safari, and Opera.
2235
+ # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2236
+ # the SVG files visible. Older versions of IE do not have SVG support.
2237
+ # The default value is: NO.
2238
+ # This tag requires that the tag HAVE_DOT is set to YES.
2239
+
2240
+ INTERACTIVE_SVG = NO
2241
+
2242
+ # The DOT_PATH tag can be used to specify the path where the dot tool can be
2243
+ # found. If left blank, it is assumed the dot tool can be found in the path.
2244
+ # This tag requires that the tag HAVE_DOT is set to YES.
2245
+
2246
+ DOT_PATH =
2247
+
2248
+ # The DOTFILE_DIRS tag can be used to specify one or more directories that
2249
+ # contain dot files that are included in the documentation (see the \dotfile
2250
+ # command).
2251
+ # This tag requires that the tag HAVE_DOT is set to YES.
2252
+
2253
+ DOTFILE_DIRS =
2254
+
2255
+ # The MSCFILE_DIRS tag can be used to specify one or more directories that
2256
+ # contain msc files that are included in the documentation (see the \mscfile
2257
+ # command).
2258
+
2259
+ MSCFILE_DIRS =
2260
+
2261
+ # The DIAFILE_DIRS tag can be used to specify one or more directories that
2262
+ # contain dia files that are included in the documentation (see the \diafile
2263
+ # command).
2264
+
2265
+ DIAFILE_DIRS =
2266
+
2267
+ # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2268
+ # path where java can find the plantuml.jar file. If left blank, it is assumed
2269
+ # PlantUML is not used or called during a preprocessing step. Doxygen will
2270
+ # generate a warning when it encounters a \startuml command in this case and
2271
+ # will not generate output for the diagram.
2272
+ # This tag requires that the tag HAVE_DOT is set to YES.
2273
+
2274
+ PLANTUML_JAR_PATH =
2275
+
2276
+ # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2277
+ # that will be shown in the graph. If the number of nodes in a graph becomes
2278
+ # larger than this value, doxygen will truncate the graph, which is visualized
2279
+ # by representing a node as a red box. Note that doxygen if the number of direct
2280
+ # children of the root node in a graph is already larger than
2281
+ # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2282
+ # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2283
+ # Minimum value: 0, maximum value: 10000, default value: 50.
2284
+ # This tag requires that the tag HAVE_DOT is set to YES.
2285
+
2286
+ DOT_GRAPH_MAX_NODES = 50
2287
+
2288
+ # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2289
+ # generated by dot. A depth value of 3 means that only nodes reachable from the
2290
+ # root by following a path via at most 3 edges will be shown. Nodes that lay
2291
+ # further from the root node will be omitted. Note that setting this option to 1
2292
+ # or 2 may greatly reduce the computation time needed for large code bases. Also
2293
+ # note that the size of a graph can be further restricted by
2294
+ # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2295
+ # Minimum value: 0, maximum value: 1000, default value: 0.
2296
+ # This tag requires that the tag HAVE_DOT is set to YES.
2297
+
2298
+ MAX_DOT_GRAPH_DEPTH = 0
2299
+
2300
+ # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2301
+ # background. This is disabled by default, because dot on Windows does not seem
2302
+ # to support this out of the box.
2303
+ #
2304
+ # Warning: Depending on the platform used, enabling this option may lead to
2305
+ # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2306
+ # read).
2307
+ # The default value is: NO.
2308
+ # This tag requires that the tag HAVE_DOT is set to YES.
2309
+
2310
+ DOT_TRANSPARENT = NO
2311
+
2312
+ # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2313
+ # files in one run (i.e. multiple -o and -T options on the command line). This
2314
+ # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2315
+ # this, this feature is disabled by default.
2316
+ # The default value is: NO.
2317
+ # This tag requires that the tag HAVE_DOT is set to YES.
2318
+
2319
+ DOT_MULTI_TARGETS = NO
2320
+
2321
+ # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2322
+ # explaining the meaning of the various boxes and arrows in the dot generated
2323
+ # graphs.
2324
+ # The default value is: YES.
2325
+ # This tag requires that the tag HAVE_DOT is set to YES.
2326
+
2327
+ GENERATE_LEGEND = YES
2328
+
2329
+ # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2330
+ # files that are used to generate the various graphs.
2331
+ # The default value is: YES.
2332
+ # This tag requires that the tag HAVE_DOT is set to YES.
2333
+
2334
+ DOT_CLEANUP = YES