improved documentation

This commit is contained in:
jkriege2 2022-07-19 14:44:12 +02:00
parent 74c2e3edf1
commit c2ddf8af37
2 changed files with 21 additions and 6 deletions

View File

@ -27,7 +27,7 @@
\ingroup jkqtpplottersupprt \ingroup jkqtpplottersupprt
\brief This is defined if JKQtPlotter shall be compiled without print-support, or print-support is not available. \brief This is defined if JKQtPlotter shall be compiled without print-support, or print-support is not available.
This can be used by surrounding code that is requires print-support with This can be used by surrounding code that requires print-support with
\code \code
#ifndef JKQTPLOTTER_COMPILE_WITHOUT_PRINTSUPPORT #ifndef JKQTPLOTTER_COMPILE_WITHOUT_PRINTSUPPORT
// ... // ...
@ -45,12 +45,27 @@
# endif # endif
#endif #endif
/*! \def JKQTPLOTTER_WORKAROUND_QGADGET_BUG
\ingroup jkqtpplottersupprt
\brief This \c #define is used to work around a bug in Qt when compiled with CLANG (see https://bugreports.qt.io/browse/QTBUG-104874):
Multiple inheritance does not work with Q_GADGET in this setup.
This can be used by surrounding code that causes compile-errors due to this bug with
\code
#ifndef JKQTPLOTTER_COMPILE_WITHOUT_PRINTSUPPORT
// ...
// Code that require Print Support
// ...
#endif
\endcode
*/
#if defined(Q_CC_CLANG) && (QT_VERSION < QT_VERSION_CHECK(7, 0, 0)) #if defined(Q_CC_CLANG) && (QT_VERSION < QT_VERSION_CHECK(7, 0, 0))
# define JKQTPLOTTER_WORKAROUND_QGADET_BUG # define JKQTPLOTTER_WORKAROUND_QGADGET_BUG
# warning("deactivating some Q_GADGET-declarations due to a bug in Qt on CLANG: https://bugreports.qt.io/browse/QTBUG-104874") # warning("deactivating some Q_GADGET-declarations due to a bug in Qt on CLANG: https://bugreports.qt.io/browse/QTBUG-104874")
#else #else
# ifdef JKQTPLOTTER_WORKAROUND_QGADET_BUG # ifdef JKQTPLOTTER_WORKAROUND_QGADGET_BUG
# undef JKQTPLOTTER_WORKAROUND_QGADET_BUG # undef JKQTPLOTTER_WORKAROUND_QGADGET_BUG
# endif # endif
#endif #endif

View File

@ -1,12 +1,12 @@
============================================================================= =============================================================================
== JKQTPlotters is a library for scientific plotting using Qt5 == == JKQTPlotters is a library for scientific plotting using Qt5/6 ==
== sub-library: @libBasename@ == sub-library: @libBasename@
============================================================================= =============================================================================
Library Information: Library Information:
version: @PROJECT_VERSION@ version: @PROJECT_VERSION@
main author/maintainer: Jan Krieger <jan@jkrieger.de> main author/maintainer: Jan Krieger <jan@jkrieger.de>
copyright: (c) 2008-2019 by Jan Krieger copyright: (c) 2008-2022 Jan Krieger
license: GNU LESSER GENERAL PUBLIC LICENSE >= v2.1 license: GNU LESSER GENERAL PUBLIC LICENSE >= v2.1
repository: https://github.com/jkriege2/JKQtPlotter repository: https://github.com/jkriege2/JKQtPlotter
documentation: http://jkriege2.github.io/JKQtPlotter/index.html documentation: http://jkriege2.github.io/JKQtPlotter/index.html