diff --git a/CMakeLists.txt b/CMakeLists.txt index cc914758..af402a6f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -9,7 +9,13 @@ if (POLICY CMP0167) cmake_policy(SET CMP0167 NEW) endif () -project(musrfit VERSION 1.12.1 LANGUAGES C CXX) +project(musrfit VERSION 1.12.2 LANGUAGES C CXX) + +#--- needed to compile PMacDockIcon.mm (sets the musrview/musrFT/musrt0 Dock icon +#--- via Cocoa, since TGCocoa's X11-style icon/class hints are no-ops on macOS) +if (APPLE) + enable_language(OBJCXX) +endif (APPLE) set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) @@ -30,10 +36,26 @@ if (UNIX AND NOT APPLE) else () set(xdg_datadir_default "/usr/local/share") endif () - set(MUSRFIT_XDG_DATADIR "${xdg_datadir_default}" CACHE PATH + set(MUSRFIT_XDG_DATA_DIR "${xdg_datadir_default}" CACHE PATH "where the .desktop files and icons are installed (must be in the XDG search path)") endif (UNIX AND NOT APPLE) +#--- install rules for the rootcling generated *_rdict.pcm / *.rootmap files -- +#--- root_generate_dictionary() attaches these outputs to two targets (the +#--- 'Dict' target and the library compiling 'Dict.cxx'). Since +#--- cmake 4.5 an install(FILES) of such a non-unique output triggers an author +#--- warning, unless the producing target is named via BUILD_DEPENDS. That +#--- keyword does not exist before cmake 4.5, hence only emit it there. +#--- Usage: musrfit_dict_build_depends( ...) and add ${} +#--- to the install(FILES ...) call. +function(musrfit_dict_build_depends var) + if (CMAKE_VERSION VERSION_GREATER_EQUAL 4.5) + set(${var} BUILD_DEPENDS ${ARGN} PARENT_SCOPE) + else () + set(${var} "" PARENT_SCOPE) + endif () +endfunction() + #--- musrfit specific options ------------------------------------------------- option(dks "build musrfit with DKS (GPU/MIC) support" ON) option(nexus "build optional NeXus support. Needed for ISIS" OFF) @@ -133,6 +155,18 @@ if (NOT COMMAND root_generate_dictionary) include("${ROOT_CMAKE_DIR}/RootMacros.cmake") endif () +#--- Since ROOT 6.40 root_generate_dictionary(... MODULE ...) implicitly adds +#--- 'Core' to the DEPENDS of the rootcling custom command. Within ROOT's own +#--- build that is a target, in an external project it is not (only ROOT::Core +#--- exists), hence make would look for a file 'Core' in the current binary +#--- dir ("No rule to make target 'src/classes/Core'"). Provide the plain name +#--- as an alias of ROOT::Core. An alias of an imported target has to be global +#--- with CMake < 3.18. --------------------------------------------------------- +if (TARGET ROOT::Core AND NOT TARGET Core) + set_target_properties(ROOT::Core PROPERTIES IMPORTED_GLOBAL TRUE) + add_library(Core ALIAS ROOT::Core) +endif () + #--- ROOT headers have to be compiled with at least the C++ standard ROOT was #--- built with, otherwise the ABI does not match. Raise ours if needed, but #--- never silently lower it. -------------------------------------------------- @@ -552,7 +586,6 @@ message(" GSL found in ${GSL_INCLUDE_DIRS}, Version: ${GSL_VERSION}") message(" BOOST found in ${Boost_INCLUDE_DIRS}, Version: ${Boost_VERSION}") message(" LibXML2 found in ${LIBXML2_INCLUDE_DIR}, Version: ${LIBXML2_VERSION_STRING}") message(" ROOT found in ${ROOT_INCLUDE_DIRS}, Version: ${ROOT_VERSION}") - if (OpenMP_FOUND) if (OpenMP_CXX_VERSION) message(" OpenMP found Version: ${OpenMP_CXX_VERSION}") diff --git a/ChangeLog b/ChangeLog index 75ecc34b..75b769e6 100644 --- a/ChangeLog +++ b/ChangeLog @@ -12,10 +12,65 @@ or https://bitbucket.org/muonspin/musrfit +Release of V1.12.2, 2026/11/12 +============================== + +New features / improvements: +musrview, musrFT, musrt0, mupp_plot: show their own window/dock icon instead of +the generic ROOT one (on macOS set via Cocoa). The .desktop files and icons (for +musredit, mupp, musrWiz and musrStep) are now installed to MUSRFIT_XDG_DATA_DIR, +which defaults to the prefix share for /usr and /usr/local, ~/.local/share for +prefixes under $HOME, and /usr/local/share otherwise. +msr2data: the number of threads to be used can be passed on to musrfit from the +command line. musredit uses the 'number of threads' set in its preferences also +for msr2data. +musredit: add the tag to musredit_startup.xml if it is missing +and the preferences are saved. Improve terminating a running fit (qt5/qt6). +Reduce the number of 'NEGATIVE theory' warnings in max. likelihood fits of single +histogram and mu-minus data. +Add the HDF4 library version to the configure output. +musrWiz: add FLAME, VMS and GPD to the PSI instrument definitions (qt5/qt6). +cmake: work around ROOT 6.40 root_generate_dictionary() adding a bare 'Core' +dependency. +musrFT, musrt0, mupp_plot: the window/dock/launcher icons use the blue tile of +the musrview icon, which sets the ROOT canvas based tools apart from the Qt +ones. musrFT and musrt0 additionally install a scalable svg. +musredit, musrWiz, musrStep, mupp: the Linux launcher icons sit on a light tile, +so they are readable on light and dark desktop themes. musredit installs a +scalable svg instead of the 48x48 png. +cmake: silence the cmake >= 4.5 author warnings about installing the dictionary +*_rdict.pcm/*.rootmap files, by naming the producing dictionary targets via +BUILD_DEPENDS (only emitted for cmake >= 4.5). +doc: the Doxygen PROJECT_NUMBER is derived from the version in CMakeLists.txt. + +Bug fixes: +musrt0 -g: handle msr-files with a GLOBAL block. If t0/addt0 is given in the +GLOBAL block, only a warning is issued and the msr-file is left untouched. +musrfit: do not add missing t0/addt0 tags to the msr-file anymore. Only musrt0 +adds them. +musrFT: fix the Fourier canvas on macOS (lost signal/slot connections with +ROOT 6.40 / macOS SDK 26+), and starting musrFT from musredit when started from +the Finder/Dock. musrFT is now run in the directory of the msr-file. +HDF4 4.4.0 changed the Vgetname() prototype. Both the old and the new form are +detected and supported. +Several executables reported the wrong exit status (success on failure or vice +versa). +msr2data: strip the separator when removing the run-number suffix from parameter +names. + +Tests: +Add an LSCO ZF asymmetry example (ROOT-NPP, LEM) to the ctests. +ci: fix the version extraction (grep -oP is unsupported on Alpine/BusyBox). + Release of V1.12.1, 2026/08/25 ============================== Improve the Fourier transform part. This leads to speedups of about a factor of 5. +Allow initial comments in dat-files. + +Bug fixes: +msr2data in global+ mode: fix 'possible msr2data in global+ mode bug' (gitea bug +report #16), and pass the musrfit arguments on (gitea bug report #17). Release of V1.12.0, 2026/07/22 ============================== diff --git a/cmake/FindHDF4.cmake b/cmake/FindHDF4.cmake deleted file mode 100644 index 9026459a..00000000 --- a/cmake/FindHDF4.cmake +++ /dev/null @@ -1,97 +0,0 @@ -## Process this file with cmake -#============================================================================= -# NeXus - Neutron & X-ray Common Data Format -# -# CMakeLists for building the NeXus library and applications. -# -# Copyright (C) 2011 Stephen Rankin -# -# This library is free software; you can redistribute it and/or modify it -# under the terms of the GNU Lesser General Public License as published by the -# Free Software Foundation; either version 2 of the License, or (at your -# option) any later version. -# -# This library is distributed in the hope that it will be useful, but WITHOUT -# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License -# for more details. -# -# You should have received a copy of the GNU Lesser General Public License -# along with this library; if not, write to the Free Software Foundation, -# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -# -# For further information, see -# -# -#============================================================================= - - -#------------------------------------------------------------------------------ -# find the runtime binaries of the HDF4 library -#------------------------------------------------------------------------------ -find_library(HDF4_DF_LIBRARY NAMES df hdf - HINTS ENV HDF4_ROOT - PATH_SUFFIXES hdf) - - -if(HDF4_DF_LIBRARY MATCHES HDF4_DF_LIBRARY-NOTFOUND) - message(FATAL_ERROR "Could not find HDF4 DF library!") -else() - get_filename_component(HDF4_LIBRARY_DIRS ${HDF4_DF_LIBRARY} PATH) - message(STATUS "Found HDF4 DF library: ${HDF4_DF_LIBRARY}") - message(STATUS "HDF4 libary path: ${HDF4_LIBRARY_DIRS}") -endif() - -find_library(HDF4_MFHDF_LIBRARY NAMES mfhdf - HINTS ENV HDF4_ROOT - PATH_SUFFIXES hdf) - -if(HDF4_MFHDF_LIBRARY MATCHES HDF4_MFHDF_LIBRARY-NOTFOUND) - message(FATAL_ERROR "Could not find HDF5 MFHDF library!") -else() - message(STATUS "Found HDF4 MFHDF library: ${HDF4_MFHDF_LIBRARY}") -endif() - - -#------------------------------------------------------------------------------ -# find the HDF4 header file -#------------------------------------------------------------------------------ -find_path(HDF4_INCLUDE_DIRS mfhdf.h - HINTS ENV HDF4_ROOT - PATH_SUFFIXES hdf) - -if(HDF4_INCLUDE_DIRS MATCHES HDF4_INCLUDE_DIRS-NOTFOUND) - message(FATAL_ERROR "Could not find HDF4 header files") -else() - message(STATUS "Found HDF4 header files in: ${HDF4_INCLUDE_DIRS}") -endif() - -#------------------------------------------------------------------------------ -# search for additional packages required to link against HDF4 -#------------------------------------------------------------------------------ -find_package(JPEG REQUIRED) - -#------------------------------------------------------------------------------ -# add libraries to the link list for NAPI -#------------------------------------------------------------------------------ -get_filename_component(LIB_EXT ${HDF4_DF_LIBRARY} EXT) -if(LIB_EXT MATCHES .a) - message(STATUS "HDF4 DF library is static") - list(APPEND NAPI_LINK_LIBS "-Wl,-whole-archive" ${HDF4_DF_LIBRARY} "-Wl,-no-whole-archive") -else() - list(APPEND NAPI_LINK_LIBS ${HDF4_DF_LIBRARY}) -endif() - - -get_filename_component(LIB_EXT ${HDF4_MFHDF_LIBRARY} EXT) -if(LIB_EXT MATCHES .a) - message(STATUS "HDF4 MFHDF library is static") - list(APPEND NAPI_LINK_LIBS "-Wl,-whole-archive" ${HDF4_MFHDF_LIBRARY} "-Wl,-no-whole-archive") -else() - list(APPEND NAPI_LINK_LIBS ${HDF4_MFHDF_LIBRARY}) -endif() - -list(APPEND NAPI_LINK_LIBS jpeg) - -include_directories ( SYSTEM ${HDF4_INCLUDE_DIRS} ) -link_directories(${HDF4_LIBRARY_DIRS}) diff --git a/cmake/FindMXML.cmake b/cmake/FindMXML.cmake deleted file mode 100644 index e11a62fe..00000000 --- a/cmake/FindMXML.cmake +++ /dev/null @@ -1,34 +0,0 @@ -# - find MXML -# find the MXML lib and includes -# This module defines -# LIBMXML_INCLUDE_DIR, where to find mxml.h -# LIBMXML_LIBRARY, library to link against -# LIBMXML_FOUND, if false, do not try to use the MXML lib - -find_path(LIBMXML_INCLUDE_DIR mxml.h - HINT "/usr/include" -) -# find position of mxml.h from the end -string(FIND "${LIBMXML_INCLUDE_DIR}" "/mxml.h" pos REVERSE) -# truncate the string -string(SUBSTRING "${LIBMXML_INCLUDE_DIR}" 0 ${pos} substr) -set(LIBMXML_INCLUDE_DIR ${substr}) -unset(substr) - -find_library(LIBMXML_LIBRARY mxml) - -# get version string -# currently do not know from where to get it automatically - -# handle the QUIETLY and REQUIRED arguments and set LIBMXML_FOUND to TRUE if -# all listed variables are TRUE -include(${CMAKE_ROOT}/Modules/FindPackageHandleStandardArgs.cmake) -FIND_PACKAGE_HANDLE_STANDARD_ARGS(MXML - REQUIRED_VARS LIBMXML_LIBRARY LIBMXML_INCLUDE_DIR) - -if (NOT LIBMXML_FOUND) - unset(LIBMXML_LIBRARY) -endif() - -mark_as_advanced(LIBMXML_INCLUDE_DIR LIBMXML_LIBRARY) - diff --git a/cmake/FindNEXUS.cmake b/cmake/FindNEXUS.cmake deleted file mode 100644 index dca59b4a..00000000 --- a/cmake/FindNEXUS.cmake +++ /dev/null @@ -1,45 +0,0 @@ -# - Find NeXus library -# Find the native NEXUS includes and library -# This module defines -# NEXUS_INCLUDE_DIR, where to find NeXus.h, etc. -# NEXUS_LIBRARY, library to link against to use NEXUS -# NEXUS_FOUND, if false, do not try to use NEXUS. - -find_path(NEXUS_INCLUDE_DIR napi.h - HINTS "/usr/local/include" "/opt/nexus/include" "/usr/local/include/nexus" -) -# find position of napi.h from the end -string(FIND "${NEXUS_INCLUDE_DIR}" "/napi.h" pos REVERSE) -# truncate the string -string(SUBSTRING "${NEXUS_INCLUDE_DIR}" 0 ${pos} substr) -set(NEXUS_INCLUDE_DIR ${substr}) -unset(substr) - -find_library(NEXUS_LIBRARY NeXus - HINTS "/usr/lib" "/usr/lib64" "/usr/local/lib" "/usr/local/lib64" "/opt/nexus/lib") - -# get version string -if (NEXUS_INCLUDE_DIR AND EXISTS ${NEXUS_INCLUDE_DIR}/napi.h) - file(STRINGS "${NEXUS_INCLUDE_DIR}/napi.h" NEXUS_version_str - REGEX "^#define[\t ]+NEXUS_VERSION[\t ].*") - - string(REGEX REPLACE "^#define[\t ]+NEXUS_VERSION[\t ]+\"([^\"]*).*" - "\\1" NEXUS_VERSION_STRING "${NEXUS_version_str}") - unset(NEXUS_version_str) -endif() - -# handle the QUIETLY and REQUIRED arguments and set NEXUS_FOUND to TRUE if -# all listed variables are TRUE -include(${CMAKE_ROOT}/Modules/FindPackageHandleStandardArgs.cmake) -FIND_PACKAGE_HANDLE_STANDARD_ARGS(NEXUS - REQUIRED_VARS NEXUS_LIBRARY NEXUS_INCLUDE_DIR - VERSION_VAR NEXUS_VERSION_STRING) - -if (NOT NEXUS_FOUND) - unset(NEXUS_LIBRARY) -endif() - -mark_as_advanced(NEXUS_INCLUDE_DIR NEXUS_LIBRARY) - - - diff --git a/cmake/mupp.desktop.in b/cmake/mupp.desktop.in new file mode 100644 index 00000000..00981278 --- /dev/null +++ b/cmake/mupp.desktop.in @@ -0,0 +1,11 @@ +[Desktop Entry] +Name=mupp +Comment=muSR parameter plotter +GenericName=musrfit parameter plotter +Exec=@CMAKE_INSTALL_FULL_BINDIR@/mupp +Icon=mupp +Terminal=false +Type=Application +StartupWMClass=mupp +Categories=Science;Physics;DataVisualization; +Keywords=muSR;fitting;musrfit;physics;muon; diff --git a/cmake/mupp_plot.desktop.in b/cmake/mupp_plot.desktop.in new file mode 100644 index 00000000..90714446 --- /dev/null +++ b/cmake/mupp_plot.desktop.in @@ -0,0 +1,11 @@ +[Desktop Entry] +Name=mupp_plot +Comment=Plotter of the muSR parameter plotter mupp +Exec=@CMAKE_INSTALL_FULL_BINDIR@/mupp_plot +Icon=mupp_plot +Terminal=false +Type=Application +NoDisplay=true +StartupWMClass=mupp_plot +Categories=Science;Physics; +Keywords=muSR;fitting;musrfit;physics;muon; diff --git a/cmake/musrStep.desktop.in b/cmake/musrStep.desktop.in new file mode 100644 index 00000000..7953ac48 --- /dev/null +++ b/cmake/musrStep.desktop.in @@ -0,0 +1,11 @@ +[Desktop Entry] +Name=musrStep +Comment=set the initial step sizes of an msr-file +GenericName=musrfit step size tool +Exec=@CMAKE_INSTALL_FULL_BINDIR@/musrStep %f +Icon=musrStep +Terminal=false +Type=Application +StartupWMClass=musrStep +Categories=Science;Physics; +Keywords=muSR;fitting;musrfit;physics;muon; diff --git a/cmake/musrWiz.desktop.in b/cmake/musrWiz.desktop.in new file mode 100644 index 00000000..ead2cc78 --- /dev/null +++ b/cmake/musrWiz.desktop.in @@ -0,0 +1,11 @@ +[Desktop Entry] +Name=musrWiz +Comment=wizard to create msr-files for musrfit +GenericName=musrfit msr-file wizard +Exec=@CMAKE_INSTALL_FULL_BINDIR@/musrWiz +Icon=musrWiz +Terminal=false +Type=Application +StartupWMClass=musrWiz +Categories=Science;Physics; +Keywords=muSR;fitting;musrfit;physics;muon; diff --git a/cmake/musrfit-root6.spec.in b/cmake/musrfit-root6.spec.in index 1fa0f9c4..d55c2916 100644 --- a/cmake/musrfit-root6.spec.in +++ b/cmake/musrfit-root6.spec.in @@ -92,14 +92,26 @@ rm -rf $RPM_BUILD_ROOT %license COPYING %doc %_prefix/share/doc/musrfit %{_datadir}/applications/musredit.desktop -%{_datadir}/icons/hicolor/48x48/apps/musredit.png +%{_datadir}/icons/hicolor/scalable/apps/musredit.svg +%{_datadir}/applications/musrWiz.desktop +%{_datadir}/icons/hicolor/scalable/apps/musrWiz.svg +%{_datadir}/applications/musrStep.desktop +%{_datadir}/icons/hicolor/scalable/apps/musrStep.svg +%{_datadir}/applications/mupp.desktop +%{_datadir}/icons/hicolor/scalable/apps/mupp.svg %{_datadir}/applications/musrview.desktop %{_datadir}/icons/hicolor/scalable/apps/musrview.svg %{_datadir}/icons/hicolor/512x512/apps/musrview.png %{_datadir}/applications/musrFT.desktop %{_datadir}/icons/hicolor/48x48/apps/musrFT.png +%{_datadir}/icons/hicolor/scalable/apps/musrFT.svg %{_datadir}/applications/musrt0.desktop %{_datadir}/icons/hicolor/48x48/apps/musrt0.png +%{_datadir}/icons/hicolor/scalable/apps/musrt0.svg +%{_datadir}/applications/mupp_plot.desktop +%{_datadir}/icons/hicolor/48x48/apps/mupp_plot.png +%{_datadir}/icons/hicolor/512x512/apps/mupp_plot.png +%_prefix/share/musrfit diff --git a/doc/examples/BMWlibs/test-libGapIntegrals-ASCII.msr b/doc/examples/BMWlibs/test-libGapIntegrals-ASCII.msr index e2c1a048..e819c669 100644 --- a/doc/examples/BMWlibs/test-libGapIntegrals-ASCII.msr +++ b/doc/examples/BMWlibs/test-libGapIntegrals-ASCII.msr @@ -11,7 +11,7 @@ FITPARAMETER ############################################################### THEORY asymmetry 1 -userFcn libGapIntegrals TGapPointPWave 2 3 +userFcn libGapIntegrals TGapDWave 2 3 4 5 ############################################################### RUN data/libGapIntegrals-test PIM3 PSI ASCII (name beamline institute data-file-format) diff --git a/doc/examples/DepthProfiles/1300Ar/depth_profile_startup.xml b/doc/examples/DepthProfiles/1300Ar/depth_profile_startup.xml index 01ff5d8a..03e9a623 100644 --- a/doc/examples/DepthProfiles/1300Ar/depth_profile_startup.xml +++ b/doc/examples/DepthProfiles/1300Ar/depth_profile_startup.xml @@ -6,30 +6,6 @@ ./TRIMSP/ SiC_1300x_52nm_48nm_E - - 1000 - 2000 - 3000 - 4000 - 5000 - 6000 - 7000 - 8000 - 9000 - 10000 - 11000 - 12000 - 13000 - 14000 - 15000 - 16000 - 17000 - 17000 - 18000 - 19000 - 20000 - 21000 - 22000 - + diff --git a/doc/examples/DepthProfiles/1300x/depth_profile_startup.xml b/doc/examples/DepthProfiles/1300x/depth_profile_startup.xml index 01ff5d8a..03e9a623 100644 --- a/doc/examples/DepthProfiles/1300x/depth_profile_startup.xml +++ b/doc/examples/DepthProfiles/1300x/depth_profile_startup.xml @@ -6,30 +6,6 @@ ./TRIMSP/ SiC_1300x_52nm_48nm_E - - 1000 - 2000 - 3000 - 4000 - 5000 - 6000 - 7000 - 8000 - 9000 - 10000 - 11000 - 12000 - 13000 - 14000 - 15000 - 16000 - 17000 - 17000 - 18000 - 19000 - 20000 - 21000 - 22000 - + diff --git a/doc/examples/DepthProfiles/PECVD_Si/depth_profile_startup.xml b/doc/examples/DepthProfiles/PECVD_Si/depth_profile_startup.xml index 555601dd..3dfcbb48 100644 --- a/doc/examples/DepthProfiles/PECVD_Si/depth_profile_startup.xml +++ b/doc/examples/DepthProfiles/PECVD_Si/depth_profile_startup.xml @@ -6,30 +6,6 @@ ./TRIMSP/ Si10_2.0_E - - 1000 - 2000 - 3000 - 4000 - 5000 - 6000 - 7000 - 8000 - 9000 - 10000 - 11000 - 12000 - 13000 - 14000 - 15000 - 16000 - 17000 - 17000 - 18000 - 19000 - 20000 - 21000 - 22000 - + diff --git a/doc/examples/DepthProfiles/PECVD_thermal_SiC/depth_profile_startup.xml b/doc/examples/DepthProfiles/PECVD_thermal_SiC/depth_profile_startup.xml index 09413161..42ee56b5 100644 --- a/doc/examples/DepthProfiles/PECVD_thermal_SiC/depth_profile_startup.xml +++ b/doc/examples/DepthProfiles/PECVD_thermal_SiC/depth_profile_startup.xml @@ -6,30 +6,6 @@ ./TRIMSP/ SiO2_70nm2.0_30nm2.2_SiC_E - - 1000 - 2000 - 3000 - 4000 - 5000 - 6000 - 7000 - 8000 - 9000 - 10000 - 11000 - 12000 - 13000 - 14000 - 15000 - 16000 - 17000 - 17000 - 18000 - 19000 - 20000 - 21000 - 22000 - + diff --git a/doc/examples/UserFcn/PUserFcnLinkDef.h b/doc/examples/UserFcn/PUserFcnLinkDef.h index 160da9fc..a7f7eaa1 100644 --- a/doc/examples/UserFcn/PUserFcnLinkDef.h +++ b/doc/examples/UserFcn/PUserFcnLinkDef.h @@ -4,7 +4,7 @@ ***************************************************************************/ -#ifdef __CLING__ +#ifdef __CINT__ #pragma link off all globals; #pragma link off all classes; @@ -12,4 +12,4 @@ #pragma link C++ class PUserFcn+; -#endif //__CLING__ +#endif //__CINT__ diff --git a/doc/examples/data/lem07_his_0592.root b/doc/examples/data/lem07_his_0592.root new file mode 100644 index 00000000..aa0181c0 Binary files /dev/null and b/doc/examples/data/lem07_his_0592.root differ diff --git a/doc/examples/test-LSCO-asy-ZF.msr b/doc/examples/test-LSCO-asy-ZF.msr new file mode 100644 index 00000000..1462e3f6 --- /dev/null +++ b/doc/examples/test-LSCO-asy-ZF.msr @@ -0,0 +1,82 @@ +LSCO (204-207) x=0.00, ZF, T=6K, Tr=15kV, Samp=9kV, E=5.59keV +############################################################### +FITPARAMETER +# Nr. Name Value Step Pos_Error Bounderies + 1 Alpha 1 0 none 0 1.8 + 2 Asy1 0.0297 -0.0056 0.0060 0 0.33 + 3 Phase 0 0 none + 4 Field1 361.2 -2.0 2.2 0 1000 + 5 Lambda1 1.37 -0.33 0.40 0 100 + 6 Asy2 0.0218 -0.0049 0.0057 0 0.33 + 7 Field2 411.7 -3.9 3.9 0 1000 + 8 Lambda2 1.52 -0.36 0.45 0 100 + 9 Asy3 0.0443 -0.0019 0.0019 0 0.33 + 10 Field3 104.86 -0.30 0.30 0 1000 + 11 Lambda3 0.366 -0.039 0.041 0 100 + 12 Asy4 0.0420 -0.0020 0.0020 0 0.33 + 13 Lambda5 0.85 -0.12 0.14 0 10 + 14 Tail 0.1370 -0.0021 0.0019 0 0.33 + +############################################################### +THEORY +asymmetry 2 +TFieldCos 3 fun1 (phase frequency) +simplExpo 5 (rate) ++ +asymmetry 6 +TFieldCos 3 fun2 (phase frequency) +simplExpo 8 (rate) ++ +asymmetry 9 +TFieldCos 3 fun3 (phase frequency) +simplExpo 11 (rate) ++ +asymmetry 12 +simplExpo 13 (rate) ++ +asymmetry 14 + +############################################################### +FUNCTIONS +fun1 = par4 * gamma_mu +fun2 = par7 * gamma_mu +fun3 = par10 * gamma_mu + +############################################################### +RUN data/lem07_his_0592 MUE4 PSI ROOT-NPP (name beamline institute data-file-format) +fittype 2 (asymmetry fit) +alpha 1 +map 0 0 0 0 0 0 0 0 0 0 +forward 1 +backward 3 +background 65000 66500 65000 66500 # estimated bkg: 14.0253 / 11.8067 +data 3419 63000 3419 63000 +t0 3419.0 3419.0 +fit 0 9 +packing 75 + +############################################################### +COMMANDS +MIGRAD +MINOS +SAVE + +############################################################### +FOURIER +units Gauss # units either 'Gauss', 'Tesla', 'MHz', or 'Mc/s' +dc-corrected true +fourier_power 12 +apodization STRONG # NONE, WEAK, MEDIUM, STRONG +plot POWER # REAL, IMAG, REAL_AND_IMAG, POWER, PHASE, PHASE_OPT_REAL +range 0 1000 + +############################################################### +PLOT 2 (asymmetry plot) +runs 1 +# {0, 1&2+0.05, 3, 4} +range 0 5 -0 0.3 +view_packing 150 + +############################################################### +STATISTIC --- 2026-10-18 18:12:48 + chisq = 700.8, NDF = 602, chisq/NDF = 1.164046 diff --git a/doc/examples/test-asy-MUD.msr b/doc/examples/test-asy-MUD.msr index f411e010..cd2afe95 100644 --- a/doc/examples/test-asy-MUD.msr +++ b/doc/examples/test-asy-MUD.msr @@ -48,5 +48,5 @@ runs 1 range 0 8 0 0.25 ############################################################### -STATISTIC --- 2026-01-21 12:33:58 +STATISTIC --- 2017-02-08 07:07:39 chisq = 134.0, NDF = 99, chisq/NDF = 1.353150 diff --git a/doc/examples/test-histo-HAL9500.msr b/doc/examples/test-histo-HAL9500.msr index 76dc0e39..bb612930 100644 --- a/doc/examples/test-histo-HAL9500.msr +++ b/doc/examples/test-histo-HAL9500.msr @@ -2,106 +2,106 @@ MnSi, FLC68.2, 50 K ############################################################### FITPARAMETER # Nr. Name Value Step Pos_Error Boundaries - 1 Rate_1 1.6686 -0.0085 0.0086 - 2 Field_1 73089.887 -0.090 0.090 - 3 Rate_2 1.967 -0.032 0.032 - 4 Field_2 72289.02 -0.24 0.24 + 1 Rate_1 1.6687 0.0086 none + 2 Field_1 73089.883 0.090 none + 3 Rate_2 1.968 0.032 none + 4 Field_2 72289.02 0.24 none - 5 Asym_1 0.2949 -0.0030 0.0030 - 6 Frc_1 0.7316 -0.0058 0.0059 - 7 Phase_1 55.61 -0.52 0.52 - 8 N0_1 940.36 -0.54 0.54 - 9 Bkg_1 1.524 -0.064 0.064 + 5 Asym_1 0.2949 0.0030 none + 6 Frc_1 0.7316 0.0059 none + 7 Phase_1 55.61 0.52 none + 8 N0_1 940.35 0.54 none + 9 Bkg_1 1.523 0.064 none - 10 Asym_2 0.2960 -0.0030 0.0030 - 11 Frc_2 0.7475 -0.0058 0.0059 - 12 Phase_2 30.77 -0.50 0.50 - 13 N0_2 961.50 -0.55 0.55 - 14 Bkg_2 1.929 -0.065 0.065 + 10 Asym_2 0.2960 0.0030 none + 11 Frc_2 0.7475 0.0059 none + 12 Phase_2 30.77 0.50 none + 13 N0_2 961.49 0.55 none + 14 Bkg_2 1.928 0.065 none - 15 Asym_3 0.3002 -0.0029 0.0029 - 16 Frc_3 0.7462 -0.0056 0.0057 - 17 Phase_3 18.03 -0.48 0.48 - 18 N0_3 1024.29 -0.57 0.57 - 19 Bkg_3 1.920 -0.067 0.067 + 15 Asym_3 0.3002 0.0029 none + 16 Frc_3 0.7462 0.0056 none + 17 Phase_3 18.03 0.48 none + 18 N0_3 1024.28 0.57 none + 19 Bkg_3 1.919 0.067 none - 20 Asym_4 0.3088 -0.0029 0.0029 - 21 Frc_4 0.7333 -0.0053 0.0054 - 22 Phase_4 336.94 -0.48 0.47 - 23 N0_4 1029.37 -0.57 0.57 - 24 Bkg_4 1.865 -0.067 0.067 + 20 Asym_4 0.3088 0.0029 none + 21 Frc_4 0.7333 0.0054 none + 22 Phase_4 336.94 0.47 none + 23 N0_4 1029.36 0.57 none + 24 Bkg_4 1.863 0.067 none - 25 Asym_5 0.3094 -0.0029 0.0029 - 26 Frc_5 0.7416 -0.0054 0.0055 - 27 Phase_5 280.33 -0.48 0.48 - 28 N0_5 1002.70 -0.56 0.56 - 29 Bkg_5 1.981 -0.067 0.067 + 25 Asym_5 0.3094 0.0029 none + 26 Frc_5 0.7416 0.0055 none + 27 Phase_5 280.32 0.48 none + 28 N0_5 1002.69 0.56 none + 29 Bkg_5 1.979 0.067 none - 30 Asym_6 0.3153 -0.0032 0.0032 - 31 Frc_6 0.7403 -0.0057 0.0058 - 32 Phase_6 211.07 -0.51 0.51 - 33 N0_6 853.44 -0.52 0.52 - 34 Bkg_6 1.658 -0.061 0.061 + 30 Asym_6 0.3153 0.0032 none + 31 Frc_6 0.7403 0.0058 none + 32 Phase_6 211.07 0.51 none + 33 N0_6 853.43 0.52 none + 34 Bkg_6 1.656 0.061 none - 35 Asym_7 0.3118 -0.0032 0.0032 - 36 Frc_7 0.7377 -0.0058 0.0059 - 37 Phase_7 161.75 -0.51 0.51 - 38 N0_7 858.77 -0.52 0.52 - 39 Bkg_7 1.595 -0.061 0.062 + 35 Asym_7 0.3118 0.0032 none + 36 Frc_7 0.7378 0.0059 none + 37 Phase_7 161.74 0.51 none + 38 N0_7 858.76 0.52 none + 39 Bkg_7 1.594 0.061 none - 40 Asym_8 0.2985 -0.0031 0.0031 - 41 Frc_8 0.7373 -0.0060 0.0061 - 42 Phase_8 133.70 -0.53 0.53 - 43 N0_8 871.20 -0.52 0.52 - 44 Bkg_8 1.748 -0.062 0.062 + 40 Asym_8 0.2985 0.0031 none + 41 Frc_8 0.7373 0.0061 none + 42 Phase_8 133.69 0.53 none + 43 N0_8 871.20 0.52 none + 44 Bkg_8 1.746 0.062 none - 45 Asym_9 0.2874 -0.0027 0.0027 - 46 Frc_9 0.7340 -0.0054 0.0055 - 47 Phase_9 158.63 -0.47 0.47 - 48 N0_9 1184.30 -0.61 0.61 - 49 Bkg_9 2.544 -0.073 0.073 + 45 Asym_9 0.2874 0.0027 none + 46 Frc_9 0.7340 0.0054 none + 47 Phase_9 158.63 0.47 none + 48 N0_9 1184.29 0.61 none + 49 Bkg_9 2.542 0.073 none - 50 Asym_10 0.2845 -0.0027 0.0027 - 51 Frc_10 0.7452 -0.0055 0.0055 - 52 Phase_10 128.05 -0.47 0.47 - 53 N0_10 1193.67 -0.61 0.61 - 54 Bkg_10 2.396 -0.073 0.073 + 50 Asym_10 0.2846 0.0027 none + 51 Frc_10 0.7453 0.0055 none + 52 Phase_10 128.05 0.47 none + 53 N0_10 1193.66 0.61 none + 54 Bkg_10 2.394 0.073 none - 55 Asym_11 0.2877 -0.0026 0.0026 - 56 Frc_11 0.7462 -0.0052 0.0053 - 57 Phase_11 102.42 -0.45 0.45 - 58 N0_11 1280.01 -0.63 0.63 - 59 Bkg_11 2.732 -0.075 0.075 + 55 Asym_11 0.2877 0.0026 none + 56 Frc_11 0.7463 0.0053 none + 57 Phase_11 102.43 0.45 none + 58 N0_11 1280.00 0.63 none + 59 Bkg_11 2.730 0.075 none - 60 Asym_12 0.2919 -0.0025 0.0025 - 61 Frc_12 0.7405 -0.0050 0.0050 - 62 Phase_12 42.97 -0.43 0.43 - 63 N0_12 1383.97 -0.66 0.66 - 64 Bkg_12 2.809 -0.078 0.078 + 60 Asym_12 0.2919 0.0025 none + 61 Frc_12 0.7405 0.0050 none + 62 Phase_12 42.97 0.43 none + 63 N0_12 1383.96 0.66 none + 64 Bkg_12 2.807 0.078 none - 65 Asym_13 0.2903 -0.0025 0.0025 - 66 Frc_13 0.7493 -0.0050 0.0050 - 67 Phase_13 350.74 -0.43 0.43 - 68 N0_13 1393.02 -0.66 0.66 - 69 Bkg_13 2.740 -0.078 0.079 + 65 Asym_13 0.2903 0.0025 none + 66 Frc_13 0.7494 0.0050 none + 67 Phase_13 350.74 0.43 none + 68 N0_13 1393.01 0.66 none + 69 Bkg_13 2.738 0.078 none - 70 Asym_14 0.2968 -0.0025 0.0025 - 71 Frc_14 0.7327 -0.0049 0.0050 - 72 Phase_14 288.57 -0.43 0.43 - 73 N0_14 1374.47 -0.66 0.66 - 74 Bkg_14 2.771 -0.078 0.078 + 70 Asym_14 0.2968 0.0025 none + 71 Frc_14 0.7327 0.0049 none + 72 Phase_14 288.56 0.43 none + 73 N0_14 1374.46 0.66 none + 74 Bkg_14 2.768 0.078 none - 75 Asym_15 0.2799 -0.0025 0.0025 - 76 Frc_15 0.7427 -0.0052 0.0053 - 77 Phase_15 282.56 -0.45 0.45 - 78 N0_15 1365.99 -0.66 0.65 - 79 Bkg_15 2.811 -0.078 0.078 + 75 Asym_15 0.2799 0.0025 none + 76 Frc_15 0.7427 0.0052 none + 77 Phase_15 282.56 0.45 none + 78 N0_15 1365.97 0.65 none + 79 Bkg_15 2.809 0.078 none - 80 Asym_16 0.2771 -0.0026 0.0026 - 81 Frc_16 0.7344 -0.0054 0.0055 - 82 Phase_16 212.46 -0.48 0.48 - 83 N0_16 1256.95 -0.63 0.63 - 84 Bkg_16 2.460 -0.074 0.075 + 80 Asym_16 0.2771 0.0026 none + 81 Frc_16 0.7344 0.0055 none + 82 Phase_16 212.46 0.48 none + 83 N0_16 1256.94 0.63 none + 84 Bkg_16 2.458 0.074 none ############################################################### THEORY @@ -257,12 +257,9 @@ t0 20039.0 ############################################################### COMMANDS -#OpenCL-GPU -CUDA MAX_LIKELIHOOD -#PRINT_LEVEL 2 +PRINT_LEVEL 2 MINIMIZE -MINOS SAVE ############################################################### @@ -281,5 +278,5 @@ phase par(7, 5, 16) range 7.1 7.5 ############################################################### -STATISTIC --- 2026-01-19 16:46:24 - maxLH = 1286509.8, NDF = 1246064, maxLH/NDF = 1.032459 +STATISTIC --- 2018-10-15 15:55:36 + maxLH = 1286508.7, NDF = 1246064, maxLH/NDF = 1.032458 diff --git a/doc/examples/test-histo-MusrRoot.msr b/doc/examples/test-histo-MusrRoot.msr index f2f65f71..64b58ecb 100644 --- a/doc/examples/test-histo-MusrRoot.msr +++ b/doc/examples/test-histo-MusrRoot.msr @@ -2,20 +2,20 @@ LSCO x=0.02 (224-227), T=12.00 (K), E=5.57 keV, WEW B=~49(G)/8.62(A), Tr=15.02 ( ############################################################### FITPARAMETER # No Name Value Step Pos_Error Boundaries - 1 AsymT 0.05052 -0.00071 0.00072 0 0.33 + 1 AsymT 0.05053 -0.00071 0.00072 0 0.33 2 Field 48.298 -0.094 0.095 3 RateT 0.129 -0.010 0.010 0 none 4 AsymL 0 0 none 0 0.33 5 RateL 0 0 none 6 AlphaLR 0.9784 -0.0013 0.0013 7 PhaseL 6.6 -1.6 1.6 -40 40 - 8 BkgL 6.921 -0.048 0.048 + 8 BkgL 6.920 -0.048 0.048 9 RelPhaseR 178.8 -1.9 1.9 150 210 - 10 NormR 419.47 -0.40 0.40 + 10 NormR 419.46 -0.40 0.40 11 BkgR 8.393 -0.050 0.050 12 AlphaTB 1.1025 -0.0015 0.0015 13 RelPhaseT 269.1 -1.9 1.9 240 300 - 14 BkgT 7.467 -0.049 0.050 + 14 BkgT 7.466 -0.049 0.049 15 NormB 393.08 -0.39 0.39 16 RelPhaseB 90.7 -2.0 2.0 60 120 17 BkgB 7.092 -0.048 0.048 @@ -36,7 +36,7 @@ FUNCTIONS fun1 = par7 + map1 fun2 = par2 * gamma_mu fun3 = map2 * map3 -fun4 = par4 * cos(pi / 180 * (par7 + map1)) +fun4 = par4 * cos(pi / 180.0 * (par7 + map1)) ############################################################### GLOBAL @@ -96,5 +96,5 @@ range 0 9 -0.15 0.15 view_packing 500 ############################################################### -STATISTIC --- 2026-02-13 14:07:06 - maxLH = 3971.7, NDF = 4001, maxLH/NDF = 0.992678 +STATISTIC --- 2018-11-13 07:58:56 + maxLH = 3971.7, NDF = 4001, maxLH/NDF = 0.992668 diff --git a/doc/examples/test-histo-NeXus2.msr b/doc/examples/test-histo-NeXus2.msr index d7519261..ceef5c04 100644 --- a/doc/examples/test-histo-NeXus2.msr +++ b/doc/examples/test-histo-NeXus2.msr @@ -4,7 +4,7 @@ FITPARAMETER # No Name Value Step Pos_Error Boundaries 1 phaseL 0 0 none 2 field 20.3381 -0.0085 0.0085 0 none - 3 asym 0.23440 -0.00051 0.00052 0 0.3 + 3 asym 0.23440 -0.00051 0.00051 0 0.3 4 rate 0.0234 -0.0041 0.0035 0 100 5 Norm_L 1151.30 -0.53 0.53 6 BG_L 0 0 none 0 none @@ -38,6 +38,7 @@ norm 5 backgr.fit 6 map 1 0 0 0 0 0 0 0 0 0 forward 1-48 +#deadtime-cor file RUN data/emu00139040 XXXX ISIS NEXUS (name beamline institute data-file-format) norm 7 @@ -69,8 +70,5 @@ range 0 20 -0.35 0.35 view_packing 10 ############################################################### -STATISTIC --- 2026-03-02 13:44:22 +STATISTIC --- 2026-02-23 13:09:55 maxLH = 4228.9, NDF = 3726, maxLH/NDF = 1.134977 - expected maxLH = 4211.4, NDF = 3726, expected maxLH/NDF = 1.130285 - run block 1: (NDF/red.maxLH/red.maxLH_e) = (1862/1.170949/1.182735) - run block 2: (NDF/red.maxLH/red.maxLH_e) = (1861/1.100817/1.079629) diff --git a/doc/examples/test-histo-PSI-BIN.msr b/doc/examples/test-histo-PSI-BIN.msr index abf21858..081079e3 100644 --- a/doc/examples/test-histo-PSI-BIN.msr +++ b/doc/examples/test-histo-PSI-BIN.msr @@ -8,9 +8,9 @@ FITPARAMETER 4 Phase_L 178.95 -0.41 0.41 5 Phase_R 1.75 -0.39 0.39 6 N0_L 1097.9 -1.0 1.0 - 7 N0_R 1159.8 -1.0 1.0 + 7 N0_R 1159.7 -1.0 1.0 8 Bkg_L 54.47 -0.20 0.20 - 9 Bkg_R 46.71 -0.19 0.19 + 9 Bkg_R 46.70 -0.19 0.19 ############################################################### THEORY @@ -47,7 +47,6 @@ t0 202.0 ############################################################### COMMANDS -CUDA SCALE_N0_BKG TRUE MINIMIZE MINOS @@ -64,11 +63,11 @@ FOURIER units Gauss # units either 'Gauss', 'Tesla', 'MHz', or 'Mc/s' fourier_power 12 apodization NONE # NONE, WEAK, MEDIUM, STRONG -plot POWER # REAL, IMAG, REAL_AND_IMAG, POWER, PHASE, PHASE_OPT_REAL +plot POWER # REAL, IMAG, REAL_AND_IMAG, POWER, PHASE phase 8.5 #range_for_phase_correction 50.0 70.0 -range 0 200 +range 0.0 200.0 ############################################################### -STATISTIC --- 2024-06-07 15:33:49 - chisq = 663.9, NDF = 515, chisq/NDF = 1.289084 +STATISTIC --- 2015-01-05 14:09:47 + chisq = 663.9, NDF = 515, chisq/NDF = 1.289169 diff --git a/doc/html/.buildinfo b/doc/html/.buildinfo index 615489fd..3064ff78 100644 --- a/doc/html/.buildinfo +++ b/doc/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: fae482e1a3134e03efb428cbbe21a254 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: a49a5e0b750ed752f738f66d3ddeadd4 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/src/musredit_qt5/mupp/mupp.dox b/doc/mupp.dox similarity index 100% rename from src/musredit_qt5/mupp/mupp.dox rename to doc/mupp.dox diff --git a/doc/mupp_dox.cfg b/doc/mupp_qt5_dox.cfg similarity index 99% rename from doc/mupp_dox.cfg rename to doc/mupp_qt5_dox.cfg index 6fae7344..a9995aba 100644 --- a/doc/mupp_dox.cfg +++ b/doc/mupp_qt5_dox.cfg @@ -733,9 +733,10 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT =../src/musredit_qt5/mupp \ - ../src/musredit_qt5/mupp/var/include \ - ../src/musredit_qt5/mupp/var/src +INPUT = ./ \ + ../src/musredit_qt5/mupp \ + ../src/musredit_qt5/mupp/var/include \ + ../src/musredit_qt5/mupp/var/src # 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 @@ -755,7 +756,7 @@ INPUT_ENCODING = UTF-8 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. -FILE_PATTERNS = *.dox *.cpp *.h *.hpp +FILE_PATTERNS = mupp.dox *.cpp *.h *.hpp # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -1532,7 +1533,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/doc/musredit_dox.cfg b/doc/mupp_qt6_dox.cfg similarity index 99% rename from doc/musredit_dox.cfg rename to doc/mupp_qt6_dox.cfg index 1bc4ed08..78515c15 100644 --- a/doc/musredit_dox.cfg +++ b/doc/mupp_qt6_dox.cfg @@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "musredit" +PROJECT_NAME = "mupp" # 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 = 1.0.0 +PROJECT_NUMBER = 1.1.0 # 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 @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = ./technical/html/musredit +OUTPUT_DIRECTORY = ./technical/html/mupp # 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 @@ -733,7 +733,10 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT =../src/musredit_qt5/musredit +INPUT = ./ \ + ../src/musredit_qt6/mupp \ + ../src/musredit_qt6/mupp/var/include \ + ../src/musredit_qt6/mupp/var/src # 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 @@ -753,7 +756,7 @@ INPUT_ENCODING = UTF-8 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. -FILE_PATTERNS = *.dox *.cpp *.h +FILE_PATTERNS = mupp.dox *.cpp *.h *.hpp # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -1530,7 +1533,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1969,7 +1972,7 @@ TAGFILES = # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = dox-tags/musredit.tag +GENERATE_TAGFILE = dox-tags/mupp.tag # If the ALLEXTERNALS tag is set to YES all external class will be listed in the # class index. If set to NO only the inherited external classes will be listed. diff --git a/src/musredit_qt5/musredit/musredit.dox b/doc/musredit.dox similarity index 100% rename from src/musredit_qt5/musredit/musredit.dox rename to doc/musredit.dox diff --git a/doc/musredit_qt5_dox.cfg b/doc/musredit_qt5_dox.cfg new file mode 100644 index 00000000..51a9ab25 --- /dev/null +++ b/doc/musredit_qt5_dox.cfg @@ -0,0 +1,2567 @@ +# Doxyfile 1.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# 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 (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# 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 = musredit + +# 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 = 1.0.0 + +# 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 = ./technical/html/musredit + +# 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 causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# 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, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, 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 + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# 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, 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 and the. + +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 +# 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. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# 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 = YES + +# 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-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 + +# 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 + +# 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 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 act 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 (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 = NO + +# 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 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++, 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 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 efficively 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 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 = YES + +# 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 = YES + +# 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_PACKAGE = NO + +# 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. 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 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, 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 +# 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, 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 then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# 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 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 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 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_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 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 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 +# 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_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. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# 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 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 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 default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# 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 +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# 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. +# +# 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. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# 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 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 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 the WARN_IF_DOC_ERROR tag 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. +# The default value is: YES. + +WARN_IF_DOC_ERROR = 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 or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# 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) +# 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 standard +# error (stderr). + +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 = ./ \ + ../src/musredit_qt5/musredit + +# 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++, *.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 = musredit.dox \ + *.cpp \ + *.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 = NO + +# 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 = + +# 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 +# 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, +# AClass::ANamespace, 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_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). + +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. + +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. +# 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 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 +#--------------------------------------------------------------------------- + +# 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, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# 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 then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# 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 = NO + +# 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. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# 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 = + +#--------------------------------------------------------------------------- +# Configuration options related to the 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. +# 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). +# 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 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 colorwheel, 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 grayscales 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 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 +# (see: +# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. +# +# 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. + +GENERATE_HTMLHELP = NO + +# 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. + +CHM_FILE = + +# 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. + +GENERATE_CHI = NO + +# 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. + +BINARY_TOC = NO + +# 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. + +TOC_EXPAND = NO + +# 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. + +DISABLE_INDEX = 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. 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 = NO + +# 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. + +ENUM_VALUES_PER_LINE = 4 + +# 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. + +TREEVIEW_WIDTH = 250 + +# 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 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 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) 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: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# 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 +# , /