usb 2.1.2 → 2.3.0
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.
- package/CHANGELOG.md +24 -0
- package/README.md +20 -2
- package/dist/index.d.ts +2 -1
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/usb/bindings.d.ts +4 -0
- package/dist/usb/device.js +5 -0
- package/dist/usb/device.js.map +1 -1
- package/dist/usb/index.js +7 -16
- package/dist/usb/index.js.map +1 -1
- package/dist/webusb/webusb-device.d.ts +2 -1
- package/dist/webusb/webusb-device.js +21 -14
- package/dist/webusb/webusb-device.js.map +1 -1
- package/libusb/.gitattributes +2 -6
- package/libusb/.private/appveyor_build.sh +22 -0
- package/libusb/.private/bm.sh +1 -1
- package/libusb/.private/ci-build.sh +67 -0
- package/libusb/.private/ci-container-build.sh +70 -0
- package/libusb/.private/post-rewrite.sh +5 -1
- package/libusb/.private/pre-commit.sh +5 -1
- package/libusb/.private/wbs.txt +4 -19
- package/libusb/.travis.yml +32 -23
- package/libusb/AUTHORS +86 -3
- package/libusb/ChangeLog +54 -3
- package/libusb/INSTALL_WIN.txt +22 -44
- package/libusb/Makefile.am +32 -10
- package/libusb/{README.md → README} +2 -2
- package/libusb/README.git +3 -3
- package/libusb/Xcode/common.xcconfig +23 -19
- package/libusb/Xcode/config.h +25 -13
- package/libusb/Xcode/libusb.xcodeproj/project.pbxproj +511 -109
- package/libusb/android/README +90 -54
- package/libusb/android/config.h +23 -43
- package/libusb/android/examples/unrooted_android.c +300 -0
- package/libusb/android/examples/unrooted_android.h +36 -0
- package/libusb/android/jni/Android.mk +1 -1
- package/libusb/android/jni/Application.mk +16 -0
- package/libusb/android/jni/examples.mk +63 -29
- package/libusb/android/jni/libusb.mk +14 -8
- package/libusb/android/jni/tests.mk +13 -24
- package/libusb/appveyor.yml +73 -30
- package/libusb/autogen.sh +5 -3
- package/libusb/bootstrap.sh +6 -2
- package/libusb/configure.ac +314 -227
- package/libusb/doc/Makefile.in +22 -0
- package/libusb/doc/doxygen.cfg.in +460 -223
- package/libusb/examples/Makefile.am +6 -13
- package/libusb/examples/dpfp.c +276 -73
- package/libusb/examples/ezusb.c +18 -8
- package/libusb/examples/ezusb.h +6 -17
- package/libusb/examples/fxload.c +4 -5
- package/libusb/examples/hotplugtest.c +1 -1
- package/libusb/examples/sam3u_benchmark.c +59 -24
- package/libusb/examples/testlibusb.c +138 -104
- package/libusb/examples/xusb.c +26 -22
- package/libusb/libusb/Makefile.am +57 -70
- package/libusb/libusb/Makefile.am.extra +26 -0
- package/libusb/libusb/core.c +432 -423
- package/libusb/libusb/descriptor.c +365 -419
- package/libusb/libusb/hotplug.c +200 -104
- package/libusb/libusb/io.c +522 -535
- package/libusb/libusb/libusb-1.0.def +7 -3
- package/libusb/libusb/libusb-1.0.rc +1 -9
- package/libusb/libusb/libusb.h +302 -226
- package/libusb/libusb/libusbi.h +607 -316
- package/libusb/libusb/os/darwin_usb.c +703 -329
- package/libusb/libusb/os/darwin_usb.h +39 -15
- package/libusb/libusb/os/events_posix.c +300 -0
- package/libusb/libusb/os/events_posix.h +59 -0
- package/libusb/libusb/os/events_windows.c +214 -0
- package/libusb/{msvc/missing.h → libusb/os/events_windows.h} +25 -11
- package/libusb/libusb/os/haiku_pollfs.cpp +14 -9
- package/libusb/libusb/os/haiku_usb.h +12 -12
- package/libusb/libusb/os/haiku_usb_backend.cpp +36 -37
- package/libusb/libusb/os/haiku_usb_raw.cpp +80 -116
- package/libusb/libusb/os/linux_netlink.c +55 -63
- package/libusb/libusb/os/linux_udev.c +61 -69
- package/libusb/libusb/os/linux_usbfs.c +926 -1015
- package/libusb/libusb/os/linux_usbfs.h +74 -57
- package/libusb/libusb/os/netbsd_usb.c +103 -168
- package/libusb/libusb/os/null_usb.c +111 -0
- package/libusb/libusb/os/openbsd_usb.c +71 -120
- package/libusb/libusb/os/sunos_usb.c +289 -375
- package/libusb/libusb/os/sunos_usb.h +0 -1
- package/libusb/libusb/os/threads_posix.c +81 -32
- package/libusb/libusb/os/threads_posix.h +19 -23
- package/libusb/libusb/os/threads_windows.c +9 -95
- package/libusb/libusb/os/threads_windows.h +33 -31
- package/libusb/libusb/os/windows_common.c +915 -0
- package/libusb/libusb/os/windows_common.h +330 -42
- package/libusb/libusb/os/windows_usbdk.c +161 -267
- package/libusb/libusb/os/windows_usbdk.h +5 -2
- package/libusb/libusb/os/windows_winusb.c +1355 -1192
- package/libusb/libusb/os/windows_winusb.h +167 -167
- package/libusb/libusb/strerror.c +20 -30
- package/libusb/libusb/sync.c +20 -21
- package/libusb/libusb/version.h +1 -1
- package/libusb/libusb/version_nano.h +1 -1
- package/libusb/msvc/.gitattributes +3 -0
- package/libusb/msvc/config.h +27 -20
- package/libusb/msvc/{hotplugtest_2012.vcxproj → dpfp_2013.vcxproj} +14 -10
- package/libusb/msvc/dpfp_2013.vcxproj.filters +26 -0
- package/libusb/msvc/{listdevs_2010.vcxproj → dpfp_2015.vcxproj} +14 -9
- package/libusb/msvc/dpfp_2015.vcxproj.filters +26 -0
- package/libusb/msvc/dpfp_2017.vcxproj +106 -0
- package/libusb/msvc/dpfp_2017.vcxproj.filters +26 -0
- package/libusb/msvc/dpfp_2019.vcxproj +106 -0
- package/libusb/msvc/dpfp_2019.vcxproj.filters +26 -0
- package/libusb/msvc/dpfp_threaded_2013.vcxproj +87 -0
- package/libusb/msvc/dpfp_threaded_2013.vcxproj.filters +26 -0
- package/libusb/msvc/dpfp_threaded_2015.vcxproj +87 -0
- package/libusb/msvc/dpfp_threaded_2015.vcxproj.filters +26 -0
- package/libusb/msvc/dpfp_threaded_2017.vcxproj +106 -0
- package/libusb/msvc/dpfp_threaded_2017.vcxproj.filters +26 -0
- package/libusb/msvc/{fxload_2012.vcxproj → dpfp_threaded_2019.vcxproj} +32 -17
- package/libusb/msvc/dpfp_threaded_2019.vcxproj.filters +26 -0
- package/libusb/msvc/fxload_2013.vcxproj +6 -3
- package/libusb/msvc/fxload_2013.vcxproj.filters +35 -0
- package/libusb/msvc/fxload_2015.vcxproj +6 -3
- package/libusb/msvc/fxload_2015.vcxproj.filters +35 -0
- package/libusb/msvc/fxload_2017.vcxproj +6 -7
- package/libusb/msvc/fxload_2017.vcxproj.filters +35 -0
- package/libusb/msvc/{fxload_2010.vcxproj → fxload_2019.vcxproj} +29 -6
- package/libusb/msvc/fxload_2019.vcxproj.filters +35 -0
- package/libusb/{examples → msvc}/getopt/getopt.c +0 -0
- package/libusb/{examples → msvc}/getopt/getopt.h +0 -0
- package/libusb/{examples → msvc}/getopt/getopt1.c +0 -0
- package/libusb/msvc/getopt_2013.vcxproj +4 -5
- package/libusb/msvc/getopt_2013.vcxproj.filters +26 -0
- package/libusb/msvc/getopt_2015.vcxproj +4 -4
- package/libusb/msvc/getopt_2015.vcxproj.filters +26 -0
- package/libusb/msvc/getopt_2017.vcxproj +4 -10
- package/libusb/msvc/getopt_2017.vcxproj.filters +26 -0
- package/libusb/msvc/{getopt_2012.vcxproj → getopt_2019.vcxproj} +25 -6
- package/libusb/msvc/getopt_2019.vcxproj.filters +26 -0
- package/libusb/msvc/hotplugtest_2013.vcxproj +6 -3
- package/libusb/msvc/hotplugtest_2013.vcxproj.filters +23 -0
- package/libusb/msvc/hotplugtest_2015.vcxproj +6 -3
- package/libusb/msvc/hotplugtest_2015.vcxproj.filters +23 -0
- package/libusb/msvc/hotplugtest_2017.vcxproj +6 -7
- package/libusb/msvc/hotplugtest_2017.vcxproj.filters +23 -0
- package/libusb/msvc/hotplugtest_2019.vcxproj +105 -0
- package/libusb/msvc/hotplugtest_2019.vcxproj.filters +23 -0
- package/libusb/msvc/libusb_2013.sln +50 -20
- package/libusb/msvc/libusb_2015.sln +51 -21
- package/libusb/msvc/libusb_2017.sln +90 -36
- package/libusb/msvc/libusb_2019.sln +240 -0
- package/libusb/msvc/libusb_dll_2013.vcxproj +6 -9
- package/libusb/msvc/libusb_dll_2013.vcxproj.filters +94 -0
- package/libusb/msvc/libusb_dll_2015.vcxproj +6 -8
- package/libusb/msvc/libusb_dll_2015.vcxproj.filters +94 -0
- package/libusb/msvc/libusb_dll_2017.vcxproj +6 -16
- package/libusb/msvc/libusb_dll_2017.vcxproj.filters +94 -0
- package/libusb/msvc/{libusb_dll_2010.vcxproj → libusb_dll_2019.vcxproj} +27 -9
- package/libusb/msvc/libusb_dll_2019.vcxproj.filters +94 -0
- package/libusb/msvc/libusb_static_2013.vcxproj +5 -9
- package/libusb/msvc/libusb_static_2013.vcxproj.filters +80 -0
- package/libusb/msvc/libusb_static_2015.vcxproj +5 -8
- package/libusb/msvc/libusb_static_2015.vcxproj.filters +80 -0
- package/libusb/msvc/libusb_static_2017.vcxproj +5 -8
- package/libusb/msvc/libusb_static_2017.vcxproj.filters +80 -0
- package/libusb/msvc/{libusb_static_2010.vcxproj → libusb_static_2019.vcxproj} +26 -9
- package/libusb/msvc/libusb_static_2019.vcxproj.filters +80 -0
- package/libusb/msvc/listdevs_2013.vcxproj +6 -3
- package/libusb/msvc/listdevs_2013.vcxproj.filters +23 -0
- package/libusb/msvc/listdevs_2015.vcxproj +6 -3
- package/libusb/msvc/listdevs_2015.vcxproj.filters +23 -0
- package/libusb/msvc/listdevs_2017.vcxproj +6 -7
- package/libusb/msvc/listdevs_2017.vcxproj.filters +23 -0
- package/libusb/msvc/listdevs_2019.vcxproj +105 -0
- package/libusb/msvc/listdevs_2019.vcxproj.filters +23 -0
- package/libusb/msvc/{listdevs_2012.vcxproj → sam3u_benchmark_2013.vcxproj} +13 -9
- package/libusb/msvc/sam3u_benchmark_2013.vcxproj.filters +26 -0
- package/libusb/msvc/{hotplugtest_2010.vcxproj → sam3u_benchmark_2015.vcxproj} +13 -8
- package/libusb/msvc/sam3u_benchmark_2015.vcxproj.filters +26 -0
- package/libusb/msvc/sam3u_benchmark_2017.vcxproj +106 -0
- package/libusb/msvc/sam3u_benchmark_2017.vcxproj.filters +26 -0
- package/libusb/msvc/sam3u_benchmark_2019.vcxproj +106 -0
- package/libusb/msvc/sam3u_benchmark_2019.vcxproj.filters +26 -0
- package/libusb/msvc/stress_2013.vcxproj +4 -2
- package/libusb/msvc/stress_2013.vcxproj.filters +32 -0
- package/libusb/msvc/stress_2015.vcxproj +4 -2
- package/libusb/msvc/stress_2015.vcxproj.filters +32 -0
- package/libusb/msvc/stress_2017.vcxproj +4 -6
- package/libusb/msvc/stress_2017.vcxproj.filters +32 -0
- package/libusb/msvc/{stress_2010.vcxproj → stress_2019.vcxproj} +26 -4
- package/libusb/msvc/stress_2019.vcxproj.filters +32 -0
- package/libusb/msvc/testlibusb_2013.vcxproj +6 -3
- package/libusb/msvc/testlibusb_2013.vcxproj.filters +23 -0
- package/libusb/msvc/testlibusb_2015.vcxproj +6 -3
- package/libusb/msvc/testlibusb_2015.vcxproj.filters +23 -0
- package/libusb/msvc/testlibusb_2017.vcxproj +6 -7
- package/libusb/msvc/testlibusb_2017.vcxproj.filters +23 -0
- package/libusb/msvc/{testlibusb_2010.vcxproj → testlibusb_2019.vcxproj} +28 -5
- package/libusb/msvc/testlibusb_2019.vcxproj.filters +23 -0
- package/libusb/msvc/xusb_2013.vcxproj +6 -3
- package/libusb/msvc/xusb_2013.vcxproj.filters +23 -0
- package/libusb/msvc/xusb_2015.vcxproj +6 -3
- package/libusb/msvc/xusb_2015.vcxproj.filters +23 -0
- package/libusb/msvc/xusb_2017.vcxproj +6 -7
- package/libusb/msvc/xusb_2017.vcxproj.filters +23 -0
- package/libusb/msvc/{xusb_2010.vcxproj → xusb_2019.vcxproj} +28 -5
- package/libusb/msvc/xusb_2019.vcxproj.filters +23 -0
- package/libusb/tests/Makefile.am +13 -1
- package/libusb/tests/libusb_testlib.h +12 -43
- package/libusb/tests/stress.c +59 -50
- package/libusb/tests/testlib.c +78 -171
- package/libusb/tests/umockdev.c +1175 -0
- package/libusb.gypi +10 -11
- package/package.json +2 -2
- package/prebuilds/android-arm/node.napi.armv7.node +0 -0
- package/prebuilds/android-arm64/node.napi.armv8.node +0 -0
- package/prebuilds/darwin-x64+arm64/node.napi.node +0 -0
- package/prebuilds/linux-arm/node.napi.armv6.node +0 -0
- package/prebuilds/linux-arm/node.napi.armv7.node +0 -0
- package/prebuilds/linux-arm64/node.napi.armv8.node +0 -0
- package/prebuilds/linux-ia32/node.napi.node +0 -0
- package/prebuilds/linux-x64/node.napi.glibc.node +0 -0
- package/prebuilds/linux-x64/node.napi.musl.node +0 -0
- package/prebuilds/win32-ia32/node.napi.node +0 -0
- package/prebuilds/win32-x64/node.napi.node +0 -0
- package/src/device.cc +12 -7
- package/src/node_usb.cc +10 -0
- package/test/usb.coffee +6 -0
- package/tsc/index.ts +2 -0
- package/tsc/usb/bindings.ts +5 -0
- package/tsc/usb/device.ts +6 -0
- package/tsc/usb/index.ts +5 -8
- package/tsc/webusb/webusb-device.ts +12 -8
- package/libusb/.private/bd.cmd +0 -89
- package/libusb/.private/bwince.cmd +0 -57
- package/libusb/.private/wbs_wince.txt +0 -42
- package/libusb/Brewfile +0 -4
- package/libusb/appveyor_cygwin.bat +0 -11
- package/libusb/appveyor_minGW.bat +0 -19
- package/libusb/doc/Makefile.am +0 -9
- package/libusb/examples/dpfp_threaded.c +0 -557
- package/libusb/libusb/hotplug.h +0 -99
- package/libusb/libusb/os/poll_posix.c +0 -84
- package/libusb/libusb/os/poll_posix.h +0 -14
- package/libusb/libusb/os/poll_windows.c +0 -447
- package/libusb/libusb/os/poll_windows.h +0 -98
- package/libusb/libusb/os/wince_usb.c +0 -888
- package/libusb/libusb/os/wince_usb.h +0 -126
- package/libusb/libusb/os/windows_nt_common.c +0 -1010
- package/libusb/libusb/os/windows_nt_common.h +0 -110
- package/libusb/libusb/os/windows_nt_shared_types.h +0 -147
- package/libusb/msvc/appveyor.bat +0 -27
- package/libusb/msvc/ddk_build.cmd +0 -219
- package/libusb/msvc/errno.h +0 -102
- package/libusb/msvc/fxload_sources +0 -23
- package/libusb/msvc/getopt_2005.vcproj +0 -288
- package/libusb/msvc/getopt_2010.vcxproj +0 -72
- package/libusb/msvc/getopt_sources +0 -24
- package/libusb/msvc/hotplugtest_sources +0 -20
- package/libusb/msvc/inttypes.h +0 -295
- package/libusb/msvc/libusb.dsw +0 -71
- package/libusb/msvc/libusb_2005.sln +0 -95
- package/libusb/msvc/libusb_2010.sln +0 -105
- package/libusb/msvc/libusb_2012.sln +0 -105
- package/libusb/msvc/libusb_dll.dsp +0 -194
- package/libusb/msvc/libusb_dll_2005.vcproj +0 -464
- package/libusb/msvc/libusb_dll_2012.vcxproj +0 -107
- package/libusb/msvc/libusb_dll_wince.vcproj +0 -1251
- package/libusb/msvc/libusb_sources +0 -43
- package/libusb/msvc/libusb_static.dsp +0 -174
- package/libusb/msvc/libusb_static_2005.vcproj +0 -390
- package/libusb/msvc/libusb_static_2012.vcxproj +0 -98
- package/libusb/msvc/libusb_static_wince.vcproj +0 -1179
- package/libusb/msvc/libusb_wince.sln +0 -246
- package/libusb/msvc/listdevs.dsp +0 -103
- package/libusb/msvc/listdevs_2005.vcproj +0 -360
- package/libusb/msvc/listdevs_sources +0 -20
- package/libusb/msvc/listdevs_wince.vcproj +0 -1120
- package/libusb/msvc/missing.c +0 -80
- package/libusb/msvc/stdint.h +0 -256
- package/libusb/msvc/stress_2005.vcproj +0 -390
- package/libusb/msvc/stress_2012.vcxproj +0 -87
- package/libusb/msvc/stress_sources +0 -21
- package/libusb/msvc/stress_wince.vcproj +0 -1128
- package/libusb/msvc/testlibusb_2012.vcxproj +0 -83
- package/libusb/msvc/testlibusb_sources +0 -20
- package/libusb/msvc/xusb.dsp +0 -102
- package/libusb/msvc/xusb_2005.vcproj +0 -344
- package/libusb/msvc/xusb_2012.vcxproj +0 -83
- package/libusb/msvc/xusb_sources +0 -20
- package/libusb/msvc/xusb_wince.vcproj +0 -1120
- package/libusb/travis-autogen.sh +0 -39
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Doxyfile 1.
|
|
1
|
+
# Doxyfile 1.9.0
|
|
2
2
|
|
|
3
3
|
# This file describes the settings to be used by the documentation system
|
|
4
4
|
# doxygen (www.doxygen.org) for a project.
|
|
@@ -17,11 +17,11 @@
|
|
|
17
17
|
# Project related configuration options
|
|
18
18
|
#---------------------------------------------------------------------------
|
|
19
19
|
|
|
20
|
-
# This tag specifies the encoding used for all characters in the
|
|
21
|
-
# that follow. The default is UTF-8 which is also the encoding used for all
|
|
22
|
-
# before the first occurrence of this tag. Doxygen uses libiconv (or the
|
|
23
|
-
# built into libc) for the transcoding. See
|
|
24
|
-
# for the list of possible encodings.
|
|
20
|
+
# This tag specifies the encoding used for all characters in the configuration
|
|
21
|
+
# file that follow. The default is UTF-8 which is also the encoding used for all
|
|
22
|
+
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
|
|
23
|
+
# iconv built into libc) for the transcoding. See
|
|
24
|
+
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
|
|
25
25
|
# The default value is: UTF-8.
|
|
26
26
|
|
|
27
27
|
DOXYFILE_ENCODING = UTF-8
|
|
@@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
|
|
|
32
32
|
# title of most generated pages and in a few other places.
|
|
33
33
|
# The default value is: My Project.
|
|
34
34
|
|
|
35
|
-
PROJECT_NAME =
|
|
35
|
+
PROJECT_NAME = libusb
|
|
36
36
|
|
|
37
37
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
|
38
38
|
# could be handy for archiving the generated documentation or if some version
|
|
39
39
|
# control system is used.
|
|
40
40
|
|
|
41
|
-
PROJECT_NUMBER =
|
|
41
|
+
PROJECT_NUMBER = @PACKAGE_VERSION@
|
|
42
42
|
|
|
43
43
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
|
44
44
|
# for a project that appears at the top of each page and should give viewer a
|
|
@@ -46,12 +46,12 @@ PROJECT_NUMBER =
|
|
|
46
46
|
|
|
47
47
|
PROJECT_BRIEF = "A cross-platform user library to access USB devices"
|
|
48
48
|
|
|
49
|
-
# With the PROJECT_LOGO tag one can specify
|
|
50
|
-
# the documentation. The maximum height of the logo should not exceed 55
|
|
51
|
-
# and the maximum width should not exceed 200 pixels. Doxygen will copy
|
|
52
|
-
# to the output directory.
|
|
49
|
+
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
|
|
50
|
+
# in the documentation. The maximum height of the logo should not exceed 55
|
|
51
|
+
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
|
52
|
+
# the logo to the output directory.
|
|
53
53
|
|
|
54
|
-
PROJECT_LOGO = libusb.png
|
|
54
|
+
PROJECT_LOGO = @top_srcdir@/doc/libusb.png
|
|
55
55
|
|
|
56
56
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
|
57
57
|
# into which the generated documentation will be written. If a relative path is
|
|
@@ -60,7 +60,7 @@ PROJECT_LOGO = libusb.png
|
|
|
60
60
|
|
|
61
61
|
OUTPUT_DIRECTORY =
|
|
62
62
|
|
|
63
|
-
# If the CREATE_SUBDIRS tag is set to YES
|
|
63
|
+
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
|
|
64
64
|
# directories (in 2 levels) under the output directory of each output format and
|
|
65
65
|
# will distribute the generated files over these directories. Enabling this
|
|
66
66
|
# option can be useful when feeding doxygen a huge amount of source files, where
|
|
@@ -93,14 +93,22 @@ ALLOW_UNICODE_NAMES = NO
|
|
|
93
93
|
|
|
94
94
|
OUTPUT_LANGUAGE = English
|
|
95
95
|
|
|
96
|
-
#
|
|
96
|
+
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
|
|
97
|
+
# documentation generated by doxygen is written. Doxygen will use this
|
|
98
|
+
# information to generate all generated output in the proper direction.
|
|
99
|
+
# Possible values are: None, LTR, RTL and Context.
|
|
100
|
+
# The default value is: None.
|
|
101
|
+
|
|
102
|
+
OUTPUT_TEXT_DIRECTION = None
|
|
103
|
+
|
|
104
|
+
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
|
|
97
105
|
# descriptions after the members that are listed in the file and class
|
|
98
106
|
# documentation (similar to Javadoc). Set to NO to disable this.
|
|
99
107
|
# The default value is: YES.
|
|
100
108
|
|
|
101
109
|
BRIEF_MEMBER_DESC = YES
|
|
102
110
|
|
|
103
|
-
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
|
|
111
|
+
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
|
|
104
112
|
# description of a member or function before the detailed description
|
|
105
113
|
#
|
|
106
114
|
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
|
@@ -135,7 +143,7 @@ ALWAYS_DETAILED_SEC = NO
|
|
|
135
143
|
|
|
136
144
|
INLINE_INHERITED_MEMB = NO
|
|
137
145
|
|
|
138
|
-
# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
|
|
146
|
+
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
|
|
139
147
|
# before files name in the file list and in the header files. If set to NO the
|
|
140
148
|
# shortest path that makes the file name unique will be used
|
|
141
149
|
# The default value is: YES.
|
|
@@ -179,6 +187,16 @@ SHORT_NAMES = NO
|
|
|
179
187
|
|
|
180
188
|
JAVADOC_AUTOBRIEF = YES
|
|
181
189
|
|
|
190
|
+
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
|
|
191
|
+
# such as
|
|
192
|
+
# /***************
|
|
193
|
+
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
|
|
194
|
+
# Javadoc-style will behave just like regular comments and it will not be
|
|
195
|
+
# interpreted by doxygen.
|
|
196
|
+
# The default value is: NO.
|
|
197
|
+
|
|
198
|
+
JAVADOC_BANNER = NO
|
|
199
|
+
|
|
182
200
|
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
|
|
183
201
|
# line (until the first dot) of a Qt-style comment as the brief description. If
|
|
184
202
|
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
|
|
@@ -199,15 +217,23 @@ QT_AUTOBRIEF = NO
|
|
|
199
217
|
|
|
200
218
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
201
219
|
|
|
220
|
+
# By default Python docstrings are displayed as preformatted text and doxygen's
|
|
221
|
+
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
|
|
222
|
+
# doxygen's special commands can be used and the contents of the docstring
|
|
223
|
+
# documentation blocks is shown as doxygen documentation.
|
|
224
|
+
# The default value is: YES.
|
|
225
|
+
|
|
226
|
+
PYTHON_DOCSTRING = YES
|
|
227
|
+
|
|
202
228
|
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
|
|
203
229
|
# documentation from any documented member that it re-implements.
|
|
204
230
|
# The default value is: YES.
|
|
205
231
|
|
|
206
232
|
INHERIT_DOCS = YES
|
|
207
233
|
|
|
208
|
-
# If the SEPARATE_MEMBER_PAGES tag is set to YES
|
|
209
|
-
#
|
|
210
|
-
#
|
|
234
|
+
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
|
|
235
|
+
# page for each member. If set to NO, the documentation of a member will be part
|
|
236
|
+
# of the file/class/namespace that contains it.
|
|
211
237
|
# The default value is: NO.
|
|
212
238
|
|
|
213
239
|
SEPARATE_MEMBER_PAGES = NO
|
|
@@ -226,16 +252,15 @@ TAB_SIZE = 4
|
|
|
226
252
|
# will allow you to put the command \sideeffect (or @sideeffect) in the
|
|
227
253
|
# documentation, which will result in a user-defined paragraph with heading
|
|
228
254
|
# "Side Effects:". You can put \n's in the value part of an alias to insert
|
|
229
|
-
# newlines.
|
|
255
|
+
# newlines (in the resulting output). You can put ^^ in the value part of an
|
|
256
|
+
# alias to insert a newline as if a physical newline was in the original file.
|
|
257
|
+
# When you need a literal { or } or , in the value part of an alias you have to
|
|
258
|
+
# escape them by means of a backslash (\), this can lead to conflicts with the
|
|
259
|
+
# commands \{ and \} for these it is advised to use the version @{ and @} or use
|
|
260
|
+
# a double escape (\\{ and \\})
|
|
230
261
|
|
|
231
262
|
ALIASES =
|
|
232
263
|
|
|
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
264
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
|
240
265
|
# only. Doxygen will then generate output that is more tailored for C. For
|
|
241
266
|
# instance, some of the names that are used will be different. The list of all
|
|
@@ -264,28 +289,40 @@ OPTIMIZE_FOR_FORTRAN = NO
|
|
|
264
289
|
|
|
265
290
|
OPTIMIZE_OUTPUT_VHDL = NO
|
|
266
291
|
|
|
292
|
+
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
|
|
293
|
+
# sources only. Doxygen will then generate output that is more tailored for that
|
|
294
|
+
# language. For instance, namespaces will be presented as modules, types will be
|
|
295
|
+
# separated into more groups, etc.
|
|
296
|
+
# The default value is: NO.
|
|
297
|
+
|
|
298
|
+
OPTIMIZE_OUTPUT_SLICE = NO
|
|
299
|
+
|
|
267
300
|
# Doxygen selects the parser to use depending on the extension of the files it
|
|
268
301
|
# parses. With this tag you can assign which parser to use for a given
|
|
269
302
|
# extension. Doxygen has a built-in mapping, but you can override or extend it
|
|
270
303
|
# 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,
|
|
272
|
-
# C
|
|
273
|
-
#
|
|
274
|
-
# Fortran. In the later case the parser
|
|
275
|
-
# or free formatted code, this is the
|
|
276
|
-
# instance to make doxygen treat .inc files
|
|
277
|
-
# and .f files as C (default is Fortran),
|
|
304
|
+
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
|
|
305
|
+
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
|
|
306
|
+
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
|
|
307
|
+
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
|
|
308
|
+
# tries to guess whether the code is fixed or free formatted code, this is the
|
|
309
|
+
# default for Fortran type files). For instance to make doxygen treat .inc files
|
|
310
|
+
# as Fortran files (default is PHP), and .f files as C (default is Fortran),
|
|
311
|
+
# use: inc=Fortran f=C.
|
|
278
312
|
#
|
|
279
|
-
# Note For files without extension you can use no_extension as a placeholder.
|
|
313
|
+
# Note: For files without extension you can use no_extension as a placeholder.
|
|
280
314
|
#
|
|
281
315
|
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
|
|
282
|
-
# the files are not read by doxygen.
|
|
316
|
+
# the files are not read by doxygen. When specifying no_extension you should add
|
|
317
|
+
# * to the FILE_PATTERNS.
|
|
318
|
+
#
|
|
319
|
+
# Note see also the list of default file extension mappings.
|
|
283
320
|
|
|
284
321
|
EXTENSION_MAPPING =
|
|
285
322
|
|
|
286
323
|
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
|
|
287
324
|
# according to the Markdown format, which allows for more readable
|
|
288
|
-
# documentation. See
|
|
325
|
+
# documentation. See https://daringfireball.net/projects/markdown/ for details.
|
|
289
326
|
# The output of markdown processing is further processed by doxygen, so you can
|
|
290
327
|
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
|
|
291
328
|
# case of backward compatibilities issues.
|
|
@@ -293,10 +330,19 @@ EXTENSION_MAPPING =
|
|
|
293
330
|
|
|
294
331
|
MARKDOWN_SUPPORT = YES
|
|
295
332
|
|
|
333
|
+
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
|
|
334
|
+
# to that level are automatically included in the table of contents, even if
|
|
335
|
+
# they do not have an id attribute.
|
|
336
|
+
# Note: This feature currently applies only to Markdown headings.
|
|
337
|
+
# Minimum value: 0, maximum value: 99, default value: 5.
|
|
338
|
+
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
|
|
339
|
+
|
|
340
|
+
TOC_INCLUDE_HEADINGS = 5
|
|
341
|
+
|
|
296
342
|
# When enabled doxygen tries to link words that correspond to documented
|
|
297
343
|
# classes, or namespaces to their corresponding documentation. Such a link can
|
|
298
|
-
# be prevented in individual cases by
|
|
299
|
-
#
|
|
344
|
+
# be prevented in individual cases by putting a % sign in front of the word or
|
|
345
|
+
# globally by setting AUTOLINK_SUPPORT to NO.
|
|
300
346
|
# The default value is: YES.
|
|
301
347
|
|
|
302
348
|
AUTOLINK_SUPPORT = YES
|
|
@@ -318,7 +364,7 @@ BUILTIN_STL_SUPPORT = NO
|
|
|
318
364
|
CPP_CLI_SUPPORT = NO
|
|
319
365
|
|
|
320
366
|
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
|
|
321
|
-
#
|
|
367
|
+
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
|
|
322
368
|
# will parse them like normal C++ but will assume all classes use public instead
|
|
323
369
|
# of private inheritance when no explicit protection keyword is present.
|
|
324
370
|
# The default value is: NO.
|
|
@@ -336,13 +382,20 @@ SIP_SUPPORT = NO
|
|
|
336
382
|
IDL_PROPERTY_SUPPORT = YES
|
|
337
383
|
|
|
338
384
|
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
|
339
|
-
# tag is set to YES
|
|
385
|
+
# tag is set to YES then doxygen will reuse the documentation of the first
|
|
340
386
|
# member in the group (if any) for the other members of the group. By default
|
|
341
387
|
# all members of a group must be documented explicitly.
|
|
342
388
|
# The default value is: NO.
|
|
343
389
|
|
|
344
390
|
DISTRIBUTE_GROUP_DOC = NO
|
|
345
391
|
|
|
392
|
+
# If one adds a struct or class to a group and this option is enabled, then also
|
|
393
|
+
# any nested class or struct is added to the same group. By default this option
|
|
394
|
+
# is disabled and one has to add nested compounds explicitly via \ingroup.
|
|
395
|
+
# The default value is: NO.
|
|
396
|
+
|
|
397
|
+
GROUP_NESTED_COMPOUNDS = NO
|
|
398
|
+
|
|
346
399
|
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
|
|
347
400
|
# (for instance a group of public functions) to be put as a subgroup of that
|
|
348
401
|
# type (e.g. under the Public Functions section). Set it to NO to prevent
|
|
@@ -397,11 +450,24 @@ TYPEDEF_HIDES_STRUCT = NO
|
|
|
397
450
|
|
|
398
451
|
LOOKUP_CACHE_SIZE = 0
|
|
399
452
|
|
|
453
|
+
# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
|
|
454
|
+
# during processing. When set to 0 doxygen will based this on the number of
|
|
455
|
+
# cores available in the system. You can set it explicitly to a value larger
|
|
456
|
+
# than 0 to get more control over the balance between CPU load and processing
|
|
457
|
+
# speed. At this moment only the input processing can be done using multiple
|
|
458
|
+
# threads. Since this is still an experimental feature the default is set to 1,
|
|
459
|
+
# which efficively disables parallel processing. Please report any issues you
|
|
460
|
+
# encounter. Generating dot graphs in parallel is controlled by the
|
|
461
|
+
# DOT_NUM_THREADS setting.
|
|
462
|
+
# Minimum value: 0, maximum value: 32, default value: 1.
|
|
463
|
+
|
|
464
|
+
NUM_PROC_THREADS = 1
|
|
465
|
+
|
|
400
466
|
#---------------------------------------------------------------------------
|
|
401
467
|
# Build related configuration options
|
|
402
468
|
#---------------------------------------------------------------------------
|
|
403
469
|
|
|
404
|
-
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
|
470
|
+
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
|
|
405
471
|
# documentation are documented, even if no documentation was available. Private
|
|
406
472
|
# class members and static file members will be hidden unless the
|
|
407
473
|
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
|
|
@@ -411,35 +477,41 @@ LOOKUP_CACHE_SIZE = 0
|
|
|
411
477
|
|
|
412
478
|
EXTRACT_ALL = NO
|
|
413
479
|
|
|
414
|
-
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
|
|
480
|
+
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
|
|
415
481
|
# be included in the documentation.
|
|
416
482
|
# The default value is: NO.
|
|
417
483
|
|
|
418
484
|
EXTRACT_PRIVATE = NO
|
|
419
485
|
|
|
420
|
-
# If the
|
|
486
|
+
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
|
|
487
|
+
# methods of a class will be included in the documentation.
|
|
488
|
+
# The default value is: NO.
|
|
489
|
+
|
|
490
|
+
EXTRACT_PRIV_VIRTUAL = NO
|
|
491
|
+
|
|
492
|
+
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
|
|
421
493
|
# scope will be included in the documentation.
|
|
422
494
|
# The default value is: NO.
|
|
423
495
|
|
|
424
496
|
EXTRACT_PACKAGE = NO
|
|
425
497
|
|
|
426
|
-
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
|
|
498
|
+
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
|
|
427
499
|
# included in the documentation.
|
|
428
500
|
# The default value is: NO.
|
|
429
501
|
|
|
430
502
|
EXTRACT_STATIC = YES
|
|
431
503
|
|
|
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
|
|
504
|
+
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
|
|
505
|
+
# locally in source files will be included in the documentation. If set to NO,
|
|
434
506
|
# only classes defined in header files are included. Does not have any effect
|
|
435
507
|
# for Java sources.
|
|
436
508
|
# The default value is: YES.
|
|
437
509
|
|
|
438
510
|
EXTRACT_LOCAL_CLASSES = YES
|
|
439
511
|
|
|
440
|
-
# This flag is only useful for Objective-C code.
|
|
512
|
+
# This flag is only useful for Objective-C code. If set to YES, local methods,
|
|
441
513
|
# 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
|
|
514
|
+
# included in the documentation. If set to NO, only methods in the interface are
|
|
443
515
|
# included.
|
|
444
516
|
# The default value is: NO.
|
|
445
517
|
|
|
@@ -454,6 +526,13 @@ EXTRACT_LOCAL_METHODS = NO
|
|
|
454
526
|
|
|
455
527
|
EXTRACT_ANON_NSPACES = NO
|
|
456
528
|
|
|
529
|
+
# If this flag is set to YES, the name of an unnamed parameter in a declaration
|
|
530
|
+
# will be determined by the corresponding definition. By default unnamed
|
|
531
|
+
# parameters remain unnamed in the output.
|
|
532
|
+
# The default value is: YES.
|
|
533
|
+
|
|
534
|
+
RESOLVE_UNNAMED_PARAMS = YES
|
|
535
|
+
|
|
457
536
|
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
|
|
458
537
|
# undocumented members inside documented classes or files. If set to NO these
|
|
459
538
|
# members will be included in the various overviews, but no documentation
|
|
@@ -464,21 +543,21 @@ HIDE_UNDOC_MEMBERS = NO
|
|
|
464
543
|
|
|
465
544
|
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
|
|
466
545
|
# 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
|
|
468
|
-
# no effect if EXTRACT_ALL is enabled.
|
|
546
|
+
# to NO, these classes will be included in the various overviews. This option
|
|
547
|
+
# has no effect if EXTRACT_ALL is enabled.
|
|
469
548
|
# The default value is: NO.
|
|
470
549
|
|
|
471
550
|
HIDE_UNDOC_CLASSES = NO
|
|
472
551
|
|
|
473
552
|
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
|
|
474
|
-
#
|
|
475
|
-
#
|
|
553
|
+
# declarations. If set to NO, these declarations will be included in the
|
|
554
|
+
# documentation.
|
|
476
555
|
# The default value is: NO.
|
|
477
556
|
|
|
478
557
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
479
558
|
|
|
480
559
|
# 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
|
|
560
|
+
# documentation blocks found inside the body of a function. If set to NO, these
|
|
482
561
|
# blocks will be appended to the function's detailed documentation block.
|
|
483
562
|
# The default value is: NO.
|
|
484
563
|
|
|
@@ -491,22 +570,36 @@ HIDE_IN_BODY_DOCS = NO
|
|
|
491
570
|
|
|
492
571
|
INTERNAL_DOCS = NO
|
|
493
572
|
|
|
494
|
-
#
|
|
495
|
-
#
|
|
496
|
-
#
|
|
497
|
-
#
|
|
498
|
-
#
|
|
573
|
+
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
|
|
574
|
+
# able to match the capabilities of the underlying filesystem. In case the
|
|
575
|
+
# filesystem is case sensitive (i.e. it supports files in the same directory
|
|
576
|
+
# whose names only differ in casing), the option must be set to YES to properly
|
|
577
|
+
# deal with such files in case they appear in the input. For filesystems that
|
|
578
|
+
# are not case sensitive the option should be be set to NO to properly deal with
|
|
579
|
+
# output files written for symbols that only differ in casing, such as for two
|
|
580
|
+
# classes, one named CLASS and the other named Class, and to also support
|
|
581
|
+
# references to files without having to specify the exact matching casing. On
|
|
582
|
+
# Windows (including Cygwin) and MacOS, users should typically set this option
|
|
583
|
+
# to NO, whereas on Linux or other Unix flavors it should typically be set to
|
|
584
|
+
# YES.
|
|
499
585
|
# The default value is: system dependent.
|
|
500
586
|
|
|
501
587
|
CASE_SENSE_NAMES = YES
|
|
502
588
|
|
|
503
589
|
# 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
|
|
590
|
+
# their full class and namespace scopes in the documentation. If set to YES, the
|
|
505
591
|
# scope will be hidden.
|
|
506
592
|
# The default value is: NO.
|
|
507
593
|
|
|
508
594
|
HIDE_SCOPE_NAMES = NO
|
|
509
595
|
|
|
596
|
+
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
|
|
597
|
+
# append additional text to a page's title, such as Class Reference. If set to
|
|
598
|
+
# YES the compound reference will be hidden.
|
|
599
|
+
# The default value is: NO.
|
|
600
|
+
|
|
601
|
+
HIDE_COMPOUND_REFERENCE= NO
|
|
602
|
+
|
|
510
603
|
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
|
|
511
604
|
# the files that are included by a file in the documentation of that file.
|
|
512
605
|
# The default value is: YES.
|
|
@@ -534,14 +627,14 @@ INLINE_INFO = YES
|
|
|
534
627
|
|
|
535
628
|
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
|
|
536
629
|
# (detailed) documentation of file and class members alphabetically by member
|
|
537
|
-
# name. If set to NO the members will appear in declaration order.
|
|
630
|
+
# name. If set to NO, the members will appear in declaration order.
|
|
538
631
|
# The default value is: YES.
|
|
539
632
|
|
|
540
633
|
SORT_MEMBER_DOCS = NO
|
|
541
634
|
|
|
542
635
|
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
|
|
543
636
|
# 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
|
|
637
|
+
# name. If set to NO, the members will appear in declaration order. Note that
|
|
545
638
|
# this will also influence the order of the classes in the class list.
|
|
546
639
|
# The default value is: NO.
|
|
547
640
|
|
|
@@ -586,27 +679,25 @@ SORT_BY_SCOPE_NAME = NO
|
|
|
586
679
|
|
|
587
680
|
STRICT_PROTO_MATCHING = NO
|
|
588
681
|
|
|
589
|
-
# The GENERATE_TODOLIST tag can be used to enable (
|
|
590
|
-
#
|
|
591
|
-
# documentation.
|
|
682
|
+
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
|
|
683
|
+
# list. This list is created by putting \todo commands in the documentation.
|
|
592
684
|
# The default value is: YES.
|
|
593
685
|
|
|
594
686
|
GENERATE_TODOLIST = YES
|
|
595
687
|
|
|
596
|
-
# The GENERATE_TESTLIST tag can be used to enable (
|
|
597
|
-
#
|
|
598
|
-
# documentation.
|
|
688
|
+
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
|
|
689
|
+
# list. This list is created by putting \test commands in the documentation.
|
|
599
690
|
# The default value is: YES.
|
|
600
691
|
|
|
601
692
|
GENERATE_TESTLIST = YES
|
|
602
693
|
|
|
603
|
-
# The GENERATE_BUGLIST tag can be used to enable (
|
|
694
|
+
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
|
|
604
695
|
# list. This list is created by putting \bug commands in the documentation.
|
|
605
696
|
# The default value is: YES.
|
|
606
697
|
|
|
607
698
|
GENERATE_BUGLIST = YES
|
|
608
699
|
|
|
609
|
-
# The GENERATE_DEPRECATEDLIST tag can be used to enable (
|
|
700
|
+
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
|
|
610
701
|
# the deprecated list. This list is created by putting \deprecated commands in
|
|
611
702
|
# the documentation.
|
|
612
703
|
# The default value is: YES.
|
|
@@ -631,8 +722,8 @@ ENABLED_SECTIONS =
|
|
|
631
722
|
MAX_INITIALIZER_LINES = 30
|
|
632
723
|
|
|
633
724
|
# 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
|
|
635
|
-
# will mention the files that were used to generate the documentation.
|
|
725
|
+
# the bottom of the documentation of classes and structs. If set to YES, the
|
|
726
|
+
# list will mention the files that were used to generate the documentation.
|
|
636
727
|
# The default value is: YES.
|
|
637
728
|
|
|
638
729
|
SHOW_USED_FILES = YES
|
|
@@ -677,7 +768,7 @@ LAYOUT_FILE =
|
|
|
677
768
|
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
|
|
678
769
|
# the reference definitions. This must be a list of .bib files. The .bib
|
|
679
770
|
# extension is automatically appended if omitted. This requires the bibtex tool
|
|
680
|
-
# to be installed. See also
|
|
771
|
+
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
|
|
681
772
|
# For LaTeX the style of the bibliography can be controlled using
|
|
682
773
|
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
|
|
683
774
|
# search path. See also \cite for info how to create references.
|
|
@@ -696,7 +787,7 @@ CITE_BIB_FILES =
|
|
|
696
787
|
QUIET = YES
|
|
697
788
|
|
|
698
789
|
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
|
699
|
-
# generated to standard error (
|
|
790
|
+
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
|
|
700
791
|
# this implies that the warnings are on.
|
|
701
792
|
#
|
|
702
793
|
# Tip: Turn warnings on while writing the documentation.
|
|
@@ -704,7 +795,7 @@ QUIET = YES
|
|
|
704
795
|
|
|
705
796
|
WARNINGS = YES
|
|
706
797
|
|
|
707
|
-
# If the WARN_IF_UNDOCUMENTED tag is set to YES
|
|
798
|
+
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
|
|
708
799
|
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
|
|
709
800
|
# will automatically be disabled.
|
|
710
801
|
# The default value is: YES.
|
|
@@ -721,12 +812,22 @@ WARN_IF_DOC_ERROR = YES
|
|
|
721
812
|
|
|
722
813
|
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
|
|
723
814
|
# 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
|
|
725
|
-
# documentation, but not about the absence of documentation.
|
|
815
|
+
# value. If set to NO, doxygen will only warn about wrong or incomplete
|
|
816
|
+
# parameter documentation, but not about the absence of documentation. If
|
|
817
|
+
# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
|
|
726
818
|
# The default value is: NO.
|
|
727
819
|
|
|
728
820
|
WARN_NO_PARAMDOC = NO
|
|
729
821
|
|
|
822
|
+
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
|
|
823
|
+
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
|
|
824
|
+
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
|
|
825
|
+
# at the end of the doxygen process doxygen will return with a non-zero status.
|
|
826
|
+
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
|
|
827
|
+
# The default value is: NO.
|
|
828
|
+
|
|
829
|
+
WARN_AS_ERROR = NO
|
|
830
|
+
|
|
730
831
|
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
|
|
731
832
|
# can produce. The string should contain the $file, $line, and $text tags, which
|
|
732
833
|
# will be replaced by the file and line number from which the warning originated
|
|
@@ -750,7 +851,7 @@ WARN_LOGFILE =
|
|
|
750
851
|
# The INPUT tag is used to specify the files and/or directories that contain
|
|
751
852
|
# documented source files. You may enter file names like myfile.cpp or
|
|
752
853
|
# directories like /usr/src/myproject. Separate the files or directories with
|
|
753
|
-
# spaces.
|
|
854
|
+
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
|
754
855
|
# Note: If this tag is empty the current directory is searched.
|
|
755
856
|
|
|
756
857
|
INPUT = @top_srcdir@/libusb
|
|
@@ -758,22 +859,32 @@ INPUT = @top_srcdir@/libusb
|
|
|
758
859
|
# This tag can be used to specify the character encoding of the source files
|
|
759
860
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
|
760
861
|
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
|
|
761
|
-
# documentation (see:
|
|
762
|
-
# possible encodings.
|
|
862
|
+
# documentation (see:
|
|
863
|
+
# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
|
|
763
864
|
# The default value is: UTF-8.
|
|
764
865
|
|
|
765
866
|
INPUT_ENCODING = UTF-8
|
|
766
867
|
|
|
767
868
|
# If the value of the INPUT tag contains directories, you can use the
|
|
768
869
|
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
|
|
769
|
-
# *.h) to filter out the source-files in the directories.
|
|
770
|
-
#
|
|
771
|
-
#
|
|
772
|
-
#
|
|
773
|
-
#
|
|
774
|
-
#
|
|
870
|
+
# *.h) to filter out the source-files in the directories.
|
|
871
|
+
#
|
|
872
|
+
# Note that for custom extensions or not directly supported extensions you also
|
|
873
|
+
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
|
874
|
+
# read by doxygen.
|
|
875
|
+
#
|
|
876
|
+
# Note the list of default checked file patterns might differ from the list of
|
|
877
|
+
# default file extension mappings.
|
|
878
|
+
#
|
|
879
|
+
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
|
|
880
|
+
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
|
|
881
|
+
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
|
|
882
|
+
# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
|
|
883
|
+
# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
|
|
884
|
+
# *.ucf, *.qsf and *.ice.
|
|
775
885
|
|
|
776
|
-
FILE_PATTERNS =
|
|
886
|
+
FILE_PATTERNS = *.c \
|
|
887
|
+
*.h
|
|
777
888
|
|
|
778
889
|
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
|
779
890
|
# be searched for input files as well.
|
|
@@ -789,7 +900,9 @@ RECURSIVE = NO
|
|
|
789
900
|
# run.
|
|
790
901
|
|
|
791
902
|
EXCLUDE = @top_srcdir@/libusb/libusbi.h \
|
|
792
|
-
@top_srcdir@/libusb/
|
|
903
|
+
@top_srcdir@/libusb/version.h \
|
|
904
|
+
@top_srcdir@/libusb/version_nano.h \
|
|
905
|
+
@top_srcdir@/libusb/os
|
|
793
906
|
|
|
794
907
|
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
|
795
908
|
# directories that are symbolic links (a Unix file system feature) are excluded
|
|
@@ -858,6 +971,10 @@ IMAGE_PATH =
|
|
|
858
971
|
# Note that the filter must not add or remove lines; it is applied before the
|
|
859
972
|
# code is scanned, but not when the output code is generated. If lines are added
|
|
860
973
|
# or removed, the anchors will not be placed correctly.
|
|
974
|
+
#
|
|
975
|
+
# Note that for custom extensions or not directly supported extensions you also
|
|
976
|
+
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
|
977
|
+
# properly processed by doxygen.
|
|
861
978
|
|
|
862
979
|
INPUT_FILTER =
|
|
863
980
|
|
|
@@ -867,11 +984,15 @@ INPUT_FILTER =
|
|
|
867
984
|
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
|
|
868
985
|
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
|
|
869
986
|
# patterns match the file name, INPUT_FILTER is applied.
|
|
987
|
+
#
|
|
988
|
+
# Note that for custom extensions or not directly supported extensions you also
|
|
989
|
+
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
|
|
990
|
+
# properly processed by doxygen.
|
|
870
991
|
|
|
871
992
|
FILTER_PATTERNS =
|
|
872
993
|
|
|
873
994
|
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
|
874
|
-
# INPUT_FILTER
|
|
995
|
+
# INPUT_FILTER) will also be used to filter the input files that are used for
|
|
875
996
|
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
|
876
997
|
# The default value is: NO.
|
|
877
998
|
|
|
@@ -919,7 +1040,7 @@ INLINE_SOURCES = NO
|
|
|
919
1040
|
STRIP_CODE_COMMENTS = YES
|
|
920
1041
|
|
|
921
1042
|
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
|
|
922
|
-
#
|
|
1043
|
+
# entity all documented functions referencing it will be listed.
|
|
923
1044
|
# The default value is: NO.
|
|
924
1045
|
|
|
925
1046
|
REFERENCED_BY_RELATION = NO
|
|
@@ -931,7 +1052,7 @@ REFERENCED_BY_RELATION = NO
|
|
|
931
1052
|
REFERENCES_RELATION = NO
|
|
932
1053
|
|
|
933
1054
|
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
|
|
934
|
-
# to YES
|
|
1055
|
+
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
|
|
935
1056
|
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
|
|
936
1057
|
# link to the documentation.
|
|
937
1058
|
# The default value is: YES.
|
|
@@ -951,12 +1072,12 @@ SOURCE_TOOLTIPS = YES
|
|
|
951
1072
|
# If the USE_HTAGS tag is set to YES then the references to source code will
|
|
952
1073
|
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
|
|
953
1074
|
# source browser. The htags tool is part of GNU's global source tagging system
|
|
954
|
-
# (see
|
|
1075
|
+
# (see https://www.gnu.org/software/global/global.html). You will need version
|
|
955
1076
|
# 4.8.6 or higher.
|
|
956
1077
|
#
|
|
957
1078
|
# To use it do the following:
|
|
958
1079
|
# - Install the latest version of global
|
|
959
|
-
# - Enable SOURCE_BROWSER and USE_HTAGS in the
|
|
1080
|
+
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
|
|
960
1081
|
# - Make sure the INPUT points to the root of the source tree
|
|
961
1082
|
# - Run doxygen as normal
|
|
962
1083
|
#
|
|
@@ -989,13 +1110,6 @@ VERBATIM_HEADERS = YES
|
|
|
989
1110
|
|
|
990
1111
|
ALPHABETICAL_INDEX = YES
|
|
991
1112
|
|
|
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
1113
|
# In case all classes in a project start with a common prefix, all classes will
|
|
1000
1114
|
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
|
|
1001
1115
|
# can be used to specify a prefix (or a list of prefixes) that should be ignored
|
|
@@ -1008,7 +1122,7 @@ IGNORE_PREFIX =
|
|
|
1008
1122
|
# Configuration options related to the HTML output
|
|
1009
1123
|
#---------------------------------------------------------------------------
|
|
1010
1124
|
|
|
1011
|
-
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
|
|
1125
|
+
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
|
|
1012
1126
|
# The default value is: YES.
|
|
1013
1127
|
|
|
1014
1128
|
GENERATE_HTML = YES
|
|
@@ -1019,7 +1133,7 @@ GENERATE_HTML = YES
|
|
|
1019
1133
|
# The default directory is: html.
|
|
1020
1134
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
1021
1135
|
|
|
1022
|
-
HTML_OUTPUT =
|
|
1136
|
+
HTML_OUTPUT = @DOXYGEN_HTMLDIR@
|
|
1023
1137
|
|
|
1024
1138
|
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
|
|
1025
1139
|
# generated HTML page (for example: .htm, .php, .asp).
|
|
@@ -1074,10 +1188,10 @@ HTML_STYLESHEET =
|
|
|
1074
1188
|
# cascading style sheets that are included after the standard style sheets
|
|
1075
1189
|
# created by doxygen. Using this option one can overrule certain style aspects.
|
|
1076
1190
|
# This is preferred over using HTML_STYLESHEET since it does not replace the
|
|
1077
|
-
# standard style sheet and is
|
|
1191
|
+
# standard style sheet and is therefore more robust against future updates.
|
|
1078
1192
|
# Doxygen will copy the style sheet files to the output directory.
|
|
1079
|
-
# Note: The order of the extra
|
|
1080
|
-
#
|
|
1193
|
+
# Note: The order of the extra style sheet files is of importance (e.g. the last
|
|
1194
|
+
# style sheet in the list overrules the setting of the previous ones in the
|
|
1081
1195
|
# list). For an example see the documentation.
|
|
1082
1196
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
1083
1197
|
|
|
@@ -1094,9 +1208,9 @@ HTML_EXTRA_STYLESHEET =
|
|
|
1094
1208
|
HTML_EXTRA_FILES =
|
|
1095
1209
|
|
|
1096
1210
|
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
|
|
1097
|
-
# will adjust the colors in the
|
|
1211
|
+
# will adjust the colors in the style sheet and background images according to
|
|
1098
1212
|
# this color. Hue is specified as an angle on a colorwheel, see
|
|
1099
|
-
#
|
|
1213
|
+
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
|
|
1100
1214
|
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
|
|
1101
1215
|
# purple, and 360 is red again.
|
|
1102
1216
|
# Minimum value: 0, maximum value: 359, default value: 220.
|
|
@@ -1125,12 +1239,24 @@ HTML_COLORSTYLE_GAMMA = 80
|
|
|
1125
1239
|
|
|
1126
1240
|
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
|
1127
1241
|
# page will contain the date and time when the page was generated. Setting this
|
|
1128
|
-
# to
|
|
1129
|
-
#
|
|
1242
|
+
# to YES can help to show when doxygen was last run and thus if the
|
|
1243
|
+
# documentation is up to date.
|
|
1244
|
+
# The default value is: NO.
|
|
1130
1245
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
1131
1246
|
|
|
1132
1247
|
HTML_TIMESTAMP = YES
|
|
1133
1248
|
|
|
1249
|
+
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
|
|
1250
|
+
# documentation will contain a main index with vertical navigation menus that
|
|
1251
|
+
# are dynamically created via JavaScript. If disabled, the navigation index will
|
|
1252
|
+
# consists of multiple levels of tabs that are statically embedded in every HTML
|
|
1253
|
+
# page. Disable this option to support browsers that do not have JavaScript,
|
|
1254
|
+
# like the Qt help browser.
|
|
1255
|
+
# The default value is: YES.
|
|
1256
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
1257
|
+
|
|
1258
|
+
HTML_DYNAMIC_MENUS = YES
|
|
1259
|
+
|
|
1134
1260
|
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
|
|
1135
1261
|
# documentation will contain sections that can be hidden and shown after the
|
|
1136
1262
|
# page has loaded.
|
|
@@ -1154,13 +1280,14 @@ HTML_INDEX_NUM_ENTRIES = 100
|
|
|
1154
1280
|
|
|
1155
1281
|
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
|
|
1156
1282
|
# generated that can be used as input for Apple's Xcode 3 integrated development
|
|
1157
|
-
# environment (see:
|
|
1158
|
-
# OSX 10.5 (Leopard). To
|
|
1159
|
-
#
|
|
1160
|
-
#
|
|
1283
|
+
# environment (see:
|
|
1284
|
+
# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
|
|
1285
|
+
# create a documentation set, doxygen will generate a Makefile in the HTML
|
|
1286
|
+
# output directory. Running make will produce the docset in that directory and
|
|
1287
|
+
# running make install will install the docset in
|
|
1161
1288
|
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
|
|
1162
|
-
# startup. See
|
|
1163
|
-
# for more information.
|
|
1289
|
+
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
|
|
1290
|
+
# genXcode/_index.html for more information.
|
|
1164
1291
|
# The default value is: NO.
|
|
1165
1292
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
1166
1293
|
|
|
@@ -1199,8 +1326,8 @@ DOCSET_PUBLISHER_NAME = Publisher
|
|
|
1199
1326
|
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
|
|
1200
1327
|
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
|
|
1201
1328
|
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
|
|
1202
|
-
# (see:
|
|
1203
|
-
# Windows.
|
|
1329
|
+
# (see:
|
|
1330
|
+
# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
|
|
1204
1331
|
#
|
|
1205
1332
|
# The HTML Help Workshop contains a compiler that can convert all HTML output
|
|
1206
1333
|
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
|
|
@@ -1222,28 +1349,28 @@ GENERATE_HTMLHELP = NO
|
|
|
1222
1349
|
CHM_FILE =
|
|
1223
1350
|
|
|
1224
1351
|
# The HHC_LOCATION tag can be used to specify the location (absolute path
|
|
1225
|
-
# including file name) of the HTML help compiler (
|
|
1352
|
+
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
|
|
1226
1353
|
# doxygen will try to run the HTML help compiler on the generated index.hhp.
|
|
1227
1354
|
# The file has to be specified with full path.
|
|
1228
1355
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
|
1229
1356
|
|
|
1230
1357
|
HHC_LOCATION =
|
|
1231
1358
|
|
|
1232
|
-
# The GENERATE_CHI flag controls if a separate .chi index file is generated
|
|
1233
|
-
# YES) or that it should be included in the
|
|
1359
|
+
# The GENERATE_CHI flag controls if a separate .chi index file is generated
|
|
1360
|
+
# (YES) or that it should be included in the main .chm file (NO).
|
|
1234
1361
|
# The default value is: NO.
|
|
1235
1362
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
|
1236
1363
|
|
|
1237
1364
|
GENERATE_CHI = NO
|
|
1238
1365
|
|
|
1239
|
-
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (
|
|
1366
|
+
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
|
|
1240
1367
|
# and project file content.
|
|
1241
1368
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
|
1242
1369
|
|
|
1243
1370
|
CHM_INDEX_ENCODING =
|
|
1244
1371
|
|
|
1245
|
-
# The BINARY_TOC flag controls whether a binary table of contents is generated
|
|
1246
|
-
# YES) or a normal table of contents (
|
|
1372
|
+
# The BINARY_TOC flag controls whether a binary table of contents is generated
|
|
1373
|
+
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
|
|
1247
1374
|
# enables the Previous and Next buttons.
|
|
1248
1375
|
# The default value is: NO.
|
|
1249
1376
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
|
@@ -1275,7 +1402,8 @@ QCH_FILE =
|
|
|
1275
1402
|
|
|
1276
1403
|
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
|
|
1277
1404
|
# Project output. For more information please see Qt Help Project / Namespace
|
|
1278
|
-
# (see:
|
|
1405
|
+
# (see:
|
|
1406
|
+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
|
|
1279
1407
|
# The default value is: org.doxygen.Project.
|
|
1280
1408
|
# This tag requires that the tag GENERATE_QHP is set to YES.
|
|
1281
1409
|
|
|
@@ -1283,8 +1411,8 @@ QHP_NAMESPACE = org.doxygen.Project
|
|
|
1283
1411
|
|
|
1284
1412
|
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
|
|
1285
1413
|
# Help Project output. For more information please see Qt Help Project / Virtual
|
|
1286
|
-
# Folders (see:
|
|
1287
|
-
# folders).
|
|
1414
|
+
# Folders (see:
|
|
1415
|
+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
|
|
1288
1416
|
# The default value is: doc.
|
|
1289
1417
|
# This tag requires that the tag GENERATE_QHP is set to YES.
|
|
1290
1418
|
|
|
@@ -1292,30 +1420,30 @@ QHP_VIRTUAL_FOLDER = doc
|
|
|
1292
1420
|
|
|
1293
1421
|
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
|
|
1294
1422
|
# filter to add. For more information please see Qt Help Project / Custom
|
|
1295
|
-
# Filters (see:
|
|
1296
|
-
# filters).
|
|
1423
|
+
# Filters (see:
|
|
1424
|
+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
|
|
1297
1425
|
# This tag requires that the tag GENERATE_QHP is set to YES.
|
|
1298
1426
|
|
|
1299
1427
|
QHP_CUST_FILTER_NAME =
|
|
1300
1428
|
|
|
1301
1429
|
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
|
|
1302
1430
|
# custom filter to add. For more information please see Qt Help Project / Custom
|
|
1303
|
-
# Filters (see:
|
|
1304
|
-
# filters).
|
|
1431
|
+
# Filters (see:
|
|
1432
|
+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
|
|
1305
1433
|
# This tag requires that the tag GENERATE_QHP is set to YES.
|
|
1306
1434
|
|
|
1307
1435
|
QHP_CUST_FILTER_ATTRS =
|
|
1308
1436
|
|
|
1309
1437
|
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
|
1310
1438
|
# project's filter section matches. Qt Help Project / Filter Attributes (see:
|
|
1311
|
-
#
|
|
1439
|
+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
|
|
1312
1440
|
# This tag requires that the tag GENERATE_QHP is set to YES.
|
|
1313
1441
|
|
|
1314
1442
|
QHP_SECT_FILTER_ATTRS =
|
|
1315
1443
|
|
|
1316
|
-
# The QHG_LOCATION tag can be used to specify the location
|
|
1317
|
-
# qhelpgenerator. If non-empty doxygen will try to
|
|
1318
|
-
# generated .qhp file.
|
|
1444
|
+
# The QHG_LOCATION tag can be used to specify the location (absolute path
|
|
1445
|
+
# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
|
|
1446
|
+
# run qhelpgenerator on the generated .qhp file.
|
|
1319
1447
|
# This tag requires that the tag GENERATE_QHP is set to YES.
|
|
1320
1448
|
|
|
1321
1449
|
QHG_LOCATION =
|
|
@@ -1357,7 +1485,7 @@ DISABLE_INDEX = NO
|
|
|
1357
1485
|
# index structure (just like the one that is generated for HTML Help). For this
|
|
1358
1486
|
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
|
|
1359
1487
|
# (i.e. any modern browser). Windows users are probably better off using the
|
|
1360
|
-
# HTML help feature. Via custom
|
|
1488
|
+
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
|
|
1361
1489
|
# further fine-tune the look of the index. As an example, the default style
|
|
1362
1490
|
# sheet generated by doxygen has an example that shows how to put an image at
|
|
1363
1491
|
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
|
|
@@ -1385,13 +1513,24 @@ ENUM_VALUES_PER_LINE = 4
|
|
|
1385
1513
|
|
|
1386
1514
|
TREEVIEW_WIDTH = 250
|
|
1387
1515
|
|
|
1388
|
-
#
|
|
1516
|
+
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
|
|
1389
1517
|
# external symbols imported via tag files in a separate window.
|
|
1390
1518
|
# The default value is: NO.
|
|
1391
1519
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
1392
1520
|
|
|
1393
1521
|
EXT_LINKS_IN_WINDOW = NO
|
|
1394
1522
|
|
|
1523
|
+
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
|
|
1524
|
+
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
|
|
1525
|
+
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
|
|
1526
|
+
# the HTML output. These images will generally look nicer at scaled resolutions.
|
|
1527
|
+
# Possible values are: png (the default) and svg (looks nicer but requires the
|
|
1528
|
+
# pdf2svg or inkscape tool).
|
|
1529
|
+
# The default value is: png.
|
|
1530
|
+
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
1531
|
+
|
|
1532
|
+
HTML_FORMULA_FORMAT = png
|
|
1533
|
+
|
|
1395
1534
|
# Use this tag to change the font size of LaTeX formulas included as images in
|
|
1396
1535
|
# the HTML documentation. When you change the font size after a successful
|
|
1397
1536
|
# doxygen run you need to manually remove any form_*.png images from the HTML
|
|
@@ -1401,7 +1540,7 @@ EXT_LINKS_IN_WINDOW = NO
|
|
|
1401
1540
|
|
|
1402
1541
|
FORMULA_FONTSIZE = 10
|
|
1403
1542
|
|
|
1404
|
-
# Use the
|
|
1543
|
+
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
|
|
1405
1544
|
# generated for formulas are transparent PNGs. Transparent PNGs are not
|
|
1406
1545
|
# supported properly for IE 6.0, but are supported on all modern browsers.
|
|
1407
1546
|
#
|
|
@@ -1412,9 +1551,15 @@ FORMULA_FONTSIZE = 10
|
|
|
1412
1551
|
|
|
1413
1552
|
FORMULA_TRANSPARENT = YES
|
|
1414
1553
|
|
|
1554
|
+
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
|
|
1555
|
+
# to create new LaTeX commands to be used in formulas as building blocks. See
|
|
1556
|
+
# the section "Including formulas" for details.
|
|
1557
|
+
|
|
1558
|
+
FORMULA_MACROFILE =
|
|
1559
|
+
|
|
1415
1560
|
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
|
|
1416
|
-
#
|
|
1417
|
-
# instead of using
|
|
1561
|
+
# https://www.mathjax.org) which uses client side JavaScript for the rendering
|
|
1562
|
+
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
|
|
1418
1563
|
# installed or if you want to formulas look prettier in the HTML output. When
|
|
1419
1564
|
# enabled you may also need to install MathJax separately and configure the path
|
|
1420
1565
|
# to it using the MATHJAX_RELPATH option.
|
|
@@ -1425,7 +1570,7 @@ USE_MATHJAX = NO
|
|
|
1425
1570
|
|
|
1426
1571
|
# When MathJax is enabled you can set the default output format to be used for
|
|
1427
1572
|
# the MathJax output. See the MathJax site (see:
|
|
1428
|
-
# http://docs.mathjax.org/en/latest/output.html) for more details.
|
|
1573
|
+
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
|
|
1429
1574
|
# Possible values are: HTML-CSS (which is slower, but has the best
|
|
1430
1575
|
# compatibility), NativeMML (i.e. MathML) and SVG.
|
|
1431
1576
|
# The default value is: HTML-CSS.
|
|
@@ -1440,8 +1585,8 @@ MATHJAX_FORMAT = HTML-CSS
|
|
|
1440
1585
|
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
|
|
1441
1586
|
# Content Delivery Network so you can quickly see the result without installing
|
|
1442
1587
|
# MathJax. However, it is strongly recommended to install a local copy of
|
|
1443
|
-
# MathJax from
|
|
1444
|
-
# The default value is:
|
|
1588
|
+
# MathJax from https://www.mathjax.org before deployment.
|
|
1589
|
+
# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
|
|
1445
1590
|
# This tag requires that the tag USE_MATHJAX is set to YES.
|
|
1446
1591
|
|
|
1447
1592
|
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
|
@@ -1455,7 +1600,8 @@ MATHJAX_EXTENSIONS =
|
|
|
1455
1600
|
|
|
1456
1601
|
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
|
|
1457
1602
|
# of code that will be used on startup of the MathJax code. See the MathJax site
|
|
1458
|
-
# (see:
|
|
1603
|
+
# (see:
|
|
1604
|
+
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
|
|
1459
1605
|
# example see the documentation.
|
|
1460
1606
|
# This tag requires that the tag USE_MATHJAX is set to YES.
|
|
1461
1607
|
|
|
@@ -1483,7 +1629,7 @@ MATHJAX_CODEFILE =
|
|
|
1483
1629
|
SEARCHENGINE = NO
|
|
1484
1630
|
|
|
1485
1631
|
# 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
|
|
1632
|
+
# implemented using a web server instead of a web client using JavaScript. There
|
|
1487
1633
|
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
|
|
1488
1634
|
# setting. When disabled, doxygen will generate a PHP script for searching and
|
|
1489
1635
|
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
|
|
@@ -1500,9 +1646,10 @@ SERVER_BASED_SEARCH = NO
|
|
|
1500
1646
|
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
|
|
1501
1647
|
# search results.
|
|
1502
1648
|
#
|
|
1503
|
-
# Doxygen ships with an example indexer (
|
|
1649
|
+
# Doxygen ships with an example indexer (doxyindexer) and search engine
|
|
1504
1650
|
# (doxysearch.cgi) which are based on the open source search engine library
|
|
1505
|
-
# Xapian (see:
|
|
1651
|
+
# Xapian (see:
|
|
1652
|
+
# https://xapian.org/).
|
|
1506
1653
|
#
|
|
1507
1654
|
# See the section "External Indexing and Searching" for details.
|
|
1508
1655
|
# The default value is: NO.
|
|
@@ -1513,10 +1660,11 @@ EXTERNAL_SEARCH = NO
|
|
|
1513
1660
|
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
|
|
1514
1661
|
# which will return the search results when EXTERNAL_SEARCH is enabled.
|
|
1515
1662
|
#
|
|
1516
|
-
# Doxygen ships with an example indexer (
|
|
1663
|
+
# Doxygen ships with an example indexer (doxyindexer) and search engine
|
|
1517
1664
|
# (doxysearch.cgi) which are based on the open source search engine library
|
|
1518
|
-
# Xapian (see:
|
|
1519
|
-
# Searching" for
|
|
1665
|
+
# Xapian (see:
|
|
1666
|
+
# https://xapian.org/). See the section "External Indexing and Searching" for
|
|
1667
|
+
# details.
|
|
1520
1668
|
# This tag requires that the tag SEARCHENGINE is set to YES.
|
|
1521
1669
|
|
|
1522
1670
|
SEARCHENGINE_URL =
|
|
@@ -1551,7 +1699,7 @@ EXTRA_SEARCH_MAPPINGS =
|
|
|
1551
1699
|
# Configuration options related to the LaTeX output
|
|
1552
1700
|
#---------------------------------------------------------------------------
|
|
1553
1701
|
|
|
1554
|
-
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
|
|
1702
|
+
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
|
|
1555
1703
|
# The default value is: YES.
|
|
1556
1704
|
|
|
1557
1705
|
GENERATE_LATEX = NO
|
|
@@ -1567,22 +1715,36 @@ LATEX_OUTPUT = latex
|
|
|
1567
1715
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
|
1568
1716
|
# invoked.
|
|
1569
1717
|
#
|
|
1570
|
-
# Note that when enabling USE_PDFLATEX
|
|
1571
|
-
#
|
|
1572
|
-
#
|
|
1573
|
-
#
|
|
1718
|
+
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
|
|
1719
|
+
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
|
|
1720
|
+
# chosen this is overwritten by pdflatex. For specific output languages the
|
|
1721
|
+
# default can have been set differently, this depends on the implementation of
|
|
1722
|
+
# the output language.
|
|
1574
1723
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1575
1724
|
|
|
1576
1725
|
LATEX_CMD_NAME = latex
|
|
1577
1726
|
|
|
1578
1727
|
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
|
|
1579
1728
|
# index for LaTeX.
|
|
1729
|
+
# Note: This tag is used in the Makefile / make.bat.
|
|
1730
|
+
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
|
|
1731
|
+
# (.tex).
|
|
1580
1732
|
# The default file is: makeindex.
|
|
1581
1733
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1582
1734
|
|
|
1583
1735
|
MAKEINDEX_CMD_NAME = makeindex
|
|
1584
1736
|
|
|
1585
|
-
#
|
|
1737
|
+
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
|
|
1738
|
+
# generate index for LaTeX. In case there is no backslash (\) as first character
|
|
1739
|
+
# it will be automatically added in the LaTeX code.
|
|
1740
|
+
# Note: This tag is used in the generated output file (.tex).
|
|
1741
|
+
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
|
|
1742
|
+
# The default value is: makeindex.
|
|
1743
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1744
|
+
|
|
1745
|
+
LATEX_MAKEINDEX_CMD = makeindex
|
|
1746
|
+
|
|
1747
|
+
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
|
|
1586
1748
|
# documents. This may be useful for small projects and may help to save some
|
|
1587
1749
|
# trees in general.
|
|
1588
1750
|
# The default value is: NO.
|
|
@@ -1597,12 +1759,15 @@ COMPACT_LATEX = NO
|
|
|
1597
1759
|
# The default value is: a4.
|
|
1598
1760
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1599
1761
|
|
|
1600
|
-
PAPER_TYPE =
|
|
1762
|
+
PAPER_TYPE = a4
|
|
1601
1763
|
|
|
1602
1764
|
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
|
|
1603
|
-
# that should be included in the LaTeX output.
|
|
1604
|
-
#
|
|
1605
|
-
#
|
|
1765
|
+
# that should be included in the LaTeX output. The package can be specified just
|
|
1766
|
+
# by its name or with the correct syntax as to be used with the LaTeX
|
|
1767
|
+
# \usepackage command. To get the times font for instance you can specify :
|
|
1768
|
+
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
|
|
1769
|
+
# To use the option intlimits with the amsmath package you can specify:
|
|
1770
|
+
# EXTRA_PACKAGES=[intlimits]{amsmath}
|
|
1606
1771
|
# If left blank no extra packages will be included.
|
|
1607
1772
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1608
1773
|
|
|
@@ -1617,9 +1782,9 @@ EXTRA_PACKAGES =
|
|
|
1617
1782
|
# Note: Only use a user-defined header if you know what you are doing! The
|
|
1618
1783
|
# following commands have a special meaning inside the header: $title,
|
|
1619
1784
|
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
|
|
1620
|
-
# $projectbrief, $projectlogo. Doxygen will replace $title with the
|
|
1621
|
-
# for the replacement values of the other commands the user is
|
|
1622
|
-
# HTML_HEADER.
|
|
1785
|
+
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
|
|
1786
|
+
# string, for the replacement values of the other commands the user is referred
|
|
1787
|
+
# to HTML_HEADER.
|
|
1623
1788
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1624
1789
|
|
|
1625
1790
|
LATEX_HEADER =
|
|
@@ -1635,6 +1800,17 @@ LATEX_HEADER =
|
|
|
1635
1800
|
|
|
1636
1801
|
LATEX_FOOTER =
|
|
1637
1802
|
|
|
1803
|
+
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
|
|
1804
|
+
# LaTeX style sheets that are included after the standard style sheets created
|
|
1805
|
+
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
|
|
1806
|
+
# will copy the style sheet files to the output directory.
|
|
1807
|
+
# Note: The order of the extra style sheet files is of importance (e.g. the last
|
|
1808
|
+
# style sheet in the list overrules the setting of the previous ones in the
|
|
1809
|
+
# list).
|
|
1810
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1811
|
+
|
|
1812
|
+
LATEX_EXTRA_STYLESHEET =
|
|
1813
|
+
|
|
1638
1814
|
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
|
|
1639
1815
|
# other source files which should be copied to the LATEX_OUTPUT output
|
|
1640
1816
|
# directory. Note that the files will be copied as-is; there are no commands or
|
|
@@ -1652,9 +1828,11 @@ LATEX_EXTRA_FILES =
|
|
|
1652
1828
|
|
|
1653
1829
|
PDF_HYPERLINKS = NO
|
|
1654
1830
|
|
|
1655
|
-
# If the USE_PDFLATEX tag is set to YES, doxygen will use
|
|
1656
|
-
# the PDF file directly from the LaTeX
|
|
1657
|
-
# higher quality PDF documentation.
|
|
1831
|
+
# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
|
|
1832
|
+
# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
|
|
1833
|
+
# files. Set this option to YES, to get a higher quality PDF documentation.
|
|
1834
|
+
#
|
|
1835
|
+
# See also section LATEX_CMD_NAME for selecting the engine.
|
|
1658
1836
|
# The default value is: YES.
|
|
1659
1837
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1660
1838
|
|
|
@@ -1688,17 +1866,33 @@ LATEX_SOURCE_CODE = NO
|
|
|
1688
1866
|
|
|
1689
1867
|
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
|
|
1690
1868
|
# bibliography, e.g. plainnat, or ieeetr. See
|
|
1691
|
-
#
|
|
1869
|
+
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
|
|
1692
1870
|
# The default value is: plain.
|
|
1693
1871
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1694
1872
|
|
|
1695
1873
|
LATEX_BIB_STYLE = plain
|
|
1696
1874
|
|
|
1875
|
+
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
|
|
1876
|
+
# page will contain the date and time when the page was generated. Setting this
|
|
1877
|
+
# to NO can help when comparing the output of multiple runs.
|
|
1878
|
+
# The default value is: NO.
|
|
1879
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1880
|
+
|
|
1881
|
+
LATEX_TIMESTAMP = NO
|
|
1882
|
+
|
|
1883
|
+
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
|
|
1884
|
+
# path from which the emoji images will be read. If a relative path is entered,
|
|
1885
|
+
# it will be relative to the LATEX_OUTPUT directory. If left blank the
|
|
1886
|
+
# LATEX_OUTPUT directory will be used.
|
|
1887
|
+
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
1888
|
+
|
|
1889
|
+
LATEX_EMOJI_DIRECTORY =
|
|
1890
|
+
|
|
1697
1891
|
#---------------------------------------------------------------------------
|
|
1698
1892
|
# Configuration options related to the RTF output
|
|
1699
1893
|
#---------------------------------------------------------------------------
|
|
1700
1894
|
|
|
1701
|
-
# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
|
|
1895
|
+
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
|
|
1702
1896
|
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
|
|
1703
1897
|
# readers/editors.
|
|
1704
1898
|
# The default value is: NO.
|
|
@@ -1713,7 +1907,7 @@ GENERATE_RTF = NO
|
|
|
1713
1907
|
|
|
1714
1908
|
RTF_OUTPUT = rtf
|
|
1715
1909
|
|
|
1716
|
-
# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
|
|
1910
|
+
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
|
|
1717
1911
|
# documents. This may be useful for small projects and may help to save some
|
|
1718
1912
|
# trees in general.
|
|
1719
1913
|
# The default value is: NO.
|
|
@@ -1733,9 +1927,9 @@ COMPACT_RTF = NO
|
|
|
1733
1927
|
|
|
1734
1928
|
RTF_HYPERLINKS = NO
|
|
1735
1929
|
|
|
1736
|
-
# Load stylesheet definitions from file. Syntax is similar to doxygen's
|
|
1737
|
-
# file, i.e. a series of assignments. You only have to provide
|
|
1738
|
-
# missing definitions are set to their default value.
|
|
1930
|
+
# Load stylesheet definitions from file. Syntax is similar to doxygen's
|
|
1931
|
+
# configuration file, i.e. a series of assignments. You only have to provide
|
|
1932
|
+
# replacements, missing definitions are set to their default value.
|
|
1739
1933
|
#
|
|
1740
1934
|
# See also section "Doxygen usage" for information on how to generate the
|
|
1741
1935
|
# default style sheet that doxygen normally uses.
|
|
@@ -1744,17 +1938,27 @@ RTF_HYPERLINKS = NO
|
|
|
1744
1938
|
RTF_STYLESHEET_FILE =
|
|
1745
1939
|
|
|
1746
1940
|
# Set optional variables used in the generation of an RTF document. Syntax is
|
|
1747
|
-
# similar to doxygen's
|
|
1748
|
-
# using doxygen -e rtf extensionFile.
|
|
1941
|
+
# similar to doxygen's configuration file. A template extensions file can be
|
|
1942
|
+
# generated using doxygen -e rtf extensionFile.
|
|
1749
1943
|
# This tag requires that the tag GENERATE_RTF is set to YES.
|
|
1750
1944
|
|
|
1751
1945
|
RTF_EXTENSIONS_FILE =
|
|
1752
1946
|
|
|
1947
|
+
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
|
|
1948
|
+
# with syntax highlighting in the RTF output.
|
|
1949
|
+
#
|
|
1950
|
+
# Note that which sources are shown also depends on other settings such as
|
|
1951
|
+
# SOURCE_BROWSER.
|
|
1952
|
+
# The default value is: NO.
|
|
1953
|
+
# This tag requires that the tag GENERATE_RTF is set to YES.
|
|
1954
|
+
|
|
1955
|
+
RTF_SOURCE_CODE = NO
|
|
1956
|
+
|
|
1753
1957
|
#---------------------------------------------------------------------------
|
|
1754
1958
|
# Configuration options related to the man page output
|
|
1755
1959
|
#---------------------------------------------------------------------------
|
|
1756
1960
|
|
|
1757
|
-
# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
|
|
1961
|
+
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
|
|
1758
1962
|
# classes and files.
|
|
1759
1963
|
# The default value is: NO.
|
|
1760
1964
|
|
|
@@ -1798,7 +2002,7 @@ MAN_LINKS = NO
|
|
|
1798
2002
|
# Configuration options related to the XML output
|
|
1799
2003
|
#---------------------------------------------------------------------------
|
|
1800
2004
|
|
|
1801
|
-
# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
|
|
2005
|
+
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
|
|
1802
2006
|
# captures the structure of the code including all documentation.
|
|
1803
2007
|
# The default value is: NO.
|
|
1804
2008
|
|
|
@@ -1812,7 +2016,7 @@ GENERATE_XML = NO
|
|
|
1812
2016
|
|
|
1813
2017
|
XML_OUTPUT = xml
|
|
1814
2018
|
|
|
1815
|
-
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
|
|
2019
|
+
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
|
|
1816
2020
|
# listings (including syntax highlighting and cross-referencing information) to
|
|
1817
2021
|
# the XML output. Note that enabling this will significantly increase the size
|
|
1818
2022
|
# of the XML output.
|
|
@@ -1821,11 +2025,18 @@ XML_OUTPUT = xml
|
|
|
1821
2025
|
|
|
1822
2026
|
XML_PROGRAMLISTING = YES
|
|
1823
2027
|
|
|
2028
|
+
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
|
|
2029
|
+
# namespace members in file scope as well, matching the HTML output.
|
|
2030
|
+
# The default value is: NO.
|
|
2031
|
+
# This tag requires that the tag GENERATE_XML is set to YES.
|
|
2032
|
+
|
|
2033
|
+
XML_NS_MEMB_FILE_SCOPE = NO
|
|
2034
|
+
|
|
1824
2035
|
#---------------------------------------------------------------------------
|
|
1825
2036
|
# Configuration options related to the DOCBOOK output
|
|
1826
2037
|
#---------------------------------------------------------------------------
|
|
1827
2038
|
|
|
1828
|
-
# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
|
|
2039
|
+
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
|
|
1829
2040
|
# that can be used to generate PDF.
|
|
1830
2041
|
# The default value is: NO.
|
|
1831
2042
|
|
|
@@ -1839,7 +2050,7 @@ GENERATE_DOCBOOK = NO
|
|
|
1839
2050
|
|
|
1840
2051
|
DOCBOOK_OUTPUT = docbook
|
|
1841
2052
|
|
|
1842
|
-
# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
|
|
2053
|
+
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
|
|
1843
2054
|
# program listings (including syntax highlighting and cross-referencing
|
|
1844
2055
|
# information) to the DOCBOOK output. Note that enabling this will significantly
|
|
1845
2056
|
# increase the size of the DOCBOOK output.
|
|
@@ -1852,10 +2063,10 @@ DOCBOOK_PROGRAMLISTING = NO
|
|
|
1852
2063
|
# Configuration options for the AutoGen Definitions output
|
|
1853
2064
|
#---------------------------------------------------------------------------
|
|
1854
2065
|
|
|
1855
|
-
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an
|
|
1856
|
-
# Definitions (see http://autogen.
|
|
1857
|
-
# the code including all documentation. Note that this feature
|
|
1858
|
-
# experimental and incomplete at the moment.
|
|
2066
|
+
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
|
|
2067
|
+
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
|
|
2068
|
+
# the structure of the code including all documentation. Note that this feature
|
|
2069
|
+
# is still experimental and incomplete at the moment.
|
|
1859
2070
|
# The default value is: NO.
|
|
1860
2071
|
|
|
1861
2072
|
GENERATE_AUTOGEN_DEF = NO
|
|
@@ -1864,7 +2075,7 @@ GENERATE_AUTOGEN_DEF = NO
|
|
|
1864
2075
|
# Configuration options related to the Perl module output
|
|
1865
2076
|
#---------------------------------------------------------------------------
|
|
1866
2077
|
|
|
1867
|
-
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
|
|
2078
|
+
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
|
|
1868
2079
|
# file that captures the structure of the code including all documentation.
|
|
1869
2080
|
#
|
|
1870
2081
|
# Note that this feature is still experimental and incomplete at the moment.
|
|
@@ -1872,7 +2083,7 @@ GENERATE_AUTOGEN_DEF = NO
|
|
|
1872
2083
|
|
|
1873
2084
|
GENERATE_PERLMOD = NO
|
|
1874
2085
|
|
|
1875
|
-
# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
|
|
2086
|
+
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
|
|
1876
2087
|
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
|
|
1877
2088
|
# output from the Perl module output.
|
|
1878
2089
|
# The default value is: NO.
|
|
@@ -1880,9 +2091,9 @@ GENERATE_PERLMOD = NO
|
|
|
1880
2091
|
|
|
1881
2092
|
PERLMOD_LATEX = NO
|
|
1882
2093
|
|
|
1883
|
-
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
|
|
2094
|
+
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
|
|
1884
2095
|
# 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
|
|
2096
|
+
# understand what is going on. On the other hand, if this tag is set to NO, the
|
|
1886
2097
|
# size of the Perl module output will be much smaller and Perl will parse it
|
|
1887
2098
|
# just the same.
|
|
1888
2099
|
# The default value is: YES.
|
|
@@ -1902,14 +2113,14 @@ PERLMOD_MAKEVAR_PREFIX =
|
|
|
1902
2113
|
# Configuration options related to the preprocessor
|
|
1903
2114
|
#---------------------------------------------------------------------------
|
|
1904
2115
|
|
|
1905
|
-
# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
|
|
2116
|
+
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
|
|
1906
2117
|
# C-preprocessor directives found in the sources and include files.
|
|
1907
2118
|
# The default value is: YES.
|
|
1908
2119
|
|
|
1909
2120
|
ENABLE_PREPROCESSING = YES
|
|
1910
2121
|
|
|
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
|
|
2122
|
+
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
|
|
2123
|
+
# in the source code. If set to NO, only conditional compilation will be
|
|
1913
2124
|
# performed. Macro expansion can be done in a controlled way by setting
|
|
1914
2125
|
# EXPAND_ONLY_PREDEF to YES.
|
|
1915
2126
|
# The default value is: NO.
|
|
@@ -1925,7 +2136,7 @@ MACRO_EXPANSION = YES
|
|
|
1925
2136
|
|
|
1926
2137
|
EXPAND_ONLY_PREDEF = YES
|
|
1927
2138
|
|
|
1928
|
-
# If the SEARCH_INCLUDES tag is set to YES the
|
|
2139
|
+
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
|
|
1929
2140
|
# INCLUDE_PATH will be searched if a #include is found.
|
|
1930
2141
|
# The default value is: YES.
|
|
1931
2142
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
|
@@ -1956,8 +2167,9 @@ INCLUDE_FILE_PATTERNS =
|
|
|
1956
2167
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
|
1957
2168
|
|
|
1958
2169
|
PREDEFINED = API_EXPORTED= \
|
|
2170
|
+
DEFAULT_VISIBILITY= \
|
|
1959
2171
|
LIBUSB_CALL= \
|
|
1960
|
-
|
|
2172
|
+
LIBUSB_PACKED=
|
|
1961
2173
|
|
|
1962
2174
|
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
|
|
1963
2175
|
# tag can be used to specify a list of macro names that should be expanded. The
|
|
@@ -2003,37 +2215,32 @@ TAGFILES =
|
|
|
2003
2215
|
|
|
2004
2216
|
GENERATE_TAGFILE =
|
|
2005
2217
|
|
|
2006
|
-
# If the ALLEXTERNALS tag is set to YES all external class will be listed in
|
|
2007
|
-
# class index. If set to NO only the inherited external classes will be
|
|
2218
|
+
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
|
|
2219
|
+
# the class index. If set to NO, only the inherited external classes will be
|
|
2220
|
+
# listed.
|
|
2008
2221
|
# The default value is: NO.
|
|
2009
2222
|
|
|
2010
2223
|
ALLEXTERNALS = NO
|
|
2011
2224
|
|
|
2012
|
-
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
|
2013
|
-
# the modules index. If set to NO, only the current project's groups will be
|
|
2225
|
+
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
|
|
2226
|
+
# in the modules index. If set to NO, only the current project's groups will be
|
|
2014
2227
|
# listed.
|
|
2015
2228
|
# The default value is: YES.
|
|
2016
2229
|
|
|
2017
2230
|
EXTERNAL_GROUPS = YES
|
|
2018
2231
|
|
|
2019
|
-
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
|
|
2232
|
+
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
|
|
2020
2233
|
# the related pages index. If set to NO, only the current project's pages will
|
|
2021
2234
|
# be listed.
|
|
2022
2235
|
# The default value is: YES.
|
|
2023
2236
|
|
|
2024
2237
|
EXTERNAL_PAGES = YES
|
|
2025
2238
|
|
|
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
2239
|
#---------------------------------------------------------------------------
|
|
2033
2240
|
# Configuration options related to the dot tool
|
|
2034
2241
|
#---------------------------------------------------------------------------
|
|
2035
2242
|
|
|
2036
|
-
# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
|
|
2243
|
+
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
|
|
2037
2244
|
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
|
|
2038
2245
|
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
|
|
2039
2246
|
# disabled, but it is recommended to install and use dot, since it yields more
|
|
@@ -2042,15 +2249,6 @@ PERL_PATH = /usr/bin/perl
|
|
|
2042
2249
|
|
|
2043
2250
|
CLASS_DIAGRAMS = YES
|
|
2044
2251
|
|
|
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
2252
|
# You can include diagrams made with dia in doxygen documentation. Doxygen will
|
|
2055
2253
|
# then run dia to produce the diagram and insert it in the documentation. The
|
|
2056
2254
|
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
|
|
@@ -2058,7 +2256,7 @@ MSCGEN_PATH =
|
|
|
2058
2256
|
|
|
2059
2257
|
DIA_PATH =
|
|
2060
2258
|
|
|
2061
|
-
# If set to YES
|
|
2259
|
+
# If set to YES the inheritance and collaboration graphs will hide inheritance
|
|
2062
2260
|
# and usage relations if the target is undocumented or is not a class.
|
|
2063
2261
|
# The default value is: YES.
|
|
2064
2262
|
|
|
@@ -2131,7 +2329,7 @@ COLLABORATION_GRAPH = YES
|
|
|
2131
2329
|
|
|
2132
2330
|
GROUP_GRAPHS = YES
|
|
2133
2331
|
|
|
2134
|
-
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
|
2332
|
+
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
|
|
2135
2333
|
# collaboration diagrams in a style similar to the OMG's Unified Modeling
|
|
2136
2334
|
# Language.
|
|
2137
2335
|
# The default value is: NO.
|
|
@@ -2148,10 +2346,32 @@ UML_LOOK = NO
|
|
|
2148
2346
|
# but if the number exceeds 15, the total amount of fields shown is limited to
|
|
2149
2347
|
# 10.
|
|
2150
2348
|
# Minimum value: 0, maximum value: 100, default value: 10.
|
|
2151
|
-
# This tag requires that the tag
|
|
2349
|
+
# This tag requires that the tag UML_LOOK is set to YES.
|
|
2152
2350
|
|
|
2153
2351
|
UML_LIMIT_NUM_FIELDS = 10
|
|
2154
2352
|
|
|
2353
|
+
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
|
|
2354
|
+
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
|
|
2355
|
+
# tag is set to YES, doxygen will add type and arguments for attributes and
|
|
2356
|
+
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
|
|
2357
|
+
# will not generate fields with class member information in the UML graphs. The
|
|
2358
|
+
# class diagrams will look similar to the default class diagrams but using UML
|
|
2359
|
+
# notation for the relationships.
|
|
2360
|
+
# Possible values are: NO, YES and NONE.
|
|
2361
|
+
# The default value is: NO.
|
|
2362
|
+
# This tag requires that the tag UML_LOOK is set to YES.
|
|
2363
|
+
|
|
2364
|
+
DOT_UML_DETAILS = NO
|
|
2365
|
+
|
|
2366
|
+
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
|
|
2367
|
+
# to display on a single line. If the actual line length exceeds this threshold
|
|
2368
|
+
# significantly it will wrapped across multiple lines. Some heuristics are apply
|
|
2369
|
+
# to avoid ugly line breaks.
|
|
2370
|
+
# Minimum value: 0, maximum value: 1000, default value: 17.
|
|
2371
|
+
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
2372
|
+
|
|
2373
|
+
DOT_WRAP_THRESHOLD = 17
|
|
2374
|
+
|
|
2155
2375
|
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
|
|
2156
2376
|
# collaboration graphs will show the relations between templates and their
|
|
2157
2377
|
# instances.
|
|
@@ -2183,7 +2403,8 @@ INCLUDED_BY_GRAPH = YES
|
|
|
2183
2403
|
#
|
|
2184
2404
|
# Note that enabling this option will significantly increase the time of a run.
|
|
2185
2405
|
# So in most cases it will be better to enable call graphs for selected
|
|
2186
|
-
# functions only using the \callgraph command.
|
|
2406
|
+
# functions only using the \callgraph command. Disabling a call graph can be
|
|
2407
|
+
# accomplished by means of the command \hidecallgraph.
|
|
2187
2408
|
# The default value is: NO.
|
|
2188
2409
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
2189
2410
|
|
|
@@ -2194,7 +2415,8 @@ CALL_GRAPH = NO
|
|
|
2194
2415
|
#
|
|
2195
2416
|
# Note that enabling this option will significantly increase the time of a run.
|
|
2196
2417
|
# So in most cases it will be better to enable caller graphs for selected
|
|
2197
|
-
# functions only using the \callergraph command.
|
|
2418
|
+
# functions only using the \callergraph command. Disabling a caller graph can be
|
|
2419
|
+
# accomplished by means of the command \hidecallergraph.
|
|
2198
2420
|
# The default value is: NO.
|
|
2199
2421
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
2200
2422
|
|
|
@@ -2217,11 +2439,15 @@ GRAPHICAL_HIERARCHY = YES
|
|
|
2217
2439
|
DIRECTORY_GRAPH = YES
|
|
2218
2440
|
|
|
2219
2441
|
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
|
2220
|
-
# generated by dot.
|
|
2442
|
+
# generated by dot. For an explanation of the image formats see the section
|
|
2443
|
+
# output formats in the documentation of the dot tool (Graphviz (see:
|
|
2444
|
+
# http://www.graphviz.org/)).
|
|
2221
2445
|
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
|
|
2222
2446
|
# to make the SVG files visible in IE 9+ (other browsers do not have this
|
|
2223
2447
|
# requirement).
|
|
2224
|
-
# Possible values are: png, jpg, gif
|
|
2448
|
+
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
|
|
2449
|
+
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
|
|
2450
|
+
# png:gdiplus:gdiplus.
|
|
2225
2451
|
# The default value is: png.
|
|
2226
2452
|
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
2227
2453
|
|
|
@@ -2269,10 +2495,19 @@ DIAFILE_DIRS =
|
|
|
2269
2495
|
# PlantUML is not used or called during a preprocessing step. Doxygen will
|
|
2270
2496
|
# generate a warning when it encounters a \startuml command in this case and
|
|
2271
2497
|
# will not generate output for the diagram.
|
|
2272
|
-
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
2273
2498
|
|
|
2274
2499
|
PLANTUML_JAR_PATH =
|
|
2275
2500
|
|
|
2501
|
+
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
|
|
2502
|
+
# configuration file for plantuml.
|
|
2503
|
+
|
|
2504
|
+
PLANTUML_CFG_FILE =
|
|
2505
|
+
|
|
2506
|
+
# When using plantuml, the specified paths are searched for files specified by
|
|
2507
|
+
# the !include statement in a plantuml block.
|
|
2508
|
+
|
|
2509
|
+
PLANTUML_INCLUDE_PATH =
|
|
2510
|
+
|
|
2276
2511
|
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
|
|
2277
2512
|
# that will be shown in the graph. If the number of nodes in a graph becomes
|
|
2278
2513
|
# larger than this value, doxygen will truncate the graph, which is visualized
|
|
@@ -2309,7 +2544,7 @@ MAX_DOT_GRAPH_DEPTH = 0
|
|
|
2309
2544
|
|
|
2310
2545
|
DOT_TRANSPARENT = NO
|
|
2311
2546
|
|
|
2312
|
-
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
|
|
2547
|
+
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
|
|
2313
2548
|
# files in one run (i.e. multiple -o and -T options on the command line). This
|
|
2314
2549
|
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
|
|
2315
2550
|
# this, this feature is disabled by default.
|
|
@@ -2326,9 +2561,11 @@ DOT_MULTI_TARGETS = NO
|
|
|
2326
2561
|
|
|
2327
2562
|
GENERATE_LEGEND = YES
|
|
2328
2563
|
|
|
2329
|
-
# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate
|
|
2564
|
+
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
|
|
2330
2565
|
# files that are used to generate the various graphs.
|
|
2566
|
+
#
|
|
2567
|
+
# Note: This setting is not only used for dot files but also for msc and
|
|
2568
|
+
# plantuml temporary files.
|
|
2331
2569
|
# The default value is: YES.
|
|
2332
|
-
# This tag requires that the tag HAVE_DOT is set to YES.
|
|
2333
2570
|
|
|
2334
2571
|
DOT_CLEANUP = YES
|