usb 1.7.2-prebuild

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