diff --git a/app-emulation/opencbm/Manifest b/app-emulation/opencbm/Manifest index 25309c30..e909e9ce 100644 --- a/app-emulation/opencbm/Manifest +++ b/app-emulation/opencbm/Manifest @@ -1,9 +1,10 @@ AUX 001_opencbm-0.4.99.98-ncurses6-1.patch 698 BLAKE2B 3d126aca22c4c1aa7cf6df35c41f1d32c8117aebcbc0fd10c7bd007dbb5752155b703b6a4585ba0a1ac5c3744e95b4b5e412c0d7834c5fcf4aa74d758b3f198d SHA512 a4b017a8bcbd698c01c9e695758826a4768bd316634a585f746460ec35bcffe67a76cd3e8f2ebcabf2eddbbb5e5dc5db2533f8d4881b1030b314253fc22264dd AUX 002_opencbm-0.4.99.104-gcc15-1.patch 946 BLAKE2B 2bf8446bc1f9615a91c6fedc8a2e7e4c2f9b378cf64a07daf3f89e73f628742ffc5e77a02b652d280fa3de83d141c325c2b6be0060b67290e7c697817f26382d SHA512 39f48d657c434c655196a12bbed9b8325440b0e7b4344af18fab5025c8068974e29105060e7c0ca1c09d924f1824cb29e1e8f5266e26fe27513ff87d33959c27 AUX Makefile 1089 BLAKE2B b011c132af72138147a558303c787efe2f584adf3697f681a0ca594e9220ec3d384cceece1172550cfe96c8f267b34c4f1e32d9b3999590a82b02667c72e800c SHA512 f16d7cfc2fd8dcbef211cef44ed03c3c0edb0a047be82b1116f999d6cbee765e5ded884181077e39a2074d001113fc88a5bae2a819b4e314d33bd30719dd909a -DIST nibtools-20241120-source.tar.gz 119413 BLAKE2B c59a515147113865d3f75e1af2c54d9e08d93c95c389bbe9be71b0afb1079e3901cade612a6471af745826b5cd406694accc6d460e2e509b40d32f327f5f7b35 SHA512 5a8e34a379bf8ceeae80ba40a948b8c0577432122229ec3205e1829e8dfc041dfabead9e69919b15272a029ec82a91ef30025889ca0a6509ba28b1ec380a14c6 +AUX OpenCBM-0_4_99_104_p9999.patch 585950 BLAKE2B 941d59cc7736776b9008ee9c37f24f1af6703a7c8c50021894b6be7c3a646e80d32b76112d9fbedaa97149d6d898146a3fd054ff1aa7f904e5bb2e782fc095ec SHA512 d538fdb25183818e35e498a2fd04c731053df6ff8fbc57f0b67cb1455779479c581ef36bc134773fe22bc81483abe81ece782d58687fde87a29a217d96fcc352 +DIST nibtools-20250627-source.tar.gz 133581 BLAKE2B f78e02ffc98114390632bff371cc2e8d94b741a7f5743c7daf9725279f2c626e7c30e02c68094aa19099956a16e2cf8a64efc08133b8de2a839687c170103e48 SHA512 c972e86c15a8f8019e3dd9c13c6d4600a97593dd02947c94c28d0a2f41ab1e829def60200d596b2755d12261dc1b37974542c83355005fa9cf108410e797e6ad DIST opencbm-0.4.99.104-source.tar.gz 13417312 BLAKE2B 1ba6e88c8765a161d6cb7a1c313c2db6cc885c616ac110c0833f59c93e2b2081e67ce730a7ead123a59b83133ddc2edf448de694c72ca582c3a155a463175027 SHA512 1c5c09ed2fd37a6db152eb9739739edee8b2200a4e02b219e982337eeb935cdac1125f59f235b5c3d1203bcd0701c2e9e35da9de921797f1617014f723de0faa -EBUILD opencbm-0.4.99.104.ebuild 3419 BLAKE2B 777d181cf7c5d82b27381dcd488d28b97b28f780f4c403c8c004f7728a7ce0071bf357bf0386d9e134c03ab8be898b27a5a7e90f971a8509079b45adc8443eb1 SHA512 f3505277bf1d11cb5684443368b2495e1e7ed3ab28a42f7dc8b1e043462eaa99ba675808b6243328132f5998bc1379489ea34ad4f782ab0c75251d31e659f7ba -EBUILD opencbm-9999.ebuild 3419 BLAKE2B 777d181cf7c5d82b27381dcd488d28b97b28f780f4c403c8c004f7728a7ce0071bf357bf0386d9e134c03ab8be898b27a5a7e90f971a8509079b45adc8443eb1 SHA512 f3505277bf1d11cb5684443368b2495e1e7ed3ab28a42f7dc8b1e043462eaa99ba675808b6243328132f5998bc1379489ea34ad4f782ab0c75251d31e659f7ba +EBUILD opencbm-0.4.99.104.ebuild 3494 BLAKE2B c93540cb0e50c2b8ba9a3e612603e73d677e526c2daa355da2d3c6e947c692db029f912e104c9ca635030c544c28049ba32eb2f977d40c645841a916fa61381d SHA512 53d585e330c04fde0c1505dba4df7664fe7e2038c834ae7aa615093eccc3069efdc27fbbc7f29b0170d8a2950747b203adc1fc14ce2c7780c8b2c31abcf83817 +EBUILD opencbm-9999.ebuild 3494 BLAKE2B c93540cb0e50c2b8ba9a3e612603e73d677e526c2daa355da2d3c6e947c692db029f912e104c9ca635030c544c28049ba32eb2f977d40c645841a916fa61381d SHA512 53d585e330c04fde0c1505dba4df7664fe7e2038c834ae7aa615093eccc3069efdc27fbbc7f29b0170d8a2950747b203adc1fc14ce2c7780c8b2c31abcf83817 MISC ChangeLog 1266 BLAKE2B c0347d5e0361182d79816ff25a52e2d52c52cf932adab716503f8a738da6c0643d08f4d14b9315ea6a9f2bf8e056c1da91a2a2515684f85a8f204e16731a7a7e SHA512 d3cea999760ee90a45148f31963a532ce3ff6db7122b11b8b06ca094f3d936309a2c8cc90e15fc7af86bda40952b28667db403b30c26c0189a083f9bc447b466 MISC metadata.xml 493 BLAKE2B 7d4be69e09b1fa78bdd2fba1313bfe2527facc3ce1d37d6f5ca6a81e96f560c49b86d66ff5ad965375b61ab0f212e732f70a1965d57dbf5e10946b973915c7ec SHA512 ad6dc1300e43923807aef874ee3b862fdbdccc611cbd89732e5dc46d0a116da6c81e478afb673d1ff14ed6d0887353941a08835da600a7b18162469eb1e42daa diff --git a/app-emulation/opencbm/files/OpenCBM-0_4_99_104_p9999.patch b/app-emulation/opencbm/files/OpenCBM-0_4_99_104_p9999.patch new file mode 100644 index 00000000..7bb452b0 --- /dev/null +++ b/app-emulation/opencbm/files/OpenCBM-0_4_99_104_p9999.patch @@ -0,0 +1,16844 @@ +diff '--color=auto' -uNr OpenCBM-0_4_99_104/debian/changelog OpenCBM-master/debian/changelog +--- OpenCBM-0_4_99_104/debian/changelog 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/debian/changelog 2026-03-26 21:53:53.000000000 +0100 +@@ -2,15 +2,33 @@ + + * Update to v0.4.99.104 + +- -- Spiro Trikaliotis Sat, 22 Jan 2022 20:59:53 +0100 ++ -- Spiro Trikaliotis Sun, 23 Jan 2022 20:47:53 +0100 + + opencbm (0.4.99.103) unstable; urgency=low + +- * Update to v0.4.99.103 ++ * opencbm-xa1541-module: use DKMS to make it work again. + +- -- Spiro Trikaliotis Fri, 16 Jul 2021 21:56:53 +0200 ++ -- Spiro Trikaliotis Sun, 16 Jan 2022 16:19:00 +0100 + +-opencbm (0.4.99.102.git.1593016058.07635d9e) unstable; urgency=low ++opencbm (0.4.99.103) unstable; urgency=low ++ ++ * Fix compilation by removing the revision number after the hyphen ++ ++ -- Spiro Trikaliotis Fri, 16 Jul 2021 17:35:00 +0200 ++ ++opencbm (0.4.99.103-2) unstable; urgency=low ++ ++ * Fix missing libopencbm.so symlink to libopencbm.so.0 ++ ++ -- Spiro Trikaliotis Fri, 13 Nov 2020 17:37:00 +0100 ++ ++opencbm (0.4.99.103) unstable; urgency=low ++ ++ * Compile latest version. ++ ++ -- Spiro Trikaliotis Thu, 16 Jul 2020 16:41:00 +0200 ++ ++opencbm (0.4.99.102) unstable; urgency=low + + * Compile latest version. + +diff '--color=auto' -uNr OpenCBM-0_4_99_104/debian/control OpenCBM-master/debian/control +--- OpenCBM-0_4_99_104/debian/control 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/debian/control 2026-03-26 21:53:53.000000000 +0100 +@@ -5,6 +5,7 @@ + Build-Depends: debhelper (>= 9), linuxdoc-tools-latex, linuxdoc-tools-text, libusb-1.0-0-dev, pkg-config, cc65, libncurses5-dev, texlive-fonts-recommended, texinfo, ghostscript + Homepage: http://opencbm.trikaliotis.net/ + Standards-Version: 3.9.8 ++Rules-Requires-Root: binary-targets + + Package: opencbm + Architecture: any +diff '--color=auto' -uNr OpenCBM-0_4_99_104/debian/opencbm.files OpenCBM-master/debian/opencbm.files +--- OpenCBM-0_4_99_104/debian/opencbm.files 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/debian/opencbm.files 2026-03-26 21:53:53.000000000 +0100 +@@ -12,6 +12,5 @@ + usr/bin/imgcopy + usr/bin/opencbm_plugin_helper_tools + etc/devfs/*/opencbm +-etc/modutils/opencbm + usr/lib/opencbm/install_plugin.sh + usr/lib/opencbm/plugin_helper_tools +diff '--color=auto' -uNr OpenCBM-0_4_99_104/debian/opencbm.modprobe.d.opencbm.conf OpenCBM-master/debian/opencbm.modprobe.d.opencbm.conf +--- OpenCBM-0_4_99_104/debian/opencbm.modprobe.d.opencbm.conf 1970-01-01 01:00:00.000000000 +0100 ++++ OpenCBM-master/debian/opencbm.modprobe.d.opencbm.conf 2026-03-26 21:53:53.000000000 +0100 +@@ -0,0 +1,30 @@ ++# sample kernel module configuration for opencbm ++ ++# everyone wants to enable this: ++alias char-major-10-177 cbm ++ ++# If you have the 2.[24].x parport system enabled, you might need ++# to specify the parallel port IRQ: ++#options parport_pc io=0x378 irq=7 ++ ++# again, only for the 2.[24].x parport system: ++#options cbm lp=0 ++ ++# 2.0.x kernel, or 2.[24].x without parport subsystem: ++#options cbm port=0x378 irq=7 ++ ++# ++# additional options for the cbm module (usually not needed): ++# ++# cable= ++# N < 0 : autodetect (default) ++# N = 0 : non-inverting (XM1541) ++# N > 0 : non-inverting (XA1541) ++# ++# reset= ++# N < 0 : smart reset (automatically reset if needed) ++# N = 0 : never reset when loading the module ++# N = 1 : always reset when loading the module ++# ++ ++# vim: ft=conf +diff '--color=auto' -uNr OpenCBM-0_4_99_104/debian/opencbm.modutils OpenCBM-master/debian/opencbm.modutils +--- OpenCBM-0_4_99_104/debian/opencbm.modutils 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/debian/opencbm.modutils 1970-01-01 01:00:00.000000000 +0100 +@@ -1,30 +0,0 @@ +-# sample kernel module configuration for opencbm +- +-# everyone wants to enable this: +-alias char-major-10-177 cbm +- +-# If you have the 2.[24].x parport system enabled, you might need +-# to specify the parallel port IRQ: +-#options parport_pc io=0x378 irq=7 +- +-# again, only for the 2.[24].x parport system: +-#options cbm lp=0 +- +-# 2.0.x kernel, or 2.[24].x without parport subsystem: +-#options cbm port=0x378 irq=7 +- +-# +-# additional options for the cbm module (usually not needed): +-# +-# cable= +-# N < 0 : autodetect (default) +-# N = 0 : non-inverting (XM1541) +-# N > 0 : non-inverting (XA1541) +-# +-# reset= +-# N < 0 : smart reset (automatically reset if needed) +-# N = 0 : never reset when loading the module +-# N = 1 : always reset when loading the module +-# +- +-# vim: ft=conf +diff '--color=auto' -uNr OpenCBM-0_4_99_104/debian/opencbm-xa1541.files OpenCBM-master/debian/opencbm-xa1541.files +--- OpenCBM-0_4_99_104/debian/opencbm-xa1541.files 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/debian/opencbm-xa1541.files 2026-03-26 21:53:53.000000000 +0100 +@@ -1,2 +1,3 @@ ++etc/modprobe.d/opencbm.conf + usr/lib/opencbm/plugin/libopencbm-xa1541* + lib/udev/rules.d/45-opencbm-xa1541.rules +diff '--color=auto' -uNr OpenCBM-0_4_99_104/debian/rules OpenCBM-master/debian/rules +--- OpenCBM-0_4_99_104/debian/rules 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/debian/rules 2026-03-26 21:53:53.000000000 +0100 +@@ -9,8 +9,6 @@ + # Note: debian/compat is the place to change this! + #export DH_COMPAT=7 + +- +- + ifneq (,$(findstring debug,$(DEB_BUILD_OPTIONS))) + CFLAGS += -g + endif +@@ -89,8 +87,8 @@ + UDEVRULESDIR=/lib/udev/rules.d/ \ + install-all + +- install -D -o root -g root -m 644 debian/opencbm.modutils \ +- debian/tmp/etc/modutils/opencbm ++ install -D -o root -g root -m 644 debian/opencbm.modprobe.d.opencbm.conf \ ++ debian/tmp/etc/modprobe.d/opencbm.conf + + install -D -o root -g root -m 755 opencbm/LINUX/plugin_helper_tools \ + debian/tmp/usr/lib/opencbm +@@ -98,8 +96,8 @@ + debian/tmp/usr/lib/opencbm + + mkdir -p debian/tmp/usr/src/opencbm-xa1541-${DEB_UPSTREAM_VERSION} +- cp opencbm/sys/linux/cbm_module.c opencbm/include/LINUX/cbm_module.h debian/tmp/usr/src/opencbm-xa1541-${DEB_UPSTREAM_VERSION} +- cp debian/Makefile.module debian/tmp/usr/src/opencbm-xa1541-${DEB_UPSTREAM_VERSION}/Makefile ++ cp -p opencbm/sys/linux/cbm_module.c opencbm/include/LINUX/cbm_module.h debian/tmp/usr/src/opencbm-xa1541-${DEB_UPSTREAM_VERSION} ++ cp -p debian/Makefile.module debian/tmp/usr/src/opencbm-xa1541-${DEB_UPSTREAM_VERSION}/Makefile + + # Build architecture-independent files here. + binary-indep: build install +diff '--color=auto' -uNr OpenCBM-0_4_99_104/.editorconfig OpenCBM-master/.editorconfig +--- OpenCBM-0_4_99_104/.editorconfig 1970-01-01 01:00:00.000000000 +0100 ++++ OpenCBM-master/.editorconfig 2026-03-26 21:53:53.000000000 +0100 +@@ -0,0 +1,36 @@ ++# EditorConfig: https://editorconfig.org ++ ++root = true ++ ++[Makefile] ++charset = utf-8 ++tab_width = 8 ++indent_size = 8 ++indent_style = tab ++ ++[*.{c,h,a65,i65,idh}] ++charset = utf-8 ++tab_width = 4 ++indent_size = 4 ++indent_style = space ++insert_final_newline = true ++trim_trailing_whitespace = true ++ ++[*.{md,txt}] ++charset = utf-8 ++tab_width = 2 ++indent_size = 2 ++indent_style = space ++insert_final_newline = true ++trim_trailing_whitespace = true ++ ++[{dirs,sources}] ++charset = utf-8 ++tab_width = 4 ++indent_size = 4 ++indent_style = space ++insert_final_newline = true ++trim_trailing_whitespace = true ++ ++[*.{bat,vbs,ps1,dsp,dsw}] ++end_of_line = CRLF +diff '--color=auto' -uNr OpenCBM-0_4_99_104/.gitmodules OpenCBM-master/.gitmodules +--- OpenCBM-0_4_99_104/.gitmodules 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/.gitmodules 2026-03-26 21:53:53.000000000 +0100 +@@ -1,4 +1,5 @@ + [submodule "opencbm/nibtools"] + path = opencbm/nibtools + # url = git@github.com:OpenCBM/nibtools.git +- url = https://github.com/OpenCBM/nibtools.git ++# url = https://github.com/OpenCBM/nibtools.git ++ url = https://github.com/rittwage/nibtools.git +diff '--color=auto' -uNr OpenCBM-0_4_99_104/LINUX/Makefile OpenCBM-master/LINUX/Makefile +--- OpenCBM-0_4_99_104/LINUX/Makefile 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/LINUX/Makefile 2026-03-26 21:53:53.000000000 +0100 +@@ -27,6 +27,8 @@ + SUBDIRS_PLUGIN_XUM1541 = opencbm/lib/plugin/xum1541 xum1541cfg + endif + ++SUBDIRS_PLUGIN_XDUMMY = opencbm/lib/plugin/xdummy ++ + ifeq ($(strip $(HAVE_KERNEL_SOURCE)),) + ifeq ($(strip $(FORCE_PLUGIN_XA1541)),) + SUBDIRS_PLUGIN_XA1541 = +@@ -44,7 +46,7 @@ + SUBDIRS_OPTIONAL = opencbm/addon opencbm/nibtools opencbm/mnib36 opencbm/cbmrpm41 opencbm/cbmlinetester + + +-SUBDIRS_PLUGIN = $(SUBDIRS_PLUGIN_XUM1541) $(SUBDIRS_PLUGIN_XU1541) $(SUBDIRS_PLUGIN_XA1541) ++SUBDIRS_PLUGIN = $(SUBDIRS_PLUGIN_XUM1541) $(SUBDIRS_PLUGIN_XU1541) $(SUBDIRS_PLUGIN_XA1541) $(SUBDIRS_PLUGIN_XDUMMY) + + SUBDIRS_ALL_NON_OPTIONAL= $(SUBDIRS) $(SUBDIRS_DOC) $(SUBDIRS_PLUGIN) + +@@ -73,10 +75,6 @@ + $(call CREATE_TARGETS,$(filter-out $(SUBDIRS_PLUGIN_XA1541),$(SUBDIRS_ALL_NON_OPTIONAL)) $(SUBDIRS_OPTIONAL),all):: $(call CREATE_TARGET,opencbm/lib,all) + $(call CREATE_TARGETS,opencbm/sample/libtrans,all):: $(call CREATE_TARGET,opencbm/libtrans,all) + +-$(call CREATE_TARGETS,opencbm/lib,install):: $(call CREATE_TARGET,opencbm/arch/$(OS_ARCH) opencbm/libmisc,install) +-$(call CREATE_TARGETS,$(SUBDIRS_ALL_NON_OPTIONAL) $(SUBDIRS_OPTIONAL),install):: $(call CREATE_TARGET,opencbm/lib,install) +-$(call CREATE_TARGETS,opencbm/sample/libtrans,install):: $(call CREATE_TARGET,opencbm/libtrans,install) +- + + .PHONY: $(call CREATE_TARGETS,$(SUBDIRS_ALL_NON_OPTIONAL),all clean mrproper install install-files install-files-doc install-doc uninstall) + $(call CREATE_TARGETS,$(SUBDIRS_ALL_NON_OPTIONAL),all clean mrproper install install-files install-files-doc install-doc uninstall):: +@@ -145,6 +143,8 @@ + + $(call CREATE_TARGET,$(SUBDIRS_PLUGIN_XA1541),install):: plugin-xa1541 + ++install-plugin-xdummy: $(call CREATE_TARGET,$(SUBDIRS_PLUGIN_XDUMMY),install) ++ + + install-plugin: $(INSTALL_PLUGINS) + +@@ -168,6 +168,10 @@ + + $(call CREATE_TARGET,$(SUBDIRS_PLUGIN_XA1541),all):: opencbm + ++plugin-xdummy: $(call CREATE_TARGET,$(SUBDIRS_PLUGIN_XDUMMY),all) ++ ++$(call CREATE_TARGET,$(SUBDIRS_PLUGIN_XDUMMY),all):: opencbm ++ + plugin: $(PLUGINS) + + uninstall: $(call CREATE_TARGET,$(SUBDIRS_ALL_NON_OPTIONAL) $(SUBDIRS_OPTIONAL),uninstall) +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/arch/linux/LINUX/Makefile OpenCBM-master/opencbm/arch/linux/LINUX/Makefile +--- OpenCBM-0_4_99_104/opencbm/arch/linux/LINUX/Makefile 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/arch/linux/LINUX/Makefile 2026-03-26 21:53:53.000000000 +0100 +@@ -7,7 +7,8 @@ + + LIB = libarch.a + SRCS = ctrlbreak.c \ +- file.c ++ file.c \ ++ sleep.c + + ifeq "$(OS)" "Darwin" + SRCS += error.c +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/arch/linux/sleep.c OpenCBM-master/opencbm/arch/linux/sleep.c +--- OpenCBM-0_4_99_104/opencbm/arch/linux/sleep.c 1970-01-01 01:00:00.000000000 +0100 ++++ OpenCBM-master/opencbm/arch/linux/sleep.c 2026-03-26 21:53:53.000000000 +0100 +@@ -0,0 +1,62 @@ ++/* ++ * This program is free software; you can redistribute it and/or ++ * modify it under the terms of the GNU General Public License ++ * as published by the Free Software Foundation; either version ++ * 2 of the License, or (at your option) any later version. ++ * ++ * Copyright 2025 Spiro Trikaliotis ++ */ ++ ++#include "arch.h" ++ ++#include ++ ++/*! \brief Sleep for a specified time in microseconds ++ ++ This function sleeps, that is, it suspends execution of the program for a ++ given time period. ++ ++ \param Microseconds ++ The time (in microseconds, us) to sleep ++ ++ \remark ++ As Sleep() of Windows does not have a lower granularity than 1 ms, ++ this function rounds up the microseconds to the next millisecond on ++ Windows systems. ++*/ ++void arch_sleep_us(unsigned int Microseconds) ++{ ++ struct timespec time_to_sleep = { 0, Microseconds * 1000ul }; ++ ++ nanosleep(&time_to_sleep, NULL); ++} ++ ++/*! \brief Sleep for a specified time in milliseconds ++ ++ This function sleeps, that is, it suspends execution of the program for a ++ given time period. ++ ++ \param Milliseconds ++ The time (in milliseconds, ms) to sleep ++*/ ++void arch_sleep_ms(unsigned int Milliseconds) ++{ ++ struct timespec time_to_sleep = { 0, Milliseconds * 1000000ul }; ++ ++ nanosleep(&time_to_sleep, NULL); ++} ++ ++/*! \brief Sleep for a specified time in seconds ++ ++ This function sleeps, that is, it suspends execution of the program for a ++ given time period. ++ ++ \param Sec ++ The time (in seconds, s) to sleep ++*/ ++void arch_sleep_s(unsigned int Seconds) ++{ ++ struct timespec time_to_sleep = { Seconds, 0 }; ++ ++ nanosleep(&time_to_sleep, NULL); ++} +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/arch/windows/debug.c OpenCBM-master/opencbm/arch/windows/debug.c +--- OpenCBM-0_4_99_104/opencbm/arch/windows/debug.c 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/arch/windows/debug.c 2026-03-26 21:53:53.000000000 +0100 +@@ -18,6 +18,11 @@ + #include + #include + ++#if _MSC_VER <= 1200 ++ /* MSVC 6 did not have __FUNCTION__ yet, define a mockup */ ++ char __FUNCTION__[] = ""; ++#endif ++ + + + /*! Buffers where the debug string will be build up before it is +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/arch/windows/sleep.c OpenCBM-master/opencbm/arch/windows/sleep.c +--- OpenCBM-0_4_99_104/opencbm/arch/windows/sleep.c 1970-01-01 01:00:00.000000000 +0100 ++++ OpenCBM-master/opencbm/arch/windows/sleep.c 2026-03-26 21:53:53.000000000 +0100 +@@ -0,0 +1,71 @@ ++/* ++ * This program is free software; you can redistribute it and/or ++ * modify it under the terms of the GNU General Public License ++ * as published by the Free Software Foundation; either version ++ * 2 of the License, or (at your option) any later version. ++ * ++ * Copyright 2025 Spiro Trikaliotis ++ */ ++ ++#include ++ ++#include "arch.h" ++ ++/*! \brief Sleep for a specified time in microseconds ++ ++ This function sleeps, that is, it suspends execution of the program for a ++ given time period. ++ ++ \param Microseconds ++ The time (in microseconds, us) to sleep ++ ++ \return ++ 0 on success ++ ++ \remark ++ As Sleep() of Windows does not have a lower granularity than 1 ms, ++ this function rounds up the microseconds to the next millisecond on ++ Windows systems. ++*/ ++void arch_sleep_us(unsigned int Microseconds) ++{ ++ Sleep((Microseconds + 999u) / 1000u); ++ ++ return 0; ++} ++ ++/*! \brief Sleep for a specified time in milliseconds ++ ++ This function sleeps, that is, it suspends execution of the program for a ++ given time period. ++ ++ \param Milliseconds ++ The time (in milliseconds, ms) to sleep ++ ++ \return ++ 0 on success ++*/ ++void arch_sleep_ms(unsigned int Milliseconds) ++{ ++ Sleep(Milliseconds); ++ ++ return 0; ++} ++ ++/*! \brief Sleep for a specified time in seconds ++ ++ This function sleeps, that is, it suspends execution of the program for a ++ given time period. ++ ++ \param Sec ++ The time (in seconds, s) to sleep ++ ++ \return ++ 0 on success ++*/ ++void arch_sleep_s(unsigned int Seconds) ++{ ++ Sleep(Seconds * 1000u); ++ ++ return 0; ++} +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/arch/windows/WINDOWS/arch.dsp OpenCBM-master/opencbm/arch/windows/WINDOWS/arch.dsp +--- OpenCBM-0_4_99_104/opencbm/arch/windows/WINDOWS/arch.dsp 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/arch/windows/WINDOWS/arch.dsp 2026-03-26 21:53:53.000000000 +0100 +@@ -115,6 +115,10 @@ + + SOURCE=..\getopt_init.c + # End Source File ++# Begin Source File ++ ++SOURCE=..\sleep.c ++# End Source File + # End Group + # Begin Group "Header Files" + +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/arch/windows/WINDOWS/sources OpenCBM-master/opencbm/arch/windows/WINDOWS/sources +--- OpenCBM-0_4_99_104/opencbm/arch/windows/WINDOWS/sources 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/arch/windows/WINDOWS/sources 2026-03-26 21:53:53.000000000 +0100 +@@ -16,7 +16,8 @@ + ../file.c \ + ../getopt.c \ + ../getopt1.c \ +- ../getopt_init.c ++ ../getopt_init.c \ ++ ../sleep.c + + UMTYPE=console + #UMBASE=0x100000 +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/cbmcopy/main.c OpenCBM-master/opencbm/cbmcopy/main.c +--- OpenCBM-0_4_99_104/opencbm/cbmcopy/main.c 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/cbmcopy/main.c 2026-03-26 21:53:53.000000000 +0100 +@@ -30,6 +30,8 @@ + #include "statedebug.h" + + ++#define FN_BUFFER_SIZE 48 ++ + /* global, because of signal handler */ + static CBM_FILE fd_cbm; + +@@ -180,7 +182,7 @@ + int option; + unsigned char *filedata; + size_t filesize; +- char buf[48]; ++ char buf[FN_BUFFER_SIZE]; + int num_entries; + int num_files; + int rv; +@@ -488,20 +490,24 @@ + { + if(output_name) + { +- strncpy(buf, output_name, 16); +- buf[16] = '\0'; ++ /* leave room for file type, mode and '\0' */ ++ strncpy(buf, output_name, sizeof(buf)-5); ++ buf[sizeof(buf)-5] = '\0'; + cbm_ascii2petscii(buf); ++ ++ tail = strchr(buf, '\0'); + } + else + { + /* no charset conversion */ + strncpy(buf, auto_name, 16); + buf[16] = '\0'; +- } +- for(tail = buf; *tail; tail++) +- { +- /* replace illegal characters in CBM filename */ +- if(strchr(":?*,=", *tail)) *tail = ' '; ++ ++ for(tail = buf; *tail; tail++) ++ { ++ /* replace illegal characters in CBM filename */ ++ if(strchr(":?*,=", *tail)) *tail = ' '; ++ } + } + *tail++ = ','; + *tail++ = output_type ? output_type : auto_type; +@@ -566,8 +572,9 @@ + } + else + { +- strncpy(buf, fname, 16); +- buf[16] = '\0'; ++ /* leave room for file type and '\0' */ ++ strncpy(buf, fname, sizeof(buf)-3); ++ buf[sizeof(buf)-3] = '\0'; + cbm_ascii2petscii(buf); + + if(output_name) +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/cbmctrl/cbmctrl.1 OpenCBM-master/opencbm/cbmctrl/cbmctrl.1 +--- OpenCBM-0_4_99_104/opencbm/cbmctrl/cbmctrl.1 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/cbmctrl/cbmctrl.1 2026-03-26 21:53:53.000000000 +0100 +@@ -1,9 +1,9 @@ + .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. +-.TH CBMCTRL "1" "July 2020" "cbmctrl version 0.4.99.103, built on Jul 14 2020 at 18:05:13" "User Commands" ++.TH CBMCTRL "1" "June 2025" "cbmctrl version 0.4.99.104, built on Jun 19 2025" "User Commands" + .SH NAME +-cbmctrl \- manual page for cbmctrl version 0.4.99.103, built on Jul 14 2020 at 18:05:13 ++cbmctrl \- manual page for cbmctrl version 0.4.99.104, built on Jun 19 2025 + .SH DESCRIPTION +-cbmctrl version 0.4.99.103, built on Jul 14 2020 at 18:05:13 ++cbmctrl cbmctrl version 0.4.99.104, built on Jun 19 2025 + .PP + control serial CBM devices + .TP +@@ -24,7 +24,7 @@ + requires an argument of the form [:]. + is the backend plugin's name to use (e.g.: xa1541) + is a bus unit identifier, if supported by the backend; +-.TP ++.IP + look up the backend's documentation for the supported + bus unit identifier(s) and the format for + .HP +@@ -37,6 +37,19 @@ + Do not convert data between CBM and PC format. + Default with 'open' and 'command'. + .TP ++\fB\-1\fR, \fB\-\-dos1\fR: ++Use DOS1 compatibility mode ++.IP ++This can be used to access old 2040 drives which are still equipped with DOS1. ++.IP ++Commands status and detect should work, as well as download and upload. ++.IP ++Others might also work, but have not been tested yet. ++.TP ++\fB\-R\fR, \fB\-\-retry\fR: ++Allow retries in case of errors on memory transfers. The optional ++argument specifies the number of retries. ++.TP + \fB\-\-\fR + Delimiter between action_opt and action_args; if any of the + arguments in action_args starts with a '\-', make sure to set +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/cbmctrl/cbmctrl.c OpenCBM-master/opencbm/cbmctrl/cbmctrl.c +--- OpenCBM-0_4_99_104/opencbm/cbmctrl/cbmctrl.c 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/cbmctrl/cbmctrl.c 2026-03-26 21:53:53.000000000 +0100 +@@ -11,6 +11,7 @@ + */ + + #include "opencbm.h" ++#include "opencbm-dos.h" + + #include "cbmctrl.h" + +@@ -992,7 +993,7 @@ + if (options->petsciiraw == PA_PETSCII) + cbm_petscii2ascii(buf); + +- printf("%s", buf); ++ printf("%s\n", buf); + + return (rv == 99) ? 1 : 0; + } +@@ -1125,7 +1126,10 @@ + } + cbm_untalk(fd); + cbm_device_status(fd, command.device, buf, sizeof(buf)); +- printf("%s", cbm_petscii2ascii(buf)); ++ if (options->petsciiraw == PA_PETSCII) { ++ cbm_petscii2ascii(buf); ++ } ++ printf("%s\n", buf); + } + else + { +@@ -1135,7 +1139,7 @@ + } + else + { +- printf("%s", cbm_petscii2ascii(buf)); ++ printf("%s\n", cbm_petscii2ascii(buf)); + } + cbm_close(fd, command.device, 0); + } +@@ -1147,7 +1151,7 @@ + + static void show_monkey(unsigned int c) + { +- // const static char monkey[]={"¸,ø¤*º°´`°º*¤ø,¸"}; // for fast moves ++ // const static char monkey[]={"¸,ø¤*º°´`°º*¤ø,¸"}; // for fast moves + // const static char monkey[]={"\\|/-"}; // from cbmcopy + // const static char monkey[]={"-\\|/"}; // from libtrans (reversed) + // const static char monkey[]={"\\-/|"}; // from cbmcopy (reversed) +@@ -1206,15 +1210,29 @@ + } + #endif // #ifdef DBG_TEST_UPDOWN + ++static int ++do_download_callback( ++ void * Context, ++ uint16_t MemoryAddress, ++ uint16_t MemoryAddressEnd, ++ uint16_t Count, ++ uint8_t Percent ++ ) ++{ ++ int start_address = *((int *) Context); ++ show_monkey((MemoryAddress - start_address) >> 8); ++ return 0; ++} ++ + /* + * read device memory, dump to stdout or a file + */ + static int do_download(CBM_FILE fd, OPTIONS * const options) + { + unsigned char unit; +- unsigned short c; + int addr, count, rv = 0; +- char *tail, buf[256]; ++ char *tail; ++ uint8_t *buf = NULL; + FILE *f; + + char *tmpstring; +@@ -1260,40 +1278,38 @@ + return 1; + + +- // download in chunks of sizeof(buf) (currently: 256) bytes +- while(count > 0) +- { +- show_monkey(count / sizeof(buf)); +- +- c = (count > sizeof(buf)) ? sizeof(buf) : count; +- +- if (c + (addr & 0xFF) > 0x100) { +- c = 0x100 - (addr & 0xFF); +- } ++ do { ++ int read; + +- if(c != cbm_download(fd, unit, addr, buf, c)) ++ if ((buf = malloc(count)) == 0) + { ++ rv = 1; ++ fprintf(stderr, "Could not allocate memory for transfer!\n"); ++ break; ++ } ++ read = cbm_dos_memory_read(fd, buf, count, unit, addr, count, do_download_callback, &addr); ++ if (read != 0) { + rv = 1; + fprintf(stderr, "A transfer error occurred!\n"); + break; + } + +- // If the user wants to convert them from PETSCII, do this +- // (I find it hard to believe someone would want to do this, +- // but who knows?) ++ /* If the user wants to convert them from PETSCII, do this ++ * (I find it hard to believe someone would want to do this, ++ * but who knows?) ++ */ + + if (options->petsciiraw == PA_PETSCII) + { + int i; +- for (i = 0; i < c; i++) ++ for (i = 0; i < count; i++) + buf[i] = cbm_petscii2ascii_c(buf[i]); + } + +- fwrite(buf, 1, c, f); ++ fwrite(buf, 1, count, f); ++ } while (0); + +- addr += c; +- count -= c; +- } ++ free(buf); + + fclose(f); + return rv; +@@ -1939,6 +1955,9 @@ + " and 'command'\n" + " -r, --raw: Do not convert data between CBM and PC format.\n" + " Default with 'open' and 'command'.\n" ++ " -1, --dos1: Use DOS1 compatibility mode\n" ++ " -R, --retry: Allow retries in case of errors on memory transfers. The optional\n" ++ " argument specifies the number of retries. Default is 5.\n" + " -- Delimiter between action_opt and action_args; if any of the\n" + " arguments in action_args starts with a '-', make sure to set\n" + " the '--' so the argument is not treated as an option,\n" +@@ -2015,7 +2034,7 @@ + int option_index; + int option; + +- static const char short_options[] = "+fhVpr@:"; ++ static const char short_options[] = "+fhVpr1@:R::"; + static struct option long_options[] = + { + { "adapter" , required_argument, NULL, '@' }, +@@ -2024,6 +2043,8 @@ + { "version" , no_argument, NULL, 'V' }, + { "petscii" , no_argument, NULL, 'p' }, + { "raw" , no_argument, NULL, 'r' }, ++ { "dos1" , no_argument, NULL, '1' }, ++ { "retry" , optional_argument, NULL, 'R' }, + { NULL , no_argument, NULL, 0 } + }; + +@@ -2090,6 +2111,37 @@ + case 'r': + options->error |= set_option_petsciiraw(&options->petsciiraw, PA_RAW, 0); + break; ++ ++ case '1': ++ cbm_dos_set_dos1_compatibility(1); ++ break; ++ ++ case 'R': ++ { ++ unsigned int retries = 5; ++ ++ if (optarg) { ++ char * tail = NULL; ++ long value; ++ ++ value = strtol(optarg, &tail, 0); ++ if (*tail == 0) { ++ if (value < 0) { ++ fprintf(stderr, "Retries '%s' must be non-negative for --retry/-R\n", optarg); ++ } ++ else { ++ retries = value; ++ } ++ } ++ else { ++ fprintf(stderr, "Option '%s' is not a value for --retries/-R\n", optarg); ++ } ++ } ++ ++ cbm_dos_memory_read_set_max_retries(retries); ++ cbm_dos_memory_write_set_max_retries(retries); ++ } ++ break; + }; + } + +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/cbmctrl/pport.c OpenCBM-master/opencbm/cbmctrl/pport.c +--- OpenCBM-0_4_99_104/opencbm/cbmctrl/pport.c 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/cbmctrl/pport.c 2026-03-26 21:53:53.000000000 +0100 +@@ -123,7 +123,7 @@ + /* + * Give the drive time to be able to execute this command + */ +- arch_usleep(5000); ++ arch_sleep_ms(5); + + /* + * Read back the value. Hopefully, it is exactly what we just have written. +@@ -152,7 +152,7 @@ + /* + * Give the drive time to be able to execute this command + */ +- arch_usleep(5000); ++ arch_sleep_ms(5); + + /* + * Read back the value. Hopefully, it is exactly what we just have written. +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/cbmrpm41/cbmrpm41.c OpenCBM-master/opencbm/cbmrpm41/cbmrpm41.c +--- OpenCBM-0_4_99_104/opencbm/cbmrpm41/cbmrpm41.c 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/cbmrpm41/cbmrpm41.c 2026-03-26 21:53:53.000000000 +0100 +@@ -111,11 +111,11 @@ + + DEBUG_PRINTDEBUGCOUNTERS(); + +- arch_sleep(1); ++ arch_sleep_s(1); + cbm_reset(fd_cbm_local); + + #if 0 // reset automatically restores the VIA shift register +- arch_usleep(100000); ++ arch_sleep_ms(100); + fprintf(stderr, "Emergency resetting VIA2 shift register to default.\n"); + cbm_exec_command(fd, drive, CmdBuffer, sizeof(CmdBuffer)); + #endif +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/d82copy/main.c OpenCBM-master/opencbm/d82copy/main.c +--- OpenCBM-0_4_99_104/opencbm/d82copy/main.c 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/d82copy/main.c 2026-03-26 21:53:53.000000000 +0100 +@@ -30,10 +30,50 @@ + static CBM_FILE fd_cbm; + + +-static int is_cbm(char *name) ++static int cbm_address_extract_drive_and_medium(char * arg, unsigned char * unit) + { +- return((strcmp(name, "8" ) == 0) || (strcmp(name, "9" ) == 0) || +- (strcmp(name, "10") == 0) || (strcmp(name, "11") == 0) ); ++ char * endptr = NULL; ++ long drive; ++ int medium; ++ ++ errno = 0; ++ drive = strtol(arg, &endptr, 10); ++ ++ if (errno || drive < 0 || drive > 15) { ++ // not a CBM drive address ++ return 0; ++ } ++ ++ // assume medium default of 0: this is the old behaviour ++ medium = 0; ++ ++ if (*endptr == ':') { ++ ++endptr; ++ // there seems to be a medium, process that ++ switch (*endptr) { ++ case '0': ++ medium = 0; ++ ++endptr; ++ break; ++ ++ case '1': ++ medium = 1; ++ ++endptr; ++ break; ++ ++ default: ++ return 0; ++ } ++ } ++ ++ if (*endptr) { ++ // there is still something following, this is not a valid CBM address ++ return 0; ++ } ++ ++ *unit = (drive & 0x7F) | (medium ? 0x80 : 0); ++ ++ return 1; + } + + +@@ -208,12 +248,15 @@ + char *tm = NULL; + char *src_arg; + char *dst_arg; ++ + char *adapter = NULL; + + int option; + int rv = 1; + int l; + ++ unsigned char src_unit; ++ unsigned char dst_unit; + int src_is_cbm; + int dst_is_cbm; + +@@ -358,8 +401,8 @@ + src_arg = argv[optind]; + dst_arg = argv[optind+1]; + +- src_is_cbm = is_cbm(src_arg); +- dst_is_cbm = is_cbm(dst_arg); ++ src_is_cbm = cbm_address_extract_drive_and_medium(src_arg, &src_unit); ++ dst_is_cbm = cbm_address_extract_drive_and_medium(dst_arg, &dst_unit); + + if(src_is_cbm == dst_is_cbm) + { +@@ -376,7 +419,7 @@ + settings->transfer_mode = + d82copy_check_auto_transfer_mode(fd_cbm, + settings->transfer_mode, +- atoi(src_is_cbm ? src_arg : dst_arg)); ++ src_is_cbm ? src_unit : dst_unit); + + my_message_cb(3, "decided to use transfer mode %d", settings->transfer_mode ); + +@@ -384,12 +427,12 @@ + + if(src_is_cbm) + { +- rv = d82copy_read_image(fd_cbm, settings, atoi(src_arg), dst_arg, ++ rv = d82copy_read_image(fd_cbm, settings, src_unit, dst_arg, + my_message_cb, my_status_cb); + } + else + { +- rv = d82copy_write_image(fd_cbm, settings, src_arg, atoi(dst_arg), ++ rv = d82copy_write_image(fd_cbm, settings, src_arg, dst_unit, + my_message_cb, my_status_cb); + } + +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/dirs OpenCBM-master/opencbm/dirs +--- OpenCBM-0_4_99_104/opencbm/dirs 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/dirs 2026-03-26 21:53:53.000000000 +0100 +@@ -11,6 +11,7 @@ + d82copy \ + libimgcopy \ + imgcopy \ ++ fdx000copy \ + cbmctrl \ + install \ + lib \ +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/docs/opencbm.sgml OpenCBM-master/opencbm/docs/opencbm.sgml +--- OpenCBM-0_4_99_104/opencbm/docs/opencbm.sgml 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/docs/opencbm.sgml 2026-03-26 21:53:53.000000000 +0100 +@@ -1135,7 +1135,7 @@ + Using direct port access (with -DDIRECT_PORT_ACCESS): + + +-The port/IRQ might occupied by another driver (e.g. parport.o) ++The port/IRQ might be occupied by another driver (e.g. parport.o) + Enter cat /proc/interrupts and cat /proc/ioports to find + out. + +diff '--color=auto' -uNr OpenCBM-0_4_99_104/opencbm/Doxyfile OpenCBM-master/opencbm/Doxyfile +--- OpenCBM-0_4_99_104/opencbm/Doxyfile 2022-01-22 23:01:25.000000000 +0100 ++++ OpenCBM-master/opencbm/Doxyfile 2026-03-26 21:53:53.000000000 +0100 +@@ -1,427 +1,900 @@ +-# Doxyfile 1.3.9.1 ++# Doxyfile 1.9.4 + + # This file describes the settings to be used by the documentation system +-# doxygen (www.doxygen.org) for a project ++# doxygen (www.doxygen.org) for a project. + # +-# All text after a hash (#) is considered a comment and will be ignored ++# All text after a double hash (##) is considered a comment and is placed in ++# front of the TAG it is preceding. ++# ++# All text after a single hash (#) is considered a comment and will be ignored. + # The format is: +-# TAG = value [value, ...] +-# For lists items can also be appended using: +-# TAG += value [value, ...] +-# Values that contain spaces should be placed between quotes (" ") ++# TAG = value [value, ...] ++# For lists, items can also be appended using: ++# TAG += value [value, ...] ++# Values that contain spaces should be placed between quotes (\" \"). ++# ++# Note: ++# ++# Use doxygen to compare the used configuration file with the template ++# configuration file: ++# doxygen -x [configFile] ++# Use doxygen to compare the used configuration file with the template ++# configuration file without replacing the environment variables: ++# doxygen -x_noenv [configFile] + + #--------------------------------------------------------------------------- + # Project related configuration options + #--------------------------------------------------------------------------- + +-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +-# by quotes) that should identify the project. ++# This tag specifies the encoding used for all characters in the configuration ++# file that follow. The default is UTF-8 which is also the encoding used for all ++# text before the first occurrence of this tag. Doxygen uses libiconv (or the ++# iconv built into libc) for the transcoding. See ++# https://www.gnu.org/software/libiconv/ for the list of possible encodings. ++# The default value is: UTF-8. ++ ++DOXYFILE_ENCODING = UTF-8 ++ ++# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by ++# double-quotes, unless you are using Doxywizard) that should identify the ++# project for which the documentation is generated. This name is used in the ++# title of most generated pages and in a few other places. ++# The default value is: My Project. + + PROJECT_NAME = OpenCBM + +-# The PROJECT_NUMBER tag can be used to enter a project or revision number. +-# This could be handy for archiving the generated documentation or +-# if some version control system is used. +- +-PROJECT_NUMBER = +- +-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +-# base path where the generated documentation will be put. +-# If a relative path is entered, it will be relative to the location +-# where doxygen was started. If left blank the current directory will be used. ++# The PROJECT_NUMBER tag can be used to enter a project or revision number. This ++# could be handy for archiving the generated documentation or if some version ++# control system is used. ++ ++PROJECT_NUMBER = ++ ++# Using the PROJECT_BRIEF tag one can provide an optional one line description ++# for a project that appears at the top of each page and should give viewer a ++# quick idea about the purpose of the project. Keep the description short. ++ ++PROJECT_BRIEF = ++ ++# With the PROJECT_LOGO tag one can specify a logo or an icon that is included ++# in the documentation. The maximum height of the logo should not exceed 55 ++# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy ++# the logo to the output directory. ++ ++PROJECT_LOGO = ++ ++# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path ++# into which the generated documentation will be written. If a relative path is ++# entered, it will be relative to the location where doxygen was started. If ++# left blank the current directory will be used. + + OUTPUT_DIRECTORY = .doxygen/ + +-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +-# 4096 sub-directories (in 2 levels) under the output directory of each output +-# format and will distribute the generated files over these directories. +-# Enabling this option can be useful when feeding doxygen a huge amount of source +-# files, where putting all generated files in the same directory would otherwise +-# cause performance problems for the file system. ++# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 ++# sub-directories (in 2 levels) under the output directory of each output format ++# and will distribute the generated files over these directories. Enabling this ++# option can be useful when feeding doxygen a huge amount of source files, where ++# putting all generated files in the same directory would otherwise causes ++# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to ++# control the number of sub-directories. ++# The default value is: NO. + + CREATE_SUBDIRS = NO + +-# The OUTPUT_LANGUAGE tag is used to specify the language in which all +-# documentation generated by doxygen is written. Doxygen will use this +-# information to generate all constant output in the proper language. +-# The default language is English, other supported languages are: +-# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +-# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +-# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +-# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +-# Swedish, and Ukrainian. ++# Controls the number of sub-directories that will be created when ++# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every ++# level increment doubles the number of directories, resulting in 4096 ++# directories at level 8 which is the default and also the maximum value. The ++# sub-directories are organized in 2 levels, the first level always has a fixed ++# numer of 16 directories. ++# Minimum value: 0, maximum value: 8, default value: 8. ++# This tag requires that the tag CREATE_SUBDIRS is set to YES. ++ ++CREATE_SUBDIRS_LEVEL = 8 ++ ++# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII ++# characters to appear in the names of generated files. If set to NO, non-ASCII ++# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode ++# U+3044. ++# The default value is: NO. ++ ++ALLOW_UNICODE_NAMES = NO ++ ++# The OUTPUT_LANGUAGE tag is used to specify the language in which all ++# documentation generated by doxygen is written. Doxygen will use this ++# information to generate all constant output in the proper language. ++# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, ++# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English ++# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, ++# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with ++# English messages), Korean, Korean-en (Korean with English messages), Latvian, ++# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, ++# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, ++# Swedish, Turkish, Ukrainian and Vietnamese. ++# The default value is: English. + + OUTPUT_LANGUAGE = English + +-# This tag can be used to specify the encoding used in the generated output. +-# The encoding is not always determined by the language that is chosen, +-# but also whether or not the output is meant for Windows or non-Windows users. +-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +-# forces the Windows encoding (this is the default for the Windows binary), +-# whereas setting the tag to NO uses a Unix-style encoding (the default for +-# all platforms other than Windows). +- +-USE_WINDOWS_ENCODING = NO +- +-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +-# include brief member descriptions after the members that are listed in +-# the file and class documentation (similar to JavaDoc). +-# Set to NO to disable this. ++# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member ++# descriptions after the members that are listed in the file and class ++# documentation (similar to Javadoc). Set to NO to disable this. ++# The default value is: YES. + + BRIEF_MEMBER_DESC = YES + +-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +-# the brief description of a member or function before the detailed description. +-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the ++# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief ++# description of a member or function before the detailed description ++# ++# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the + # brief descriptions will be completely suppressed. ++# The default value is: YES. + + REPEAT_BRIEF = YES + +-# This tag implements a quasi-intelligent brief description abbreviator +-# that is used to form the text in various listings. Each string +-# in this list, if found as the leading text of the brief description, will be +-# stripped from the text and the result after processing the whole list, is used +-# as the annotated text. Otherwise, the brief description is used as-is. If left +-# blank, the following values are used ("$name" is automatically replaced with the +-# name of the entity): "The $name class" "The $name widget" "The $name file" +-# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" ++# This tag implements a quasi-intelligent brief description abbreviator that is ++# used to form the text in various listings. Each string in this list, if found ++# as the leading text of the brief description, will be stripped from the text ++# and the result, after processing the whole list, is used as the annotated ++# text. Otherwise, the brief description is used as-is. If left blank, the ++# following values are used ($name is automatically replaced with the name of ++# the entity):The $name class, The $name widget, The $name file, is, provides, ++# specifies, contains, represents, a, an and the. + +-ABBREVIATE_BRIEF = ++ABBREVIATE_BRIEF = + +-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +-# Doxygen will generate a detailed section even if there is only a brief ++# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then ++# doxygen will generate a detailed section even if there is only a brief + # description. ++# The default value is: NO. + + ALWAYS_DETAILED_SEC = NO + +-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +-# members of a class in the documentation of that class as if those members were +-# ordinary class members. Constructors, destructors and assignment operators of +-# the base classes will not be shown. ++# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all ++# inherited members of a class in the documentation of that class as if those ++# members were ordinary class members. Constructors, destructors and assignment ++# operators of the base classes will not be shown. ++# The default value is: NO. + + INLINE_INHERITED_MEMB = NO + +-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +-# path before files name in the file list and in the header files. If set +-# to NO the shortest path that makes the file name unique will be used. ++# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path ++# before files name in the file list and in the header files. If set to NO the ++# shortest path that makes the file name unique will be used ++# The default value is: YES. + + FULL_PATH_NAMES = NO + +-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +-# can be used to strip a user-defined part of the path. Stripping is +-# only done if one of the specified strings matches the left-hand part of +-# the path. The tag can be used to show relative paths in the file list. +-# If left blank the directory from which doxygen is run is used as the +-# path to strip. +- +-STRIP_FROM_PATH = +- +-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +-# the path mentioned in the documentation of a class, which tells +-# the reader which header file to include in order to use a class. +-# If left blank only the name of the header file containing the class +-# definition is used. Otherwise one should specify the include paths that +-# are normally passed to the compiler using the -I flag. +- +-STRIP_FROM_INC_PATH = +- +-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +-# (but less readable) file names. This can be useful is your file systems +-# doesn't support long names like on DOS, Mac, or CD-ROM. ++# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. ++# Stripping is only done if one of the specified strings matches the left-hand ++# part of the path. The tag can be used to show relative paths in the file list. ++# If left blank the directory from which doxygen is run is used as the path to ++# strip. ++# ++# Note that you can specify absolute paths here, but also relative paths, which ++# will be relative from the directory where doxygen is started. ++# This tag requires that the tag FULL_PATH_NAMES is set to YES. ++ ++STRIP_FROM_PATH = ++ ++# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the ++# path mentioned in the documentation of a class, which tells the reader which ++# header file to include in order to use a class. If left blank only the name of ++# the header file containing the class definition is used. Otherwise one should ++# specify the list of include paths that are normally passed to the compiler ++# using the -I flag. ++ ++STRIP_FROM_INC_PATH = ++ ++# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but ++# less readable) file names. This can be useful is your file systems doesn't ++# support long names like on DOS, Mac, or CD-ROM. ++# The default value is: NO. + + SHORT_NAMES = NO + +-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +-# will interpret the first line (until the first dot) of a JavaDoc-style +-# comment as the brief description. If set to NO, the JavaDoc +-# comments will behave just like the Qt-style comments (thus requiring an +-# explicit @brief command for a brief description. ++# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the ++# first line (until the first dot) of a Javadoc-style comment as the brief ++# description. If set to NO, the Javadoc-style will behave just like regular Qt- ++# style comments (thus requiring an explicit @brief command for a brief ++# description.) ++# The default value is: NO. + + JAVADOC_AUTOBRIEF = NO + +-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +-# treat a multi-line C++ special comment block (i.e. a block of //! or /// +-# comments) as a brief description. This used to be the default behaviour. +-# The new default is to treat a multi-line C++ comment block as a detailed +-# description. Set this tag to YES if you prefer the old behaviour instead. ++# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line ++# such as ++# /*************** ++# as being the beginning of a Javadoc-style comment "banner". If set to NO, the ++# Javadoc-style will behave just like regular comments and it will not be ++# interpreted by doxygen. ++# The default value is: NO. ++ ++JAVADOC_BANNER = NO ++ ++# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first ++# line (until the first dot) of a Qt-style comment as the brief description. If ++# set to NO, the Qt-style will behave just like regular Qt-style comments (thus ++# requiring an explicit \brief command for a brief description.) ++# The default value is: NO. ++ ++QT_AUTOBRIEF = NO ++ ++# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a ++# multi-line C++ special comment block (i.e. a block of //! or /// comments) as ++# a brief description. This used to be the default behavior. The new default is ++# to treat a multi-line C++ comment block as a detailed description. Set this ++# tag to YES if you prefer the old behavior instead. ++# ++# Note that setting this tag to YES also means that rational rose comments are ++# not recognized any more. ++# The default value is: NO. + + MULTILINE_CPP_IS_BRIEF = NO + +-# If the DETAILS_AT_TOP tag is set to YES then Doxygen +-# will output the detailed description near the top, like JavaDoc. +-# If set to NO, the detailed description appears after the member +-# documentation. +- +-DETAILS_AT_TOP = NO +- +-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +-# member inherits the documentation from any documented member that it +-# re-implements. ++# By default Python docstrings are displayed as preformatted text and doxygen's ++# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the ++# doxygen's special commands can be used and the contents of the docstring ++# documentation blocks is shown as doxygen documentation. ++# The default value is: YES. ++ ++PYTHON_DOCSTRING = YES ++ ++# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the ++# documentation from any documented member that it re-implements. ++# The default value is: YES. + + INHERIT_DOCS = YES + +-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +-# tag is set to YES, then doxygen will reuse the documentation of the first +-# member in the group (if any) for the other members of the group. By default +-# all members of a group must be documented explicitly. +- +-DISTRIBUTE_GROUP_DOC = NO +- +-# The TAB_SIZE tag can be used to set the number of spaces in a tab. +-# Doxygen uses this value to replace tabs by spaces in code fragments. ++# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new ++# page for each member. If set to NO, the documentation of a member will be part ++# of the file/class/namespace that contains it. ++# The default value is: NO. ++ ++SEPARATE_MEMBER_PAGES = NO ++ ++# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen ++# uses this value to replace tabs by spaces in code fragments. ++# Minimum value: 1, maximum value: 16, default value: 4. + + TAB_SIZE = 8 + +-# This tag can be used to specify a number of aliases that acts +-# as commands in the documentation. An alias has the form "name=value". +-# For example adding "sideeffect=\par Side Effects:\n" will allow you to +-# put the command \sideeffect (or @sideeffect) in the documentation, which +-# will result in a user-defined paragraph with heading "Side Effects:". +-# You can put \n's in the value part of an alias to insert newlines. +- +-ALIASES = +- +-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +-# only. Doxygen will then generate output that is more tailored for C. +-# For instance, some of the names that are used will be different. The list +-# of all members will be omitted, etc. ++# This tag can be used to specify a number of aliases that act as commands in ++# the documentation. An alias has the form: ++# name=value ++# For example adding ++# "sideeffect=@par Side Effects:^^" ++# will allow you to put the command \sideeffect (or @sideeffect) in the ++# documentation, which will result in a user-defined paragraph with heading ++# "Side Effects:". Note that you cannot put \n's in the value part of an alias ++# to insert newlines (in the resulting output). You can put ^^ in the value part ++# of an alias to insert a newline as if a physical newline was in the original ++# file. When you need a literal { or } or , in the value part of an alias you ++# have to escape them by means of a backslash (\), this can lead to conflicts ++# with the commands \{ and \} for these it is advised to use the version @{ and ++# @} or use a double escape (\\{ and \\}) ++ ++ALIASES = ++ ++# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources ++# only. Doxygen will then generate output that is more tailored for C. For ++# instance, some of the names that are used will be different. The list of all ++# members will be omitted, etc. ++# The default value is: NO. + + OPTIMIZE_OUTPUT_FOR_C = YES + +-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +-# only. Doxygen will then generate output that is more tailored for Java. +-# For instance, namespaces will be presented as packages, qualified scopes +-# will look different, etc. ++# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or ++# Python sources only. Doxygen will then generate output that is more tailored ++# for that language. For instance, namespaces will be presented as packages, ++# qualified scopes will look different, etc. ++# The default value is: NO. + + OPTIMIZE_OUTPUT_JAVA = NO + +-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +-# the same type (for instance a group of public functions) to be put as a +-# subgroup of that type (e.g. under the Public Functions section). Set it to +-# NO to prevent subgrouping. Alternatively, this can be done per class using +-# the \nosubgrouping command. ++# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran ++# sources. Doxygen will then generate output that is tailored for Fortran. ++# The default value is: NO. ++ ++OPTIMIZE_FOR_FORTRAN = NO ++ ++# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL ++# sources. Doxygen will then generate output that is tailored for VHDL. ++# The default value is: NO. ++ ++OPTIMIZE_OUTPUT_VHDL = NO ++ ++# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice ++# sources only. Doxygen will then generate output that is more tailored for that ++# language. For instance, namespaces will be presented as modules, types will be ++# separated into more groups, etc. ++# The default value is: NO. ++ ++OPTIMIZE_OUTPUT_SLICE = NO ++ ++# Doxygen selects the parser to use depending on the extension of the files it ++# parses. With this tag you can assign which parser to use for a given ++# extension. Doxygen has a built-in mapping, but you can override or extend it ++# using this tag. The format is ext=language, where ext is a file extension, and ++# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, ++# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, ++# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: ++# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser ++# tries to guess whether the code is fixed or free formatted code, this is the ++# default for Fortran type files). For instance to make doxygen treat .inc files ++# as Fortran files (default is PHP), and .f files as C (default is Fortran), ++# use: inc=Fortran f=C. ++# ++# Note: For files without extension you can use no_extension as a placeholder. ++# ++# Note that for custom extensions you also need to set FILE_PATTERNS otherwise ++# the files are not read by doxygen. When specifying no_extension you should add ++# * to the FILE_PATTERNS. ++# ++# Note see also the list of default file extension mappings. ++ ++EXTENSION_MAPPING = ++ ++# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments ++# according to the Markdown format, which allows for more readable ++# documentation. See https://daringfireball.net/projects/markdown/ for details. ++# The output of markdown processing is further processed by doxygen, so you can ++# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in ++# case of backward compatibilities issues. ++# The default value is: YES. ++ ++MARKDOWN_SUPPORT = YES ++ ++# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up ++# to that level are automatically included in the table of contents, even if ++# they do not have an id attribute. ++# Note: This feature currently applies only to Markdown headings. ++# Minimum value: 0, maximum value: 99, default value: 5. ++# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. ++ ++TOC_INCLUDE_HEADINGS = 5 ++ ++# When enabled doxygen tries to link words that correspond to documented ++# classes, or namespaces to their corresponding documentation. Such a link can ++# be prevented in individual cases by putting a % sign in front of the word or ++# globally by setting AUTOLINK_SUPPORT to NO. ++# The default value is: YES. ++ ++AUTOLINK_SUPPORT = YES ++ ++# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want ++# to include (a tag file for) the STL sources as input, then you should set this ++# tag to YES in order to let doxygen match functions declarations and ++# definitions whose arguments contain STL classes (e.g. func(std::string); ++# versus func(std::string) {}). This also make the inheritance and collaboration ++# diagrams that involve STL classes more complete and accurate. ++# The default value is: NO. ++ ++BUILTIN_STL_SUPPORT = NO ++ ++# If you use Microsoft's C++/CLI language, you should set this option to YES to ++# enable parsing support. ++# The default value is: NO. ++ ++CPP_CLI_SUPPORT = NO ++ ++# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: ++# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen ++# will parse them like normal C++ but will assume all classes use public instead ++# of private inheritance when no explicit protection keyword is present. ++# The default value is: NO. ++ ++SIP_SUPPORT = NO ++ ++# For Microsoft's IDL there are propget and propput attributes to indicate ++# getter and setter methods for a property. Setting this option to YES will make ++# doxygen to replace the get and set methods by a property in the documentation. ++# This will only work if the methods are indeed getting or setting a simple ++# type. If this is not the case, or you want to show the methods anyway, you ++# should set this option to NO. ++# The default value is: YES. ++ ++IDL_PROPERTY_SUPPORT = YES ++ ++# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC ++# tag is set to YES then doxygen will reuse the documentation of the first ++# member in the group (if any) for the other members of the group. By default ++# all members of a group must be documented explicitly. ++# The default value is: NO. ++ ++DISTRIBUTE_GROUP_DOC = NO ++ ++# If one adds a struct or class to a group and this option is enabled, then also ++# any nested class or struct is added to the same group. By default this option ++# is disabled and one has to add nested compounds explicitly via \ingroup. ++# The default value is: NO. ++ ++GROUP_NESTED_COMPOUNDS = NO ++ ++# Set the SUBGROUPING tag to YES to allow class member groups of the same type ++# (for instance a group of public functions) to be put as a subgroup of that ++# type (e.g. under the Public Functions section). Set it to NO to prevent ++# subgrouping. Alternatively, this can be done per class using the ++# \nosubgrouping command. ++# The default value is: YES. + + SUBGROUPING = YES + ++# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions ++# are shown inside the group in which they are included (e.g. using \ingroup) ++# instead of on a separate page (for HTML and Man pages) or section (for LaTeX ++# and RTF). ++# ++# Note that this feature does not work in combination with ++# SEPARATE_MEMBER_PAGES. ++# The default value is: NO. ++ ++INLINE_GROUPED_CLASSES = NO ++ ++# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions ++# with only public data fields or simple typedef fields will be shown inline in ++# the documentation of the scope in which they are defined (i.e. file, ++# namespace, or group documentation), provided this scope is documented. If set ++# to NO, structs, classes, and unions are shown on a separate page (for HTML and ++# Man pages) or section (for LaTeX and RTF). ++# The default value is: NO. ++ ++INLINE_SIMPLE_STRUCTS = NO ++ ++# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or ++# enum is documented as struct, union, or enum with the name of the typedef. So ++# typedef struct TypeS {} TypeT, will appear in the documentation as a struct ++# with name TypeT. When disabled the typedef will appear as a member of a file, ++# namespace, or class. And the struct will be named TypeS. This can typically be ++# useful for C code in case the coding convention dictates that all compound ++# types are typedef'ed and only the typedef is referenced, never the tag name. ++# The default value is: NO. ++ ++TYPEDEF_HIDES_STRUCT = NO ++ ++# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This ++# cache is used to resolve symbols given their name and scope. Since this can be ++# an expensive process and often the same symbol appears multiple times in the ++# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small ++# doxygen will become slower. If the cache is too large, memory is wasted. The ++# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range ++# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 ++# symbols. At the end of a run doxygen will report the cache usage and suggest ++# the optimal cache size from a speed point of view. ++# Minimum value: 0, maximum value: 9, default value: 0. ++ ++LOOKUP_CACHE_SIZE = 0 ++ ++# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use ++# during processing. When set to 0 doxygen will based this on the number of ++# cores available in the system. You can set it explicitly to a value larger ++# than 0 to get more control over the balance between CPU load and processing ++# speed. At this moment only the input processing can be done using multiple ++# threads. Since this is still an experimental feature the default is set to 1, ++# which effectively disables parallel processing. Please report any issues you ++# encounter. Generating dot graphs in parallel is controlled by the ++# DOT_NUM_THREADS setting. ++# Minimum value: 0, maximum value: 32, default value: 1. ++ ++NUM_PROC_THREADS = 1 ++ + #--------------------------------------------------------------------------- + # Build related configuration options + #--------------------------------------------------------------------------- + +-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +-# documentation are documented, even if no documentation was available. +-# Private class members and static file members will be hidden unless +-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES ++# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in ++# documentation are documented, even if no documentation was available. Private ++# class members and static file members will be hidden unless the ++# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. ++# Note: This will also disable the warnings about undocumented members that are ++# normally produced when WARNINGS is set to YES. ++# The default value is: NO. + + EXTRACT_ALL = NO + +-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +-# will be included in the documentation. ++# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will ++# be included in the documentation. ++# The default value is: NO. + + EXTRACT_PRIVATE = NO + +-# If the EXTRACT_STATIC tag is set to YES all static members of a file +-# will be included in the documentation. ++# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual ++# methods of a class will be included in the documentation. ++# The default value is: NO. ++ ++EXTRACT_PRIV_VIRTUAL = NO ++ ++# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal ++# scope will be included in the documentation. ++# The default value is: NO. + +-EXTRACT_STATIC = NO ++EXTRACT_PACKAGE = NO + +-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +-# defined locally in source files will be included in the documentation. +-# If set to NO only classes defined in header files are included. ++# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be ++# included in the documentation. ++# The default value is: NO. ++ ++EXTRACT_STATIC = YES ++ ++# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined ++# locally in source files will be included in the documentation. If set to NO, ++# only classes defined in header files are included. Does not have any effect ++# for Java sources. ++# The default value is: YES. + + EXTRACT_LOCAL_CLASSES = YES + +-# This flag is only useful for Objective-C code. When set to YES local +-# methods, which are defined in the implementation section but not in +-# the interface are included in the documentation. +-# If set to NO (the default) only methods in the interface are included. ++# This flag is only useful for Objective-C code. If set to YES, local methods, ++# which are defined in the implementation section but not in the interface are ++# included in the documentation. If set to NO, only methods in the interface are ++# included. ++# The default value is: NO. + + EXTRACT_LOCAL_METHODS = NO + +-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +-# undocumented members of documented classes, files or namespaces. +-# If set to NO (the default) these members will be included in the +-# various overviews, but no documentation section is generated. +-# This option has no effect if EXTRACT_ALL is enabled. ++# If this flag is set to YES, the members of anonymous namespaces will be ++# extracted and appear in the documentation as a namespace called ++# 'anonymous_namespace{file}', where file will be replaced with the base name of ++# the file that contains the anonymous namespace. By default anonymous namespace ++# are hidden. ++# The default value is: NO. ++ ++EXTRACT_ANON_NSPACES = NO ++ ++# If this flag is set to YES, the name of an unnamed parameter in a declaration ++# will be determined by the corresponding definition. By default unnamed ++# parameters remain unnamed in the output. ++# The default value is: YES. ++ ++RESOLVE_UNNAMED_PARAMS = YES ++ ++# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all ++# undocumented members inside documented classes or files. If set to NO these ++# members will be included in the various overviews, but no documentation ++# section is generated. This option has no effect if EXTRACT_ALL is enabled. ++# The default value is: NO. + + HIDE_UNDOC_MEMBERS = NO + +-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +-# undocumented classes that are normally visible in the class hierarchy. +-# If set to NO (the default) these classes will be included in the various +-# overviews. This option has no effect if EXTRACT_ALL is enabled. ++# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all ++# undocumented classes that are normally visible in the class hierarchy. If set ++# to NO, these classes will be included in the various overviews. This option ++# has no effect if EXTRACT_ALL is enabled. ++# The default value is: NO. + + HIDE_UNDOC_CLASSES = NO + +-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +-# friend (class|struct|union) declarations. +-# If set to NO (the default) these declarations will be included in the ++# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend ++# declarations. If set to NO, these declarations will be included in the + # documentation. ++# The default value is: NO. + + HIDE_FRIEND_COMPOUNDS = NO + +-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +-# documentation blocks found inside the body of a function. +-# If set to NO (the default) these blocks will be appended to the +-# function's detailed documentation block. ++# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any ++# documentation blocks found inside the body of a function. If set to NO, these ++# blocks will be appended to the function's detailed documentation block. ++# The default value is: NO. + + HIDE_IN_BODY_DOCS = NO + +-# The INTERNAL_DOCS tag determines if documentation +-# that is typed after a \internal command is included. If the tag is set +-# to NO (the default) then the documentation will be excluded. +-# Set it to YES to include the internal documentation. +- +-INTERNAL_DOCS = NO +- +-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +-# file names in lower-case letters. If set to YES upper-case letters are also +-# allowed. This is useful if you have classes or files whose names only differ +-# in case and if your file system supports case sensitive file names. Windows +-# and Mac users are advised to set this option to NO. ++# The INTERNAL_DOCS tag determines if documentation that is typed after a ++# \internal command is included. If the tag is set to NO then the documentation ++# will be excluded. Set it to YES to include the internal documentation. ++# The default value is: NO. ++ ++INTERNAL_DOCS = YES ++ ++# With the correct setting of option CASE_SENSE_NAMES doxygen will better be ++# able to match the capabilities of the underlying filesystem. In case the ++# filesystem is case sensitive (i.e. it supports files in the same directory ++# whose names only differ in casing), the option must be set to YES to properly ++# deal with such files in case they appear in the input. For filesystems that ++# are not case sensitive the option should be set to NO to properly deal with ++# output files written for symbols that only differ in casing, such as for two ++# classes, one named CLASS and the other named Class, and to also support ++# references to files without having to specify the exact matching casing. On ++# Windows (including Cygwin) and MacOS, users should typically set this option ++# to NO, whereas on Linux or other Unix flavors it should typically be set to ++# YES. ++# The default value is: system dependent. + + CASE_SENSE_NAMES = YES + +-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +-# will show members with their full class and namespace scopes in the +-# documentation. If set to YES the scope will be hidden. ++# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with ++# their full class and namespace scopes in the documentation. If set to YES, the ++# scope will be hidden. ++# The default value is: NO. + + HIDE_SCOPE_NAMES = NO + +-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +-# will put a list of the files that are included by a file in the documentation +-# of that file. ++# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will ++# append additional text to a page's title, such as Class Reference. If set to ++# YES the compound reference will be hidden. ++# The default value is: NO. ++ ++HIDE_COMPOUND_REFERENCE= NO ++ ++# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class ++# will show which file needs to be included to use the class. ++# The default value is: YES. ++ ++SHOW_HEADERFILE = YES ++ ++# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of ++# the files that are included by a file in the documentation of that file. ++# The default value is: YES. + + SHOW_INCLUDE_FILES = YES + +-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +-# is inserted in the documentation for inline members. ++# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each ++# grouped member an include statement to the documentation, telling the reader ++# which file to include in order to use the member. ++# The default value is: NO. ++ ++SHOW_GROUPED_MEMB_INC = NO ++ ++# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include ++# files with double quotes in the documentation rather than with sharp brackets. ++# The default value is: NO. ++ ++FORCE_LOCAL_INCLUDES = NO ++ ++# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the ++# documentation for inline members. ++# The default value is: YES. + + INLINE_INFO = YES + +-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +-# will sort the (detailed) documentation of file and class members +-# alphabetically by member name. If set to NO the members will appear in +-# declaration order. ++# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the ++# (detailed) documentation of file and class members alphabetically by member ++# name. If set to NO, the members will appear in declaration order. ++# The default value is: YES. + + SORT_MEMBER_DOCS = YES + +-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +-# brief documentation of file, namespace and class members alphabetically +-# by member name. If set to NO (the default) the members will appear in +-# declaration order. ++# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief ++# descriptions of file, namespace and class members alphabetically by member ++# name. If set to NO, the members will appear in declaration order. Note that ++# this will also influence the order of the classes in the class list. ++# The default value is: NO. + + SORT_BRIEF_DOCS = NO + +-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +-# sorted by fully-qualified names, including namespaces. If set to +-# NO (the default), the class list will be sorted only by class name, +-# not including the namespace part. ++# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the ++# (brief and detailed) documentation of class members so that constructors and ++# destructors are listed first. If set to NO the constructors will appear in the ++# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. ++# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief ++# member documentation. ++# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting ++# detailed member documentation. ++# The default value is: NO. ++ ++SORT_MEMBERS_CTORS_1ST = NO ++ ++# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy ++# of group names into alphabetical order. If set to NO the group names will ++# appear in their defined order. ++# The default value is: NO. ++ ++SORT_GROUP_NAMES = NO ++ ++# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by ++# fully-qualified names, including namespaces. If set to NO, the class list will ++# be sorted only by class name, not including the namespace part. + # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +-# Note: This option applies only to the class list, not to the +-# alphabetical list. ++# Note: This option applies only to the class list, not to the alphabetical ++# list. ++# The default value is: NO. + + SORT_BY_SCOPE_NAME = NO + +-# The GENERATE_TODOLIST tag can be used to enable (YES) or +-# disable (NO) the todo list. This list is created by putting \todo +-# commands in the documentation. ++# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper ++# type resolution of all parameters of a function it will reject a match between ++# the prototype and the implementation of a member function even if there is ++# only one candidate or it is obvious which candidate to choose by doing a ++# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still ++# accept a match between prototype and implementation in such cases. ++# The default value is: NO. ++ ++STRICT_PROTO_MATCHING = NO ++ ++# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo ++# list. This list is created by putting \todo commands in the documentation. ++# The default value is: YES. + + GENERATE_TODOLIST = YES + +-# The GENERATE_TESTLIST tag can be used to enable (YES) or +-# disable (NO) the test list. This list is created by putting \test +-# commands in the documentation. ++# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test ++# list. This list is created by putting \test commands in the documentation. ++# The default value is: YES. + + GENERATE_TESTLIST = YES + +-# The GENERATE_BUGLIST tag can be used to enable (YES) or +-# disable (NO) the bug list. This list is created by putting \bug +-# commands in the documentation. ++# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug ++# list. This list is created by putting \bug commands in the documentation. ++# The default value is: YES. + + GENERATE_BUGLIST = YES + +-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +-# disable (NO) the deprecated list. This list is created by putting +-# \deprecated commands in the documentation. ++# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) ++# the deprecated list. This list is created by putting \deprecated commands in ++# the documentation. ++# The default value is: YES. + + GENERATE_DEPRECATEDLIST= YES + +-# The ENABLED_SECTIONS tag can be used to enable conditional +-# documentation sections, marked by \if sectionname ... \endif. +- +-ENABLED_SECTIONS = +- +-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +-# the initial value of a variable or define consists of for it to appear in +-# the documentation. If the initializer consists of more lines than specified +-# here it will be hidden. Use a value of 0 to hide initializers completely. +-# The appearance of the initializer of individual variables and defines in the +-# documentation can be controlled using \showinitializer or \hideinitializer +-# command in the documentation regardless of this setting. ++# The ENABLED_SECTIONS tag can be used to enable conditional documentation ++# sections, marked by \if ... \endif and \cond ++# ... \endcond blocks. ++ ++ENABLED_SECTIONS = ++ ++# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the ++# initial value of a variable or macro / define can have for it to appear in the ++# documentation. If the initializer consists of more lines than specified here ++# it will be hidden. Use a value of 0 to hide initializers completely. The ++# appearance of the value of individual variables and macros / defines can be ++# controlled using \showinitializer or \hideinitializer command in the ++# documentation regardless of this setting. ++# Minimum value: 0, maximum value: 10000, default value: 30. + + MAX_INITIALIZER_LINES = 30 + +-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +-# at the bottom of the documentation of classes and structs. If set to YES the ++# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at ++# the bottom of the documentation of classes and structs. If set to YES, the + # list will mention the files that were used to generate the documentation. ++# The default value is: YES. + + SHOW_USED_FILES = YES + +-# If the sources in your project are distributed over multiple directories +-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +-# in the documentation. ++# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This ++# will remove the Files entry from the Quick Index and from the Folder Tree View ++# (if specified). ++# The default value is: YES. ++ ++SHOW_FILES = YES ++ ++# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces ++# page. This will remove the Namespaces entry from the Quick Index and from the ++# Folder Tree View (if specified). ++# The default value is: YES. ++ ++SHOW_NAMESPACES = YES ++ ++# The FILE_VERSION_FILTER tag can be used to specify a program or script that ++# doxygen should invoke to get the current version for each file (typically from ++# the version control system). Doxygen will invoke the program by executing (via ++# popen()) the command command input-file, where command is the value of the ++# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided ++# by doxygen. Whatever the program writes to standard output is used as the file ++# version. For an example see the documentation. ++ ++FILE_VERSION_FILTER = ++ ++# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed ++# by doxygen. The layout file controls the global structure of the generated ++# output files in an output format independent way. To create the layout file ++# that represents doxygen's defaults, run doxygen with the -l option. You can ++# optionally specify a file name after the option, if omitted DoxygenLayout.xml ++# will be used as the name of the layout file. See also section "Changing the ++# layout of pages" for information. ++# ++# Note that if you run doxygen from a directory containing a file called ++# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE ++# tag is left empty. ++ ++LAYOUT_FILE = ++ ++# The CITE_BIB_FILES tag can be used to specify one or more bib files containing ++# the reference definitions. This must be a list of .bib files. The .bib ++# extension is automatically appended if omitted. This requires the bibtex tool ++# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. ++# For LaTeX the style of the bibliography can be controlled using ++# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the ++# search path. See also \cite for info how to create references. + +-SHOW_DIRECTORIES = YES ++CITE_BIB_FILES = + + #--------------------------------------------------------------------------- +-# configuration options related to warning and progress messages ++# Configuration options related to warning and progress messages + #--------------------------------------------------------------------------- + +-# The QUIET tag can be used to turn on/off the messages that are generated +-# by doxygen. Possible values are YES and NO. If left blank NO is used. ++# The QUIET tag can be used to turn on/off the messages that are generated to ++# standard output by doxygen. If QUIET is set to YES this implies that the ++# messages are off. ++# The default value is: NO. + + QUIET = NO + +-# The WARNINGS tag can be used to turn on/off the warning messages that are +-# generated by doxygen. Possible values are YES and NO. If left blank +-# NO is used. ++# The WARNINGS tag can be used to turn on/off the warning messages that are ++# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES ++# this implies that the warnings are on. ++# ++# Tip: Turn warnings on while writing the documentation. ++# The default value is: YES. + + WARNINGS = YES + +-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +-# automatically be disabled. ++# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate ++# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag ++# will automatically be disabled. ++# The default value is: YES. + + WARN_IF_UNDOCUMENTED = YES + +-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +-# potential errors in the documentation, such as not documenting some +-# parameters in a documented function, or documenting parameters that +-# don't exist or using markup commands wrongly. ++# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for ++# potential errors in the documentation, such as documenting some parameters in ++# a documented function twice, or documenting parameters that don't exist or ++# using markup commands wrongly. ++# The default value is: YES. + + WARN_IF_DOC_ERROR = YES + +-# The WARN_FORMAT tag determines the format of the warning messages that +-# doxygen can produce. The string should contain the $file, $line, and $text +-# tags, which will be replaced by the file and line number from which the +-# warning originated and the warning text. ++# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete ++# function parameter documentation. If set to NO, doxygen will accept that some ++# parameters have no documentation without warning. ++# The default value is: YES. ++ ++WARN_IF_INCOMPLETE_DOC = YES ++ ++# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that ++# are documented, but have no documentation for their parameters or return ++# value. If set to NO, doxygen will only warn about wrong parameter ++# documentation, but not about the absence of documentation. If EXTRACT_ALL is ++# set to YES then this flag will automatically be disabled. See also ++# WARN_IF_INCOMPLETE_DOC ++# The default value is: NO. ++ ++WARN_NO_PARAMDOC = NO ++ ++# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when ++# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS ++# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but ++# at the end of the doxygen process doxygen will return with a non-zero status. ++# Possible values are: NO, YES and FAIL_ON_WARNINGS. ++# The default value is: NO. ++ ++WARN_AS_ERROR = NO ++ ++# The WARN_FORMAT tag determines the format of the warning messages that doxygen ++# can produce. The string should contain the $file, $line, and $text tags, which ++# will be replaced by the file and line number from which the warning originated ++# and the warning text. Optionally the format may contain $version, which will ++# be replaced by the version of the file (if it could be obtained via ++# FILE_VERSION_FILTER) ++# See also: WARN_LINE_FORMAT ++# The default value is: $file:$line: $text. + + WARN_FORMAT = "$file:$line: $text" + +-# The WARN_LOGFILE tag can be used to specify a file to which warning +-# and error messages should be written. If left blank the output is written +-# to stderr. +- +-WARN_LOGFILE = +- +-#--------------------------------------------------------------------------- +-# configuration options related to the input files +-#--------------------------------------------------------------------------- +- +-# The INPUT tag can be used to specify the files and/or directories that contain +-# documented source files. You may enter file names like "myfile.cpp" or +-# directories like "/usr/src/myproject". Separate the files or directories +-# with spaces. ++# In the $text part of the WARN_FORMAT command it is possible that a reference ++# to a more specific place is given. To make it easier to jump to this place ++# (outside of doxygen) the user can define a custom "cut" / "paste" string. ++# Example: ++# WARN_LINE_FORMAT = "'vi $file +$line'" ++# See also: WARN_FORMAT ++# The default value is: at line $line of file $file. ++ ++WARN_LINE_FORMAT = "at line $line of file $file" ++ ++# The WARN_LOGFILE tag can be used to specify a file to which warning and error ++# messages should be written. If left blank the output is written to standard ++# error (stderr). In case the file specified cannot be opened for writing the ++# warning and error messages are written to standard error. When as file - is ++# specified the warning and error messages are written to standard output ++# (stdout). ++ ++WARN_LOGFILE = ++ ++#--------------------------------------------------------------------------- ++# Configuration options related to the input files ++#--------------------------------------------------------------------------- ++ ++# The INPUT tag is used to specify the files and/or directories that contain ++# documented source files. You may enter file names like myfile.cpp or ++# directories like /usr/src/myproject. Separate the files or directories with ++# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING ++# Note: If this tag is empty the current directory is searched. + + INPUT = cbmctrl/ \ + lib/ \ +@@ -443,739 +916,1783 @@ + libcbmcopy/ \ + libd64copy/ \ + arch/windows/ +- +-# If the value of the INPUT tag contains directories, you can use the +-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +-# and *.h) to filter out the source-files in the directories. If left +-# blank the following patterns are tested: +-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +-# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm +- +-FILE_PATTERNS = *.c* \ +- *.h* +- +-# The RECURSIVE tag can be used to turn specify whether or not subdirectories +-# should be searched for input files as well. Possible values are YES and NO. +-# If left blank NO is used. ++ ++# This tag can be used to specify the character encoding of the source files ++# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses ++# libiconv (or the iconv built into libc) for the transcoding. See the libiconv ++# documentation (see: ++# https://www.gnu.org/software/libiconv/) for the list of possible encodings. ++# The default value is: UTF-8. ++ ++INPUT_ENCODING = UTF-8 ++ ++# If the value of the INPUT tag contains directories, you can use the ++# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and ++# *.h) to filter out the source-files in the directories. ++# ++# Note that for custom extensions or not directly supported extensions you also ++# need to set EXTENSION_MAPPING for the extension otherwise the files are not ++# read by doxygen. ++# ++# Note the list of default checked file patterns might differ from the list of ++# default file extension mappings. ++# ++# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, ++# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, ++# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, ++# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C ++# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, ++# *.vhdl, *.ucf, *.qsf and *.ice. ++ ++FILE_PATTERNS = *.c \ ++ *.h ++ ++# The RECURSIVE tag can be used to specify whether or not subdirectories should ++# be searched for input files as well. ++# The default value is: NO. + + RECURSIVE = YES + +-# The EXCLUDE tag can be used to specify files and/or directories that should +-# excluded from the INPUT source files. This way you can easily exclude a ++# The EXCLUDE tag can be used to specify files and/or directories that should be ++# excluded from the INPUT source files. This way you can easily exclude a + # subdirectory from a directory tree whose root is specified with the INPUT tag. ++# ++# Note that relative paths are relative to the directory from which doxygen is ++# run. + +-EXCLUDE = ++EXCLUDE = + +-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +-# that are symbolic links (a Unix filesystem feature) are excluded from the input. ++# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or ++# directories that are symbolic links (a Unix file system feature) are excluded ++# from the input. ++# The default value is: NO. + + EXCLUDE_SYMLINKS = NO + +-# If the value of the INPUT tag contains directories, you can use the +-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude ++# If the value of the INPUT tag contains directories, you can use the ++# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude + # certain files from those directories. ++# ++# Note that the wildcards are matched against the file with absolute path, so to ++# exclude all test directories for example use the pattern */test/* ++ ++EXCLUDE_PATTERNS = ++ ++# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names ++# (namespaces, classes, functions, etc.) that should be excluded from the ++# output. The symbol name can be a fully qualified name, a word, or if the ++# wildcard * is used, a substring. Examples: ANamespace, AClass, ++# ANamespace::AClass, ANamespace::*Test ++# ++# Note that the wildcards are matched against the file with absolute path, so to ++# exclude all test directories use the pattern */test/* + +-EXCLUDE_PATTERNS = ++EXCLUDE_SYMBOLS = + +-# The EXAMPLE_PATH tag can be used to specify one or more files or +-# directories that contain example code fragments that are included (see +-# the \include command). ++# The EXAMPLE_PATH tag can be used to specify one or more files or directories ++# that contain example code fragments that are included (see the \include ++# command). + +-EXAMPLE_PATH = ++EXAMPLE_PATH = + +-# If the value of the EXAMPLE_PATH tag contains directories, you can use the +-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +-# and *.h) to filter out the source-files in the directories. If left +-# blank all files are included. ++# If the value of the EXAMPLE_PATH tag contains directories, you can use the ++# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and ++# *.h) to filter out the source-files in the directories. If left blank all ++# files are included. + +-EXAMPLE_PATTERNS = ++EXAMPLE_PATTERNS = + +-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +-# searched for input files to be used with the \include or \dontinclude +-# commands irrespective of the value of the RECURSIVE tag. +-# Possible values are YES and NO. If left blank NO is used. ++# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be ++# searched for input files to be used with the \include or \dontinclude commands ++# irrespective of the value of the RECURSIVE tag. ++# The default value is: NO. + + EXAMPLE_RECURSIVE = NO + +-# The IMAGE_PATH tag can be used to specify one or more files or +-# directories that contain image that are included in the documentation (see +-# the \image command). +- +-IMAGE_PATH = +- +-# The INPUT_FILTER tag can be used to specify a program that doxygen should +-# invoke to filter for each input file. Doxygen will invoke the filter program +-# by executing (via popen()) the command , where +-# is the value of the INPUT_FILTER tag, and is the name of an +-# input file. Doxygen will then use the output that the filter program writes +-# to standard output. If FILTER_PATTERNS is specified, this tag will be +-# ignored. +- +-INPUT_FILTER = +- +-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +-# basis. Doxygen will compare the file name with each pattern and apply the +-# filter if there is a match. The filters are a list of the form: +-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +-# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +-# is applied to all files. +- +-FILTER_PATTERNS = +- +-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +-# INPUT_FILTER) will be used to filter the input files when producing source +-# files to browse (i.e. when SOURCE_BROWSER is set to YES). ++# The IMAGE_PATH tag can be used to specify one or more files or directories ++# that contain images that are to be included in the documentation (see the ++# \image command). ++ ++IMAGE_PATH = ++ ++# The INPUT_FILTER tag can be used to specify a program that doxygen should ++# invoke to filter for each input file. Doxygen will invoke the filter program ++# by executing (via popen()) the command: ++# ++# ++# ++# where is the value of the INPUT_FILTER tag, and is the ++# name of an input file. Doxygen will then use the output that the filter ++# program writes to standard output. If FILTER_PATTERNS is specified, this tag ++# will be ignored. ++# ++# Note that the filter must not add or remove lines; it is applied before the ++# code is scanned, but not when the output code is generated. If lines are added ++# or removed, the anchors will not be placed correctly. ++# ++# Note that for custom extensions or not directly supported extensions you also ++# need to set EXTENSION_MAPPING for the extension otherwise the files are not ++# properly processed by doxygen. ++ ++INPUT_FILTER = ++ ++# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern ++# basis. Doxygen will compare the file name with each pattern and apply the ++# filter if there is a match. The filters are a list of the form: pattern=filter ++# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how ++# filters are used. If the FILTER_PATTERNS tag is empty or if none of the ++# patterns match the file name, INPUT_FILTER is applied. ++# ++# Note that for custom extensions or not directly supported extensions you also ++# need to set EXTENSION_MAPPING for the extension otherwise the files are not ++# properly processed by doxygen. ++ ++FILTER_PATTERNS = ++ ++# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using ++# INPUT_FILTER) will also be used to filter the input files that are used for ++# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). ++# The default value is: NO. + + FILTER_SOURCE_FILES = NO + ++# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file ++# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and ++# it is also possible to disable source filtering for a specific pattern using ++# *.ext= (so without naming a filter). ++# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. ++ ++FILTER_SOURCE_PATTERNS = ++ ++# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that ++# is part of the input, its contents will be placed on the main page ++# (index.html). This can be useful if you have a project on for instance GitHub ++# and want to reuse the introduction page also for the doxygen output. ++ ++USE_MDFILE_AS_MAINPAGE = ++ + #--------------------------------------------------------------------------- +-# configuration options related to source browsing ++# Configuration options related to source browsing + #--------------------------------------------------------------------------- + +-# If the SOURCE_BROWSER tag is set to YES then a list of source files will +-# be generated. Documented entities will be cross-referenced with these sources. +-# Note: To get rid of all source code in the generated output, make sure also +-# VERBATIM_HEADERS is set to NO. ++# If the SOURCE_BROWSER tag is set to YES then a list of source files will be ++# generated. Documented entities will be cross-referenced with these sources. ++# ++# Note: To get rid of all source code in the generated output, make sure that ++# also VERBATIM_HEADERS is set to NO. ++# The default value is: NO. + + SOURCE_BROWSER = YES + +-# Setting the INLINE_SOURCES tag to YES will include the body +-# of functions and classes directly in the documentation. ++# Setting the INLINE_SOURCES tag to YES will include the body of functions, ++# classes and enums directly into the documentation. ++# The default value is: NO. + + INLINE_SOURCES = NO + +-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +-# doxygen to hide any special comment blocks from generated source code +-# fragments. Normal C and C++ comments will always remain visible. ++# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any ++# special comment blocks from generated source code fragments. Normal C, C++ and ++# Fortran comments will always remain visible. ++# The default value is: YES. + + STRIP_CODE_COMMENTS = YES + +-# If the REFERENCED_BY_RELATION tag is set to YES (the default) +-# then for each documented function all documented +-# functions referencing it will be listed. ++# If the REFERENCED_BY_RELATION tag is set to YES then for each documented ++# entity all documented functions referencing it will be listed. ++# The default value is: NO. + + REFERENCED_BY_RELATION = YES + +-# If the REFERENCES_RELATION tag is set to YES (the default) +-# then for each documented function all documented entities +-# called/used by that function will be listed. ++# If the REFERENCES_RELATION tag is set to YES then for each documented function ++# all documented entities called/used by that function will be listed. ++# The default value is: NO. + + REFERENCES_RELATION = YES + +-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +-# will generate a verbatim copy of the header file for each class for +-# which an include is specified. Set to NO to disable this. ++# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set ++# to YES then the hyperlinks from functions in REFERENCES_RELATION and ++# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will ++# link to the documentation. ++# The default value is: YES. ++ ++REFERENCES_LINK_SOURCE = YES ++ ++# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the ++# source code will show a tooltip with additional information such as prototype, ++# brief description and links to the definition and documentation. Since this ++# will make the HTML file larger and loading of large files a bit slower, you ++# can opt to disable this feature. ++# The default value is: YES. ++# This tag requires that the tag SOURCE_BROWSER is set to YES. ++ ++SOURCE_TOOLTIPS = YES ++ ++# If the USE_HTAGS tag is set to YES then the references to source code will ++# point to the HTML generated by the htags(1) tool instead of doxygen built-in ++# source browser. The htags tool is part of GNU's global source tagging system ++# (see https://www.gnu.org/software/global/global.html). You will need version ++# 4.8.6 or higher. ++# ++# To use it do the following: ++# - Install the latest version of global ++# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file ++# - Make sure the INPUT points to the root of the source tree ++# - Run doxygen as normal ++# ++# Doxygen will invoke htags (and that will in turn invoke gtags), so these ++# tools must be available from the command line (i.e. in the search path). ++# ++# The result: instead of the source browser generated by doxygen, the links to ++# source code will now point to the output of htags. ++# The default value is: NO. ++# This tag requires that the tag SOURCE_BROWSER is set to YES. ++ ++USE_HTAGS = NO ++ ++# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a ++# verbatim copy of the header file for each class for which an include is ++# specified. Set to NO to disable this. ++# See also: Section \class. ++# The default value is: YES. + + VERBATIM_HEADERS = YES + +-#--------------------------------------------------------------------------- +-# configuration options related to the alphabetical class index +-#--------------------------------------------------------------------------- +- +-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +-# of all compounds will be generated. Enable this if the project +-# contains a lot of classes, structs, unions or interfaces. ++# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the ++# clang parser (see: ++# http://clang.llvm.org/) for more accurate parsing at the cost of reduced ++# performance. This can be particularly helpful with template rich C++ code for ++# which doxygen's built-in parser lacks the necessary type information. ++# Note: The availability of this option depends on whether or not doxygen was ++# generated with the -Duse_libclang=ON option for CMake. ++# The default value is: NO. ++ ++CLANG_ASSISTED_PARSING = NO ++ ++# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS ++# tag is set to YES then doxygen will add the directory of each input to the ++# include path. ++# The default value is: YES. ++# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. ++ ++CLANG_ADD_INC_PATHS = YES ++ ++# If clang assisted parsing is enabled you can provide the compiler with command ++# line options that you would normally use when invoking the compiler. Note that ++# the include paths will already be set by doxygen for the files and directories ++# specified with INPUT and INCLUDE_PATH. ++# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. ++ ++CLANG_OPTIONS = ++ ++# If clang assisted parsing is enabled you can provide the clang parser with the ++# path to the directory containing a file called compile_commands.json. This ++# file is the compilation database (see: ++# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the ++# options used when the source files were built. This is equivalent to ++# specifying the -p option to a clang tool, such as clang-check. These options ++# will then be passed to the parser. Any options specified with CLANG_OPTIONS ++# will be added as well. ++# Note: The availability of this option depends on whether or not doxygen was ++# generated with the -Duse_libclang=ON option for CMake. ++ ++CLANG_DATABASE_PATH = ++ ++#--------------------------------------------------------------------------- ++# Configuration options related to the alphabetical class index ++#--------------------------------------------------------------------------- ++ ++# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all ++# compounds will be generated. Enable this if the project contains a lot of ++# classes, structs, unions or interfaces. ++# The default value is: YES. + + ALPHABETICAL_INDEX = NO + +-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +-# in which this list will be split (can be a number in the range [1..20]) +- +-COLS_IN_ALPHA_INDEX = 5 +- +-# In case all classes in a project start with a common prefix, all +-# classes will be put under the same header in the alphabetical index. +-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +-# should be ignored while generating the index headers. ++# In case all classes in a project start with a common prefix, all classes will ++# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag ++# can be used to specify a prefix (or a list of prefixes) that should be ignored ++# while generating the index headers. ++# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +-IGNORE_PREFIX = ++IGNORE_PREFIX = + + #--------------------------------------------------------------------------- +-# configuration options related to the HTML output ++# Configuration options related to the HTML output + #--------------------------------------------------------------------------- + +-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +-# generate HTML output. ++# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output ++# The default value is: YES. + + GENERATE_HTML = YES + +-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +-# If a relative path is entered the value of OUTPUT_DIRECTORY will be +-# put in front of it. If left blank `html' will be used as the default path. ++# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a ++# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of ++# it. ++# The default directory is: html. ++# This tag requires that the tag GENERATE_HTML is set to YES. + + HTML_OUTPUT = html + +-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +-# doxygen will generate files with .html extension. ++# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each ++# generated HTML page (for example: .htm, .php, .asp). ++# The default value is: .html. ++# This tag requires that the tag GENERATE_HTML is set to YES. + + HTML_FILE_EXTENSION = .html + +-# The HTML_HEADER tag can be used to specify a personal HTML header for +-# each generated HTML page. If it is left blank doxygen will generate a ++# The HTML_HEADER tag can be used to specify a user-defined HTML header file for ++# each generated HTML page. If the tag is left blank doxygen will generate a + # standard header. ++# ++# To get valid HTML the header file that includes any scripts and style sheets ++# that doxygen needs, which is dependent on the configuration options used (e.g. ++# the setting GENERATE_TREEVIEW). It is highly recommended to start with a ++# default header using ++# doxygen -w html new_header.html new_footer.html new_stylesheet.css ++# YourConfigFile ++# and then modify the file new_header.html. See also section "Doxygen usage" ++# for information on how to generate the default header that doxygen normally ++# uses. ++# Note: The header is subject to change so you typically have to regenerate the ++# default header when upgrading to a newer version of doxygen. For a description ++# of the possible markers and block names see the documentation. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_HEADER = ++ ++# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each ++# generated HTML page. If the tag is left blank doxygen will generate a standard ++# footer. See HTML_HEADER for more information on how to generate a default ++# footer and what special commands can be used inside the footer. See also ++# section "Doxygen usage" for information on how to generate the default footer ++# that doxygen normally uses. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_FOOTER = ++ ++# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style ++# sheet that is used by each HTML page. It can be used to fine-tune the look of ++# the HTML output. If left blank doxygen will generate a default style sheet. ++# See also section "Doxygen usage" for information on how to generate the style ++# sheet that doxygen normally uses. ++# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as ++# it is more robust and this tag (HTML_STYLESHEET) will in the future become ++# obsolete. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_STYLESHEET = ++ ++# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined ++# cascading style sheets that are included after the standard style sheets ++# created by doxygen. Using this option one can overrule certain style aspects. ++# This is preferred over using HTML_STYLESHEET since it does not replace the ++# standard style sheet and is therefore more robust against future updates. ++# Doxygen will copy the style sheet files to the output directory. ++# Note: The order of the extra style sheet files is of importance (e.g. the last ++# style sheet in the list overrules the setting of the previous ones in the ++# list). For an example see the documentation. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_EXTRA_STYLESHEET = ++ ++# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or ++# other source files which should be copied to the HTML output directory. Note ++# that these files will be copied to the base HTML output directory. Use the ++# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these ++# files. In the HTML_STYLESHEET file, use the file name only. Also note that the ++# files will be copied as-is; there are no commands or markers available. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_EXTRA_FILES = ++ ++# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen ++# will adjust the colors in the style sheet and background images according to ++# this color. Hue is specified as an angle on a color-wheel, see ++# https://en.wikipedia.org/wiki/Hue for more information. For instance the value ++# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 ++# purple, and 360 is red again. ++# Minimum value: 0, maximum value: 359, default value: 220. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_COLORSTYLE_HUE = 220 ++ ++# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors ++# in the HTML output. For a value of 0 the output will use gray-scales only. A ++# value of 255 will produce the most vivid colors. ++# Minimum value: 0, maximum value: 255, default value: 100. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_COLORSTYLE_SAT = 100 ++ ++# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the ++# luminance component of the colors in the HTML output. Values below 100 ++# gradually make the output lighter, whereas values above 100 make the output ++# darker. The value divided by 100 is the actual gamma applied, so 80 represents ++# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not ++# change the gamma. ++# Minimum value: 40, maximum value: 240, default value: 80. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_COLORSTYLE_GAMMA = 80 ++ ++# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML ++# page will contain the date and time when the page was generated. Setting this ++# to YES can help to show when doxygen was last run and thus if the ++# documentation is up to date. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_TIMESTAMP = NO ++ ++# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML ++# documentation will contain a main index with vertical navigation menus that ++# are dynamically created via JavaScript. If disabled, the navigation index will ++# consists of multiple levels of tabs that are statically embedded in every HTML ++# page. Disable this option to support browsers that do not have JavaScript, ++# like the Qt help browser. ++# The default value is: YES. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_DYNAMIC_MENUS = YES ++ ++# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML ++# documentation will contain sections that can be hidden and shown after the ++# page has loaded. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_DYNAMIC_SECTIONS = NO ++ ++# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries ++# shown in the various tree structured indices initially; the user can expand ++# and collapse entries dynamically later on. Doxygen will expand the tree to ++# such a level that at most the specified number of entries are visible (unless ++# a fully collapsed tree already exceeds this amount). So setting the number of ++# entries 1 will produce a full collapsed tree by default. 0 is a special value ++# representing an infinite number of entries and will result in a full expanded ++# tree by default. ++# Minimum value: 0, maximum value: 9999, default value: 100. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_INDEX_NUM_ENTRIES = 100 ++ ++# If the GENERATE_DOCSET tag is set to YES, additional index files will be ++# generated that can be used as input for Apple's Xcode 3 integrated development ++# environment (see: ++# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To ++# create a documentation set, doxygen will generate a Makefile in the HTML ++# output directory. Running make will produce the docset in that directory and ++# running make install will install the docset in ++# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at ++# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy ++# genXcode/_index.html for more information. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++GENERATE_DOCSET = NO ++ ++# This tag determines the name of the docset feed. A documentation feed provides ++# an umbrella under which multiple documentation sets from a single provider ++# (such as a company or product suite) can be grouped. ++# The default value is: Doxygen generated docs. ++# This tag requires that the tag GENERATE_DOCSET is set to YES. ++ ++DOCSET_FEEDNAME = "Doxygen generated docs" ++ ++# This tag determines the URL of the docset feed. A documentation feed provides ++# an umbrella under which multiple documentation sets from a single provider ++# (such as a company or product suite) can be grouped. ++# This tag requires that the tag GENERATE_DOCSET is set to YES. ++ ++DOCSET_FEEDURL = ++ ++# This tag specifies a string that should uniquely identify the documentation ++# set bundle. This should be a reverse domain-name style string, e.g. ++# com.mycompany.MyDocSet. Doxygen will append .docset to the name. ++# The default value is: org.doxygen.Project. ++# This tag requires that the tag GENERATE_DOCSET is set to YES. ++ ++DOCSET_BUNDLE_ID = org.doxygen.Project ++ ++# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify ++# the documentation publisher. This should be a reverse domain-name style ++# string, e.g. com.mycompany.MyDocSet.documentation. ++# The default value is: org.doxygen.Publisher. ++# This tag requires that the tag GENERATE_DOCSET is set to YES. ++ ++DOCSET_PUBLISHER_ID = org.doxygen.Publisher ++ ++# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. ++# The default value is: Publisher. ++# This tag requires that the tag GENERATE_DOCSET is set to YES. ++ ++DOCSET_PUBLISHER_NAME = Publisher ++ ++# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three ++# additional HTML index files: index.hhp, index.hhc, and index.hhk. The ++# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop ++# on Windows. In the beginning of 2021 Microsoft took the original page, with ++# a.o. the download links, offline the HTML help workshop was already many years ++# in maintenance mode). You can download the HTML help workshop from the web ++# archives at Installation executable (see: ++# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo ++# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). ++# ++# The HTML Help Workshop contains a compiler that can convert all HTML output ++# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML ++# files are now used as the Windows 98 help format, and will replace the old ++# Windows help format (.hlp) on all Windows platforms in the future. Compressed ++# HTML files also contain an index, a table of contents, and you can search for ++# words in the documentation. The HTML workshop also contains a viewer for ++# compressed HTML files. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. + +-HTML_HEADER = ++GENERATE_HTMLHELP = NO + +-# The HTML_FOOTER tag can be used to specify a personal HTML footer for +-# each generated HTML page. If it is left blank doxygen will generate a +-# standard footer. ++# The CHM_FILE tag can be used to specify the file name of the resulting .chm ++# file. You can add a path in front of the file if the result should not be ++# written to the html output directory. ++# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +-HTML_FOOTER = ++CHM_FILE = + +-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +-# style sheet that is used by each HTML page. It can be used to +-# fine-tune the look of the HTML output. If the tag is left blank doxygen +-# will generate a default style sheet. Note that doxygen will try to copy +-# the style sheet file to the HTML output directory, so don't put your own +-# stylesheet in the HTML output directory as well, or it will be erased! ++# The HHC_LOCATION tag can be used to specify the location (absolute path ++# including file name) of the HTML help compiler (hhc.exe). If non-empty, ++# doxygen will try to run the HTML help compiler on the generated index.hhp. ++# The file has to be specified with full path. ++# This tag requires that the tag GENERATE_HTMLHELP is set to YES. ++ ++HHC_LOCATION = ++ ++# The GENERATE_CHI flag controls if a separate .chi index file is generated ++# (YES) or that it should be included in the main .chm file (NO). ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +-HTML_STYLESHEET = ++GENERATE_CHI = NO + +-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +-# files or namespaces will be aligned in HTML using tables. If set to +-# NO a bullet list will be used. ++# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) ++# and project file content. ++# This tag requires that the tag GENERATE_HTMLHELP is set to YES. ++ ++CHM_INDEX_ENCODING = ++ ++# The BINARY_TOC flag controls whether a binary table of contents is generated ++# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it ++# enables the Previous and Next buttons. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +-HTML_ALIGN_MEMBERS = YES ++BINARY_TOC = NO + +-# If the GENERATE_HTMLHELP tag is set to YES, additional index files +-# will be generated that can be used as input for tools like the +-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +-# of the generated HTML documentation. ++# The TOC_EXPAND flag can be set to YES to add extra items for group members to ++# the table of contents of the HTML help documentation and to the tree view. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +-GENERATE_HTMLHELP = YES ++TOC_EXPAND = NO + +-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +-# be used to specify the file name of the resulting .chm file. You +-# can add a path in front of the file if the result should not be +-# written to the html output directory. ++# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and ++# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that ++# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help ++# (.qch) of the generated HTML documentation. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++GENERATE_QHP = NO ++ ++# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify ++# the file name of the resulting .qch file. The path specified is relative to ++# the HTML output folder. ++# This tag requires that the tag GENERATE_QHP is set to YES. ++ ++QCH_FILE = ++ ++# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help ++# Project output. For more information please see Qt Help Project / Namespace ++# (see: ++# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). ++# The default value is: org.doxygen.Project. ++# This tag requires that the tag GENERATE_QHP is set to YES. ++ ++QHP_NAMESPACE = org.doxygen.Project ++ ++# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt ++# Help Project output. For more information please see Qt Help Project / Virtual ++# Folders (see: ++# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). ++# The default value is: doc. ++# This tag requires that the tag GENERATE_QHP is set to YES. ++ ++QHP_VIRTUAL_FOLDER = doc ++ ++# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom ++# filter to add. For more information please see Qt Help Project / Custom ++# Filters (see: ++# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). ++# This tag requires that the tag GENERATE_QHP is set to YES. ++ ++QHP_CUST_FILTER_NAME = ++ ++# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the ++# custom filter to add. For more information please see Qt Help Project / Custom ++# Filters (see: ++# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). ++# This tag requires that the tag GENERATE_QHP is set to YES. ++ ++QHP_CUST_FILTER_ATTRS = ++ ++# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this ++# project's filter section matches. Qt Help Project / Filter Attributes (see: ++# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). ++# This tag requires that the tag GENERATE_QHP is set to YES. ++ ++QHP_SECT_FILTER_ATTRS = ++ ++# The QHG_LOCATION tag can be used to specify the location (absolute path ++# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to ++# run qhelpgenerator on the generated .qhp file. ++# This tag requires that the tag GENERATE_QHP is set to YES. ++ ++QHG_LOCATION = ++ ++# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be ++# generated, together with the HTML files, they form an Eclipse help plugin. To ++# install this plugin and make it available under the help contents menu in ++# Eclipse, the contents of the directory containing the HTML and XML files needs ++# to be copied into the plugins directory of eclipse. The name of the directory ++# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. ++# After copying Eclipse needs to be restarted before the help appears. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++GENERATE_ECLIPSEHELP = NO ++ ++# A unique identifier for the Eclipse help plugin. When installing the plugin ++# the directory name containing the HTML and XML files should also have this ++# name. Each documentation set should have its own identifier. ++# The default value is: org.doxygen.Project. ++# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ++ ++ECLIPSE_DOC_ID = org.doxygen.Project ++ ++# If you want full control over the layout of the generated HTML pages it might ++# be necessary to disable the index and replace it with your own. The ++# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top ++# of each HTML page. A value of NO enables the index and the value YES disables ++# it. Since the tabs in the index contain the same information as the navigation ++# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. + +-CHM_FILE = ++DISABLE_INDEX = NO + +-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +-# be used to specify the location (absolute path including file name) of +-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +-# the HTML help compiler on the generated index.hhp. +- +-HHC_LOCATION = +- +-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +-# controls if a separate .chi index file is generated (YES) or that +-# it should be included in the master .chm file (NO). ++# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index ++# structure should be generated to display hierarchical information. If the tag ++# value is set to YES, a side panel will be generated containing a tree-like ++# index structure (just like the one that is generated for HTML Help). For this ++# to work a browser that supports JavaScript, DHTML, CSS and frames is required ++# (i.e. any modern browser). Windows users are probably better off using the ++# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can ++# further fine tune the look of the index (see "Fine-tuning the output"). As an ++# example, the default style sheet generated by doxygen has an example that ++# shows how to put an image at the root of the tree instead of the PROJECT_NAME. ++# Since the tree basically has the same information as the tab index, you could ++# consider setting DISABLE_INDEX to YES when enabling this option. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++GENERATE_TREEVIEW = YES ++ ++# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the ++# FULL_SIDEBAR option determines if the side bar is limited to only the treeview ++# area (value NO) or if it should extend to the full height of the window (value ++# YES). Setting this to YES gives a layout similar to ++# https://docs.readthedocs.io with more room for contents, but less room for the ++# project logo, title, and description. If either GENERATE_TREEVIEW or ++# DISABLE_INDEX is set to NO, this option has no effect. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. + +-GENERATE_CHI = NO ++FULL_SIDEBAR = NO + +-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +-# controls whether a binary table of contents is generated (YES) or a +-# normal table of contents (NO) in the .chm file. ++# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that ++# doxygen will group on one line in the generated HTML documentation. ++# ++# Note that a value of 0 will completely suppress the enum values from appearing ++# in the overview section. ++# Minimum value: 0, maximum value: 20, default value: 4. ++# This tag requires that the tag GENERATE_HTML is set to YES. + +-BINARY_TOC = NO ++ENUM_VALUES_PER_LINE = 4 + +-# The TOC_EXPAND flag can be set to YES to add extra items for group members +-# to the contents of the HTML help documentation and to the tree view. ++# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used ++# to set the initial width (in pixels) of the frame in which the tree is shown. ++# Minimum value: 0, maximum value: 1500, default value: 250. ++# This tag requires that the tag GENERATE_HTML is set to YES. + +-TOC_EXPAND = NO ++TREEVIEW_WIDTH = 250 + +-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +-# top of each HTML page. The value NO (the default) enables the index and +-# the value YES disables it. ++# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to ++# external symbols imported via tag files in a separate window. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++EXT_LINKS_IN_WINDOW = NO ++ ++# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email ++# addresses. ++# The default value is: YES. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++OBFUSCATE_EMAILS = YES ++ ++# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg ++# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see ++# https://inkscape.org) to generate formulas as SVG images instead of PNGs for ++# the HTML output. These images will generally look nicer at scaled resolutions. ++# Possible values are: png (the default) and svg (looks nicer but requires the ++# pdf2svg or inkscape tool). ++# The default value is: png. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++HTML_FORMULA_FORMAT = png ++ ++# Use this tag to change the font size of LaTeX formulas included as images in ++# the HTML documentation. When you change the font size after a successful ++# doxygen run you need to manually remove any form_*.png images from the HTML ++# output directory to force them to be regenerated. ++# Minimum value: 8, maximum value: 50, default value: 10. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++FORMULA_FONTSIZE = 10 ++ ++# Use the FORMULA_TRANSPARENT tag to determine whether or not the images ++# generated for formulas are transparent PNGs. Transparent PNGs are not ++# supported properly for IE 6.0, but are supported on all modern browsers. ++# ++# Note that when changing this option you need to delete any form_*.png files in ++# the HTML output directory before the changes have effect. ++# The default value is: YES. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++FORMULA_TRANSPARENT = YES ++ ++# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands ++# to create new LaTeX commands to be used in formulas as building blocks. See ++# the section "Including formulas" for details. ++ ++FORMULA_MACROFILE = ++ ++# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see ++# https://www.mathjax.org) which uses client side JavaScript for the rendering ++# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX ++# installed or if you want to formulas look prettier in the HTML output. When ++# enabled you may also need to install MathJax separately and configure the path ++# to it using the MATHJAX_RELPATH option. ++# The default value is: NO. ++# This tag requires that the tag GENERATE_HTML is set to YES. ++ ++USE_MATHJAX = NO ++ ++# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. ++# Note that the different versions of MathJax have different requirements with ++# regards to the different settings, so it is possible that also other MathJax ++# settings have to be changed when switching between the different MathJax ++# versions. ++# Possible values are: MathJax_2 and MathJax_3. ++# The default value is: MathJax_2. ++# This tag requires that the tag USE_MATHJAX is set to YES. ++ ++MATHJAX_VERSION = MathJax_2 ++ ++# When MathJax is enabled you can set the default output format to be used for ++# the MathJax output. For more details about the output format see MathJax ++# version 2 (see: ++# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 ++# (see: ++# http://docs.mathjax.org/en/latest/web/components/output.html). ++# Possible values are: HTML-CSS (which is slower, but has the best ++# compatibility. This is the name for Mathjax version 2, for MathJax version 3 ++# this will be translated into chtml), NativeMML (i.e. MathML. Only supported ++# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This ++# is the name for Mathjax version 3, for MathJax version 2 this will be ++# translated into HTML-CSS) and SVG. ++# The default value is: HTML-CSS. ++# This tag requires that the tag USE_MATHJAX is set to YES. ++ ++MATHJAX_FORMAT = HTML-CSS ++ ++# When MathJax is enabled you need to specify the location relative to the HTML ++# output directory using the MATHJAX_RELPATH option. The destination directory ++# should contain the MathJax.js script. For instance, if the mathjax directory ++# is located at the same level as the HTML output directory, then ++# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax ++# Content Delivery Network so you can quickly see the result without installing ++# MathJax. However, it is strongly recommended to install a local copy of ++# MathJax from https://www.mathjax.org before deployment. The default value is: ++# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 ++# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 ++# This tag requires that the tag USE_MATHJAX is set to YES. ++ ++MATHJAX_RELPATH = ++ ++# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax ++# extension names that should be enabled during MathJax rendering. For example ++# for MathJax version 2 (see ++# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): ++# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols ++# For example for MathJax version 3 (see ++# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): ++# MATHJAX_EXTENSIONS = ams ++# This tag requires that the tag USE_MATHJAX is set to YES. ++ ++MATHJAX_EXTENSIONS = ++ ++# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces ++# of code that will be used on startup of the MathJax code. See the MathJax site ++# (see: ++# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an ++# example see the documentation. ++# This tag requires that the tag USE_MATHJAX is set to YES. ++ ++MATHJAX_CODEFILE = ++ ++# When the SEARCHENGINE tag is enabled doxygen will generate a search box for ++# the HTML output. The underlying search engine uses javascript and DHTML and ++# should work on any modern browser. Note that when using HTML help ++# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) ++# there is already a search function so this one should typically be disabled. ++# For large projects the javascript based search engine can be slow, then ++# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to ++# search using the keyboard; to jump to the search box use + S ++# (what the is depends on the OS and browser, but it is typically ++# , /