From 0faa51c9f5a604ecf9797120032ec51994ee97fe Mon Sep 17 00:00:00 2001 From: jkriege2 Date: Mon, 21 Sep 2020 13:47:54 +0200 Subject: [PATCH] comment formatting fix --- lib/jkqtcommon/jkqtpbasicimagetools.h | 18 +- lib/jkqtcommon/jkqtpmathparser.h | 4 +- lib/jkqtfastplotter/jkqtfastplotter.h | 450 +++++++++--------- lib/jkqtmathtext/jkqtmathtext.h | 194 ++++---- lib/jkqtplotter/graphs/jkqtpbarchartbase.h | 8 +- lib/jkqtplotter/graphs/jkqtpboxplotbase.h | 112 ++--- .../graphs/jkqtpboxplotstylingmixins.h | 64 +-- lib/jkqtplotter/graphs/jkqtpcontour.h | 22 +- .../graphs/jkqtpevaluatedfunction.h | 34 +- lib/jkqtplotter/graphs/jkqtpgeoannotations.h | 22 +- lib/jkqtplotter/graphs/jkqtpgeobase.h | 2 +- lib/jkqtplotter/graphs/jkqtpgeoshapes.h | 32 +- lib/jkqtplotter/graphs/jkqtpimage.h | 64 +-- lib/jkqtplotter/graphs/jkqtpimageoverlays.h | 46 +- lib/jkqtplotter/graphs/jkqtpimagergb.h | 190 ++++---- lib/jkqtplotter/graphs/jkqtpimpulses.h | 6 +- lib/jkqtplotter/graphs/jkqtppeakstream.h | 16 +- lib/jkqtplotter/graphs/jkqtprange.h | 54 +-- lib/jkqtplotter/graphs/jkqtpscatter.h | 52 +- .../graphs/jkqtpsinglecolumnsymbols.h | 12 +- .../graphs/jkqtpviolinplotstylingmixins.h | 52 +- lib/jkqtplotter/jkqtpbaseplotter.h | 248 +++++----- lib/jkqtplotter/jkqtpcoordinateaxes.h | 194 ++++---- lib/jkqtplotter/jkqtpdatastorage.h | 16 +- lib/jkqtplotter/jkqtpgraphsbase.h | 56 +-- lib/jkqtplotter/jkqtpgraphsbaseerrors.h | 32 +- .../jkqtpgraphsbasestylingmixins.h | 12 +- lib/jkqtplotter/jkqtpimagetools.h | 134 +++--- 28 files changed, 1073 insertions(+), 1073 deletions(-) diff --git a/lib/jkqtcommon/jkqtpbasicimagetools.h b/lib/jkqtcommon/jkqtpbasicimagetools.h index d1b0c6dc0e..04c0d4e3bc 100644 --- a/lib/jkqtcommon/jkqtpbasicimagetools.h +++ b/lib/jkqtcommon/jkqtpbasicimagetools.h @@ -418,10 +418,10 @@ struct JKQTPImageTools { - /*! \brief return a list of all globally available LUTs, human-readable/localized form */ + /** \brief return a list of all globally available LUTs, human-readable/localized form */ static QStringList JKQTCOMMON_LIB_EXPORT getPredefinedPalettes(); - /*! \brief return a list of all globally available LUTs, machine-readable form */ + /** \brief return a list of all globally available LUTs, machine-readable form */ static QStringList JKQTCOMMON_LIB_EXPORT getPredefinedPalettesMachineReadable(); /*! \brief convert the palette \a p to a string @@ -435,22 +435,22 @@ struct JKQTPImageTools { static JKQTCOMMON_LIB_EXPORT JKQTPMathImageColorPalette String2JKQTPMathImageColorPalette(const QString& p); - /*! \brief generates a QImage with width \a width and height 1 for the i-th color palette (\a i is based on the list returned by JKQTPImagePlot_getPredefinedPalettes() ) */ + /** \brief generates a QImage with width \a width and height 1 for the i-th color palette (\a i is based on the list returned by JKQTPImagePlot_getPredefinedPalettes() ) */ static QImage JKQTCOMMON_LIB_EXPORT GetPaletteImage(int i, int width); - /*! \brief generates a QImage with width \a width and height \a height for the i-th color palette (\a i is based on the list returned by JKQTPImagePlot_getPredefinedPalettes() ) */ + /** \brief generates a QImage with width \a width and height \a height for the i-th color palette (\a i is based on the list returned by JKQTPImagePlot_getPredefinedPalettes() ) */ static QImage JKQTCOMMON_LIB_EXPORT GetPaletteImage(int i, int width, int height); - /*! \brief generates a QImage with width \a width and height 1 for a specific JKQTPMathImageColorPalette */ + /** \brief generates a QImage with width \a width and height 1 for a specific JKQTPMathImageColorPalette */ static QImage JKQTCOMMON_LIB_EXPORT GetPaletteImage(JKQTPMathImageColorPalette palette, int width); - /*! \brief generates a QImage with width \a width and height \a height for a specific JKQTPMathImageColorPalette */ + /** \brief generates a QImage with width \a width and height \a height for a specific JKQTPMathImageColorPalette */ static QImage JKQTCOMMON_LIB_EXPORT GetPaletteImage(JKQTPMathImageColorPalette palette, int width, int height); - /*! \brief generates a QImage with width \a width and height 1 for a lookup-table \a lut */ + /** \brief generates a QImage with width \a width and height 1 for a lookup-table \a lut */ static QImage JKQTCOMMON_LIB_EXPORT GetPaletteImage(const LUTType& lut, int width); - /*! \brief generates a QIcon for the i-th color palette (\a i is based on the list returned by JKQTPImagePlot_getPredefinedPalettes() ) */ + /** \brief generates a QIcon for the i-th color palette (\a i is based on the list returned by JKQTPImagePlot_getPredefinedPalettes() ) */ static QIcon JKQTCOMMON_LIB_EXPORT GetPaletteIcon(int i) ; - /*! \brief generates a QIcon for a specific JKQTPMathImageColorPalette */ + /** \brief generates a QIcon for a specific JKQTPMathImageColorPalette */ static QIcon JKQTCOMMON_LIB_EXPORT GetPaletteIcon(JKQTPMathImageColorPalette palette) ; private: diff --git a/lib/jkqtcommon/jkqtpmathparser.h b/lib/jkqtcommon/jkqtpmathparser.h index 96ec023f91..cf98377fa2 100644 --- a/lib/jkqtcommon/jkqtpmathparser.h +++ b/lib/jkqtcommon/jkqtpmathparser.h @@ -788,9 +788,9 @@ class JKQTCOMMON_LIB_EXPORT JKQTPMathParser /** \brief class destructor */ virtual ~JKQTPMathParser(); - /*! \copydoc data */ + /** \copydoc data */ virtual void setData(void* __value); - /*! \copydoc data */ + /** \copydoc data */ virtual void* getData() const; /** \brief register a new function diff --git a/lib/jkqtfastplotter/jkqtfastplotter.h b/lib/jkqtfastplotter/jkqtfastplotter.h index 2684095168..d9f8e74a2e 100644 --- a/lib/jkqtfastplotter/jkqtfastplotter.h +++ b/lib/jkqtfastplotter/jkqtfastplotter.h @@ -432,7 +432,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { } } - /*! \copydoc dragShapePen */ + /** \copydoc dragShapePen */ inline void setDragShapePen(const QPen & __value) { if (this->dragShapePen != __value) { @@ -440,12 +440,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { update(); } } - /*! \copydoc dragShapePen */ + /** \copydoc dragShapePen */ inline QPen getDragShapePen() const { return this->dragShapePen; } - /*! \copydoc dragLine */ + /** \copydoc dragLine */ inline void setDragLine(bool __value) { if (this->dragLine != __value) { @@ -453,13 +453,13 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { update(); } } - /*! \copydoc dragLine */ + /** \copydoc dragLine */ inline bool getDragLine() const { return this->dragLine; } - /*! \copydoc plotBorderLeft */ + /** \copydoc plotBorderLeft */ inline void setPlotBorderLeft(int __value) { if (this->plotBorderLeft != __value) { @@ -467,12 +467,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc plotBorderLeft */ + /** \copydoc plotBorderLeft */ inline int getPlotBorderLeft() const { return this->plotBorderLeft; } - /*! \copydoc plotBorderBottom */ + /** \copydoc plotBorderBottom */ inline void setPlotBorderBottom(int __value) { if (this->plotBorderBottom != __value) { @@ -480,12 +480,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc plotBorderBottom */ + /** \copydoc plotBorderBottom */ inline int getPlotBorderBottom() const { return this->plotBorderBottom; } - /*! \copydoc plotBorderRight */ + /** \copydoc plotBorderRight */ inline void setPlotBorderRight(int __value) { if (this->plotBorderRight != __value) { @@ -493,12 +493,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc plotBorderRight */ + /** \copydoc plotBorderRight */ inline int getPlotBorderRight() const { return this->plotBorderRight; } - /*! \copydoc plotBorderTop */ + /** \copydoc plotBorderTop */ inline void setPlotBorderTop(int __value) { if (this->plotBorderTop != __value) { @@ -506,71 +506,71 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc plotBorderTop */ + /** \copydoc plotBorderTop */ inline int getPlotBorderTop() const { return this->plotBorderTop; } - /*! \copydoc plotWidth */ + /** \copydoc plotWidth */ inline int getPlotWidth() const { return this->plotWidth; } - /*! \copydoc plotHeight */ + /** \copydoc plotHeight */ inline int getPlotHeight() const { return this->plotHeight; } - /*! \copydoc doDrawing */ + /** \copydoc doDrawing */ inline void setPlotUpdateEnabled(bool __value) { this->doDrawing = __value; } - /*! \copydoc doDrawing */ + /** \copydoc doDrawing */ inline bool isPlotUpdateEnabled() const { return this->doDrawing; } - /*! \copydoc internalPlotBorderLeft */ + /** \copydoc internalPlotBorderLeft */ inline int getInternalPlotBorderLeft() const { return this->internalPlotBorderLeft; } - /*! \copydoc internalPlotBorderBottom */ + /** \copydoc internalPlotBorderBottom */ inline int getInternalPlotBorderBottom() const { return this->internalPlotBorderBottom; } - /*! \copydoc internalPlotBorderRight */ + /** \copydoc internalPlotBorderRight */ inline int getInternalPlotBorderRight() const { return this->internalPlotBorderRight; } - /*! \copydoc internalPlotBorderTop */ + /** \copydoc internalPlotBorderTop */ inline int getInternalPlotBorderTop() const { return this->internalPlotBorderTop; } - /*! \copydoc xMin */ + /** \copydoc xMin */ inline double getXMin() const { return this->xMin; } - /*! \copydoc xMax */ + /** \copydoc xMax */ inline double getXMax() const { return this->xMax; } - /*! \copydoc yMin */ + /** \copydoc yMin */ inline double getYMin() const { return this->yMin; } - /*! \copydoc yMax */ + /** \copydoc yMax */ inline double getYMax() const { return this->yMax; } - /*! \copydoc xAxisLog */ + /** \copydoc xAxisLog */ inline bool getXAxisLog() const { return this->xAxisLog; } - /*! \copydoc yAxisLog */ + /** \copydoc yAxisLog */ inline bool getYAxisLog() const { return this->yAxisLog; } - /*! \copydoc backgroundColor */ + /** \copydoc backgroundColor */ inline void setBackgroundColor(const QColor & __value) { if (this->backgroundColor != __value) { @@ -578,12 +578,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc backgroundColor */ + /** \copydoc backgroundColor */ inline QColor getBackgroundColor() const { return this->backgroundColor; } - /*! \copydoc plotBackgroundColor */ + /** \copydoc plotBackgroundColor */ inline void setPlotBackgroundColor(const QColor & __value) { if (this->plotBackgroundColor != __value) { @@ -591,12 +591,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc plotBackgroundColor */ + /** \copydoc plotBackgroundColor */ inline QColor getPlotBackgroundColor() const { return this->plotBackgroundColor; } - /*! \copydoc drawGrid */ + /** \copydoc drawGrid */ inline void setDrawGrid(bool __value) { if (this->drawGrid != __value) { @@ -604,12 +604,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc drawGrid */ + /** \copydoc drawGrid */ inline bool getDrawGrid() const { return this->drawGrid; } - /*! \copydoc gridColor */ + /** \copydoc gridColor */ inline void setGridColor(const QColor & __value) { if (this->gridColor != __value) { @@ -617,12 +617,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc gridColor */ + /** \copydoc gridColor */ inline QColor getGridColor() const { return this->gridColor; } - /*! \copydoc gridStyle */ + /** \copydoc gridStyle */ inline void setGridStyle(Qt::PenStyle __value) { if (this->gridStyle != __value) { @@ -630,12 +630,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc gridStyle */ + /** \copydoc gridStyle */ inline Qt::PenStyle getGridStyle() const { return this->gridStyle; } - /*! \copydoc gridWidth */ + /** \copydoc gridWidth */ inline void setGridWidth(double __value) { if (this->gridWidth != __value) { @@ -643,12 +643,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc gridWidth */ + /** \copydoc gridWidth */ inline double getGridWidth() const { return this->gridWidth; } - /*! \copydoc labelFontSize */ + /** \copydoc labelFontSize */ inline void setLabelFontSize(double __value) { if (this->labelFontSize != __value) { @@ -656,12 +656,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc labelFontSize */ + /** \copydoc labelFontSize */ inline double getLabelFontSize() const { return this->labelFontSize; } - /*! \copydoc labelFontName */ + /** \copydoc labelFontName */ inline void setLabelFontName(const QString & __value) { if (this->labelFontName != __value) { @@ -669,12 +669,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc labelFontName */ + /** \copydoc labelFontName */ inline QString getLabelFontName() const { return this->labelFontName; } - /*! \copydoc tickFontSize */ + /** \copydoc tickFontSize */ inline void setTickFontSize(double __value) { if (this->tickFontSize != __value) { @@ -682,12 +682,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc tickFontSize */ + /** \copydoc tickFontSize */ inline double getTickFontSize() const { return this->tickFontSize; } - /*! \copydoc tickFontName */ + /** \copydoc tickFontName */ inline void setTickFontName(const QString & __value) { if (this->tickFontName != __value) { @@ -695,12 +695,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc tickFontName */ + /** \copydoc tickFontName */ inline QString getTickFontName() const { return this->tickFontName; } - /*! \copydoc tickLength */ + /** \copydoc tickLength */ inline void setTickLength(double __value) { if (this->tickLength != __value) { @@ -708,12 +708,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc tickLength */ + /** \copydoc tickLength */ inline double getTickLength() const { return this->tickLength; } - /*! \copydoc drawSystemBox */ + /** \copydoc drawSystemBox */ inline void setDrawSystemBox(bool __value) { if (this->drawSystemBox != __value) { @@ -721,12 +721,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc drawSystemBox */ + /** \copydoc drawSystemBox */ inline bool getDrawSystemBox() const { return this->drawSystemBox; } - /*! \copydoc drawZeroAxes */ + /** \copydoc drawZeroAxes */ inline void setDrawZeroAxes(bool __value) { if (this->drawZeroAxes != __value) { @@ -734,12 +734,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc drawZeroAxes */ + /** \copydoc drawZeroAxes */ inline bool getDrawZeroAxes() const { return this->drawZeroAxes; } - /*! \copydoc systemColor */ + /** \copydoc systemColor */ inline void setSystemColor(const QColor & __value) { if (this->systemColor != __value) { @@ -747,12 +747,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc systemColor */ + /** \copydoc systemColor */ inline QColor getSystemColor() const { return this->systemColor; } - /*! \copydoc systemWidth */ + /** \copydoc systemWidth */ inline void setSystemWidth(double __value) { if (this->systemWidth != __value) { @@ -760,12 +760,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc systemWidth */ + /** \copydoc systemWidth */ inline double getSystemWidth() const { return this->systemWidth; } - /*! \copydoc xZeroTick */ + /** \copydoc xZeroTick */ inline void setXZeroTick(double __value) { if (this->xZeroTick != __value) { @@ -773,12 +773,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc xZeroTick */ + /** \copydoc xZeroTick */ inline double getXZeroTick() const { return this->xZeroTick; } - /*! \copydoc yZeroTick */ + /** \copydoc yZeroTick */ inline void setYZeroTick(double __value) { if (this->yZeroTick != __value) { @@ -786,12 +786,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc yZeroTick */ + /** \copydoc yZeroTick */ inline double getYZeroTick() const { return this->yZeroTick; } - /*! \copydoc xTickDistance */ + /** \copydoc xTickDistance */ inline void setXTickDistance(double __value) { if (this->xTickDistance != __value) { @@ -799,12 +799,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc xTickDistance */ + /** \copydoc xTickDistance */ inline double getXTickDistance() const { return this->xTickDistance; } - /*! \copydoc yTickDistance */ + /** \copydoc yTickDistance */ inline void setYTickDistance(double __value) { if (this->yTickDistance != __value) { @@ -812,12 +812,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc yTickDistance */ + /** \copydoc yTickDistance */ inline double getYTickDistance() const { return this->yTickDistance; } - /*! \copydoc xAxisLabel */ + /** \copydoc xAxisLabel */ inline void setXAxisLabel(const QString & __value) { if (this->xAxisLabel != __value) { @@ -825,12 +825,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc xAxisLabel */ + /** \copydoc xAxisLabel */ inline QString getXAxisLabel() const { return this->xAxisLabel; } - /*! \copydoc yAxisLabel */ + /** \copydoc yAxisLabel */ inline void setYAxisLabel(const QString & __value) { if (this->yAxisLabel != __value) { @@ -838,12 +838,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc yAxisLabel */ + /** \copydoc yAxisLabel */ inline QString getYAxisLabel() const { return this->yAxisLabel; } - /*! \copydoc aspectRatio */ + /** \copydoc aspectRatio */ inline void setAspectRatio(double __value) { if (this->aspectRatio != __value) { @@ -851,12 +851,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc aspectRatio */ + /** \copydoc aspectRatio */ inline double getAspectRatio() const { return this->aspectRatio; } - /*! \copydoc maintainAspectRatio */ + /** \copydoc maintainAspectRatio */ inline void setMaintainAspectRatio(bool __value) { if (this->maintainAspectRatio != __value) { @@ -864,12 +864,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc maintainAspectRatio */ + /** \copydoc maintainAspectRatio */ inline bool doesMaintainAspectRatio() const { return this->maintainAspectRatio; } - /*! \copydoc xAxisLabelVisible */ + /** \copydoc xAxisLabelVisible */ inline void setXAxisLabelVisible(bool __value) { if (this->xAxisLabelVisible != __value) { @@ -877,12 +877,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc xAxisLabelVisible */ + /** \copydoc xAxisLabelVisible */ inline bool getXAxisLabelVisible() const { return this->xAxisLabelVisible; } - /*! \copydoc yAxisLabelVisible */ + /** \copydoc yAxisLabelVisible */ inline void setYAxisLabelVisible(bool __value) { if (this->yAxisLabelVisible != __value) { @@ -890,12 +890,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc yAxisLabelVisible */ + /** \copydoc yAxisLabelVisible */ inline bool getYAxisLabelVisible() const { return this->yAxisLabelVisible; } - /*! \copydoc synchronizeX */ + /** \copydoc synchronizeX */ inline void setSynchronizeX(JKQTFastPlotter* __value) { if (this->synchronizeX != __value) { @@ -903,12 +903,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc synchronizeX */ + /** \copydoc synchronizeX */ inline JKQTFastPlotter* getSynchronizeX() const { return this->synchronizeX; } - /*! \copydoc synchronizeY */ + /** \copydoc synchronizeY */ inline void setSynchronizeY(JKQTFastPlotter* __value) { if (this->synchronizeY != __value) { @@ -916,7 +916,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFastPlotter : public QGLWidget { redrawPlot(); } } - /*! \copydoc synchronizeY */ + /** \copydoc synchronizeY */ inline JKQTFastPlotter* getSynchronizeY() const { return this->synchronizeY; @@ -1152,35 +1152,35 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPLinePlot: public JKQTFPPlot { return N; } - /*! \copydoc x */ + /** \copydoc x */ inline double* getX() const { return this->x; } - /*! \copydoc y */ + /** \copydoc y */ inline double* getY() const { return this->y; } - /*! \copydoc yerr */ + /** \copydoc yerr */ inline double* getYerr() const { return this->yerr; } - /*! \copydoc xv */ + /** \copydoc xv */ inline QVector* getXv() const { return this->xv; } - /*! \copydoc yv */ + /** \copydoc yv */ inline QVector* getYv() const { return this->yv; } - /*! \copydoc yerrv */ + /** \copydoc yerrv */ inline QVector* getYerrv() const { return this->yerrv; } - /*! \copydoc datatype */ + /** \copydoc datatype */ inline DataType getDatatype() const { return this->datatype; } - /*! \copydoc color */ + /** \copydoc color */ inline void setColor(const QColor & __value) { if (this->color != __value) { @@ -1188,12 +1188,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPLinePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc color */ + /** \copydoc color */ inline QColor getColor() const { return this->color; } - /*! \copydoc style */ + /** \copydoc style */ inline void setStyle(Qt::PenStyle __value) { if (this->style != __value) { @@ -1201,12 +1201,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPLinePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc style */ + /** \copydoc style */ inline Qt::PenStyle getStyle() const { return this->style; } - /*! \copydoc width */ + /** \copydoc width */ inline void setWidth(double __value) { if (this->width != __value) { @@ -1214,12 +1214,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPLinePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc width */ + /** \copydoc width */ inline double getWidth() const { return this->width; } - /*! \copydoc errorColor */ + /** \copydoc errorColor */ inline void setErrorLineColor(const QColor & __value) { if (this->errorColor != __value) { @@ -1227,12 +1227,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPLinePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc errorColor */ + /** \copydoc errorColor */ inline QColor getErrorLineColor() const { return this->errorColor; } - /*! \copydoc errorStyle */ + /** \copydoc errorStyle */ inline void setErrorLineStyle(Qt::PenStyle __value) { if (this->errorStyle != __value) { @@ -1240,12 +1240,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPLinePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc errorStyle */ + /** \copydoc errorStyle */ inline Qt::PenStyle getErrorLineStyle() const { return this->errorStyle; } - /*! \copydoc errorWidth */ + /** \copydoc errorWidth */ inline void setErrorLineWidth(double __value) { if (this->errorWidth != __value) { @@ -1253,7 +1253,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPLinePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc errorWidth */ + /** \copydoc errorWidth */ inline double getErrorLineWidth() const { return this->errorWidth; @@ -1297,7 +1297,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPVCrossPlot: public JKQTFPLinePlot { /** \brief draw the graph */ virtual void drawGraph(QPainter& painter) override; - /*! \copydoc crossWidth */ + /** \copydoc crossWidth */ inline void setCrossWidth(double __value) { if (this->crossWidth != __value) { @@ -1305,7 +1305,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPVCrossPlot: public JKQTFPLinePlot { replot(); } } - /*! \copydoc crossWidth */ + /** \copydoc crossWidth */ inline double getCrossWidth() const { return this->crossWidth; @@ -1393,7 +1393,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPXRangePlot: public JKQTFPPlot { /** \brief draw the graph */ virtual void drawGraph(QPainter& painter) override; - /*! \copydoc color */ + /** \copydoc color */ inline void setColor(const QColor & __value) { if (this->color != __value) { @@ -1401,12 +1401,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPXRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc color */ + /** \copydoc color */ inline QColor getColor() const { return this->color; } - /*! \copydoc fillColor */ + /** \copydoc fillColor */ inline void setFillColor(const QColor & __value) { if (this->fillColor != __value) { @@ -1414,12 +1414,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPXRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc fillColor */ + /** \copydoc fillColor */ inline QColor getFillColor() const { return this->fillColor; } - /*! \copydoc fillStyle */ + /** \copydoc fillStyle */ inline void setFillStyle(Qt::BrushStyle __value) { if (this->fillStyle != __value) { @@ -1427,12 +1427,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPXRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc fillStyle */ + /** \copydoc fillStyle */ inline Qt::BrushStyle getFillStyle() const { return this->fillStyle; } - /*! \copydoc style */ + /** \copydoc style */ inline void setStyle(Qt::PenStyle __value) { if (this->style != __value) { @@ -1440,12 +1440,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPXRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc style */ + /** \copydoc style */ inline Qt::PenStyle getStyle() const { return this->style; } - /*! \copydoc width */ + /** \copydoc width */ inline void setWidth(double __value) { if (this->width != __value) { @@ -1453,24 +1453,24 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPXRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc width */ + /** \copydoc width */ inline double getWidth() const { return this->width; } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline double getXmin() const { return this->xmin; } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline double getXmax() const { return this->xmax; } - /*! \copydoc centerline */ + /** \copydoc centerline */ inline double getCenterline() const { return this->centerline; } - /*! \copydoc showCenterline */ + /** \copydoc showCenterline */ inline void setShowCenterline(bool __value) { if (this->showCenterline != __value) { @@ -1478,7 +1478,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPXRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc showCenterline */ + /** \copydoc showCenterline */ inline bool getShowCenterline() const { return this->showCenterline; @@ -1557,7 +1557,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPYRangePlot: public JKQTFPPlot { /** \brief draw the graph */ virtual void drawGraph(QPainter& painter) override; - /*! \copydoc color */ + /** \copydoc color */ inline void setColor(const QColor & __value) { if (this->color != __value) { @@ -1565,12 +1565,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPYRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc color */ + /** \copydoc color */ inline QColor getColor() const { return this->color; } - /*! \copydoc fillColor */ + /** \copydoc fillColor */ inline void setFillColor(const QColor & __value) { if (this->fillColor != __value) { @@ -1578,12 +1578,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPYRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc fillColor */ + /** \copydoc fillColor */ inline QColor getFillColor() const { return this->fillColor; } - /*! \copydoc fillStyle */ + /** \copydoc fillStyle */ inline void setFillStyle(Qt::BrushStyle __value) { if (this->fillStyle != __value) { @@ -1591,12 +1591,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPYRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc fillStyle */ + /** \copydoc fillStyle */ inline Qt::BrushStyle getFillStyle() const { return this->fillStyle; } - /*! \copydoc style */ + /** \copydoc style */ inline void setStyle(Qt::PenStyle __value) { if (this->style != __value) { @@ -1604,12 +1604,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPYRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc style */ + /** \copydoc style */ inline Qt::PenStyle getStyle() const { return this->style; } - /*! \copydoc width */ + /** \copydoc width */ inline void setWidth(double __value) { if (this->width != __value) { @@ -1617,24 +1617,24 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPYRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc width */ + /** \copydoc width */ inline double getWidth() const { return this->width; } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline double getYmin() const { return this->ymin; } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline double getYmax() const { return this->ymax; } - /*! \copydoc centerline */ + /** \copydoc centerline */ inline double getCenterline() const { return this->centerline; } - /*! \copydoc showCenterline */ + /** \copydoc showCenterline */ inline void setShowCenterline(bool __value) { if (this->showCenterline != __value) { @@ -1642,7 +1642,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPYRangePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc showCenterline */ + /** \copydoc showCenterline */ inline bool getShowCenterline() const { return this->showCenterline; @@ -1709,7 +1709,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQImagePlot: public JKQTFPPlot { /** \brief draw the graph */ virtual void drawGraph(QPainter& painter) override; - /*! \copydoc image */ + /** \copydoc image */ inline void setImage(QImage* __value) { if (this->image != __value) { @@ -1717,12 +1717,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQImagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc image */ + /** \copydoc image */ inline QImage* getImage() const { return this->image; } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline void setXmin(double __value) { if (this->xmin != __value) { @@ -1730,12 +1730,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQImagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline double getXmin() const { return this->xmin; } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline void setXmax(double __value) { if (this->xmax != __value) { @@ -1743,12 +1743,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQImagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline double getXmax() const { return this->xmax; } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline void setYmin(double __value) { if (this->ymin != __value) { @@ -1756,12 +1756,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQImagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline double getYmin() const { return this->ymin; } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline void setYmax(double __value) { if (this->ymax != __value) { @@ -1769,7 +1769,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQImagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline double getYmax() const { return this->ymax; @@ -2413,7 +2413,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { - /*! \copydoc image */ + /** \copydoc image */ inline void setImage(void* __value) { if (this->image != __value) { @@ -2421,12 +2421,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc image */ + /** \copydoc image */ inline void* getImage() const { return this->image; } - /*! \copydoc imageFormat */ + /** \copydoc imageFormat */ inline void setImageFormat(const JKQTFPImageFormat & __value) { if (this->imageFormat != __value) { @@ -2434,12 +2434,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc imageFormat */ + /** \copydoc imageFormat */ inline JKQTFPImageFormat getImageFormat() const { return this->imageFormat; } - /*! \copydoc width */ + /** \copydoc width */ inline void setWidth(int __value) { if (this->width != __value) { @@ -2447,12 +2447,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc width */ + /** \copydoc width */ inline int getWidth() const { return this->width; } - /*! \copydoc height */ + /** \copydoc height */ inline void setHeight(int __value) { if (this->height != __value) { @@ -2460,12 +2460,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc height */ + /** \copydoc height */ inline int getHeight() const { return this->height; } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline void setXmin(double __value) { if (this->xmin != __value) { @@ -2473,12 +2473,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline double getXmin() const { return this->xmin; } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline void setXmax(double __value) { if (this->xmax != __value) { @@ -2486,12 +2486,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline double getXmax() const { return this->xmax; } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline void setYmin(double __value) { if (this->ymin != __value) { @@ -2499,12 +2499,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline double getYmin() const { return this->ymin; } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline void setYmax(double __value) { if (this->ymax != __value) { @@ -2512,12 +2512,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline double getYmax() const { return this->ymax; } - /*! \copydoc drawColorBar */ + /** \copydoc drawColorBar */ inline void setDrawColorBar(bool __value) { if (this->drawColorBar != __value) { @@ -2525,12 +2525,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc drawColorBar */ + /** \copydoc drawColorBar */ inline bool getDrawColorBar() const { return this->drawColorBar; } - /*! \copydoc colorBarWidth */ + /** \copydoc colorBarWidth */ inline void setColorBarWidth(int __value) { if (this->colorBarWidth != __value) { @@ -2538,24 +2538,24 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimagePlot: public JKQTFPPlot { replot(); } } - /*! \copydoc colorBarWidth */ + /** \copydoc colorBarWidth */ inline int getColorBarWidth() const { return this->colorBarWidth; } - /*! \copydoc rotation */ + /** \copydoc rotation */ inline int getRotation() const { return this->rotation; } - /*! \copydoc palette */ + /** \copydoc palette */ inline JKQTFPColorPalette getPalette() const { return this->palette; } - /*! \copydoc colorMin */ + /** \copydoc colorMin */ inline double getColorMin() const { return this->colorMin; } - /*! \copydoc colorMax */ + /** \copydoc colorMax */ inline double getColorMax() const { return this->colorMax; } @@ -2811,9 +2811,9 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc imageRed */ + /** \copydoc imageRed */ inline void* getImageRed () const { return this->imageRed; } - /*! \copydoc imageFormatRed */ + /** \copydoc imageFormatRed */ inline JKQTFPImageFormat getImageFormatRed () const { return this->imageFormatRed; } /*! \brief sets the properties imageGreen and imageFormatGreen to the specified \a __value and \a __value2. @@ -2834,9 +2834,9 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc imageGreen */ + /** \copydoc imageGreen */ inline void* getImageGreen () const { return this->imageGreen; } - /*! \copydoc imageFormatGreen */ + /** \copydoc imageFormatGreen */ inline JKQTFPImageFormat getImageFormatGreen () const { return this->imageFormatGreen; } /*! \brief sets the properties imageBlue and imageFormatBlue to the specified \a __value and \a __value2. @@ -2857,11 +2857,11 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc imageBlue */ + /** \copydoc imageBlue */ inline void* getImageBlue () const { return this->imageBlue; } - /*! \copydoc imageFormatBlue */ + /** \copydoc imageFormatBlue */ inline JKQTFPImageFormat getImageFormatBlue () const { return this->imageFormatBlue; } - /*! \copydoc width */ + /** \copydoc width */ inline void setWidth(int __value) { if (this->width != __value) { @@ -2869,12 +2869,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc width */ + /** \copydoc width */ inline int getWidth() const { return this->width; } - /*! \copydoc height */ + /** \copydoc height */ inline void setHeight(int __value) { if (this->height != __value) { @@ -2882,12 +2882,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc height */ + /** \copydoc height */ inline int getHeight() const { return this->height; } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline void setXmin(double __value) { if (this->xmin != __value) { @@ -2895,12 +2895,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline double getXmin() const { return this->xmin; } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline void setXmax(double __value) { if (this->xmax != __value) { @@ -2908,12 +2908,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline double getXmax() const { return this->xmax; } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline void setYmin(double __value) { if (this->ymin != __value) { @@ -2921,12 +2921,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline double getYmin() const { return this->ymin; } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline void setYmax(double __value) { if (this->ymax != __value) { @@ -2934,36 +2934,36 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPRGBImageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline double getYmax() const { return this->ymax; } - /*! \copydoc rotation */ + /** \copydoc rotation */ inline int getRotation() const { return this->rotation; } - /*! \copydoc colorMinRed */ + /** \copydoc colorMinRed */ inline double getColorMinRed() const { return this->colorMinRed; } - /*! \copydoc colorMaxRed */ + /** \copydoc colorMaxRed */ inline double getColorMaxRed() const { return this->colorMaxRed; } - /*! \copydoc colorMinGreen */ + /** \copydoc colorMinGreen */ inline double getColorMinGreen() const { return this->colorMinGreen; } - /*! \copydoc colorMaxGreen */ + /** \copydoc colorMaxGreen */ inline double getColorMaxGreen() const { return this->colorMaxGreen; } - /*! \copydoc colorMinBlue */ + /** \copydoc colorMinBlue */ inline double getColorMinBlue() const { return this->colorMinBlue; } - /*! \copydoc colorMaxBlue */ + /** \copydoc colorMaxBlue */ inline double getColorMaxBlue() const { return this->colorMaxBlue; } @@ -3149,23 +3149,23 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimageOverlayPlot: public JKQTFPPlot { replot(); } - /*! \copydoc image */ + /** \copydoc image */ inline bool* getImage() const { return this->image; } - /*! \copydoc rotation */ + /** \copydoc rotation */ inline int getRotation() const { return this->rotation; } - /*! \copydoc width */ + /** \copydoc width */ inline int getWidth() const { return this->width; } - /*! \copydoc height */ + /** \copydoc height */ inline int getHeight() const { return this->height; } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline void setXmin(double __value) { if (this->xmin != __value) { @@ -3173,12 +3173,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc xmin */ + /** \copydoc xmin */ inline double getXmin() const { return this->xmin; } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline void setXmax(double __value) { if (this->xmax != __value) { @@ -3186,12 +3186,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc xmax */ + /** \copydoc xmax */ inline double getXmax() const { return this->xmax; } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline void setYmin(double __value) { if (this->ymin != __value) { @@ -3199,12 +3199,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc ymin */ + /** \copydoc ymin */ inline double getYmin() const { return this->ymin; } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline void setYmax(double __value) { if (this->ymax != __value) { @@ -3212,12 +3212,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc ymax */ + /** \copydoc ymax */ inline double getYmax() const { return this->ymax; } - /*! \copydoc showAsSymbols */ + /** \copydoc showAsSymbols */ inline void setShowAsSymbols(bool __value) { if (this->showAsSymbols != __value) { @@ -3225,12 +3225,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPimageOverlayPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc showAsSymbols */ + /** \copydoc showAsSymbols */ inline bool getShowAsSymbols() const { return this->showAsSymbols; } - /*! \copydoc color */ + /** \copydoc color */ inline QColor getColor() const { return this->color; } @@ -3288,7 +3288,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQScaleBarXPlot: public JKQTFPPlot { /** \brief draw the graph */ virtual void drawGraph(QPainter& painter) override; - /*! \copydoc width */ + /** \copydoc width */ inline void setWidth(double __value) { if (this->width != __value) { @@ -3296,12 +3296,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQScaleBarXPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc width */ + /** \copydoc width */ inline double getWidth() const { return this->width; } - /*! \copydoc lineWidth */ + /** \copydoc lineWidth */ inline void setLineWidth(double __value) { if (this->lineWidth != __value) { @@ -3309,12 +3309,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQScaleBarXPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc lineWidth */ + /** \copydoc lineWidth */ inline double getLineWidth() const { return this->lineWidth; } - /*! \copydoc color */ + /** \copydoc color */ inline void setColor(const QColor & __value) { if (this->color != __value) { @@ -3322,12 +3322,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQScaleBarXPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc color */ + /** \copydoc color */ inline QColor getColor() const { return this->color; } - /*! \copydoc label */ + /** \copydoc label */ inline void setLabel(const QString & __value) { if (this->label != __value) { @@ -3335,12 +3335,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQScaleBarXPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc label */ + /** \copydoc label */ inline QString getLabel() const { return this->label; } - /*! \copydoc font */ + /** \copydoc font */ inline void setFont(const QFont & __value) { if (this->font != __value) { @@ -3348,12 +3348,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQScaleBarXPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc font */ + /** \copydoc font */ inline QFont getFont() const { return this->font; } - /*! \copydoc position */ + /** \copydoc position */ inline void setPosition(const Position & __value) { if (this->position != __value) { @@ -3361,7 +3361,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQScaleBarXPlot: public JKQTFPPlot { replot(); } } - /*! \copydoc position */ + /** \copydoc position */ inline Position getPosition() const { return this->position; @@ -3401,7 +3401,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQOverlayLinearGridPlot: public JKQTFPPlot /** \brief draw the graph */ virtual void drawGraph(QPainter& painter) override; - /*! \copydoc width */ + /** \copydoc width */ inline void setWidth(double __value) { if (this->width != __value) { @@ -3409,12 +3409,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQOverlayLinearGridPlot: public JKQTFPPlot replot(); } } - /*! \copydoc width */ + /** \copydoc width */ inline double getWidth() const { return this->width; } - /*! \copydoc lineWidth */ + /** \copydoc lineWidth */ inline void setLineWidth(double __value) { if (this->lineWidth != __value) { @@ -3422,12 +3422,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQOverlayLinearGridPlot: public JKQTFPPlot replot(); } } - /*! \copydoc lineWidth */ + /** \copydoc lineWidth */ inline double getLineWidth() const { return this->lineWidth; } - /*! \copydoc color */ + /** \copydoc color */ inline void setColor(const QColor & __value) { if (this->color != __value) { @@ -3435,12 +3435,12 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQOverlayLinearGridPlot: public JKQTFPPlot replot(); } } - /*! \copydoc color */ + /** \copydoc color */ inline QColor getColor() const { return this->color; } - /*! \copydoc style */ + /** \copydoc style */ inline void setStyle(Qt::PenStyle __value) { if (this->style != __value) { @@ -3448,7 +3448,7 @@ class JKQTFASTPLOTTER_LIB_EXPORT JKQTFPQOverlayLinearGridPlot: public JKQTFPPlot replot(); } } - /*! \copydoc style */ + /** \copydoc style */ inline Qt::PenStyle getStyle() const { return this->style; diff --git a/lib/jkqtmathtext/jkqtmathtext.h b/lib/jkqtmathtext/jkqtmathtext.h index bb212c8436..c6da1fd949 100644 --- a/lib/jkqtmathtext/jkqtmathtext.h +++ b/lib/jkqtmathtext/jkqtmathtext.h @@ -282,13 +282,13 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { }; - /*! \copydoc fontColor */ + /** \copydoc fontColor */ void setFontColor(const QColor & __value); - /*! \copydoc fontColor */ + /** \copydoc fontColor */ QColor getFontColor() const; - /*! \copydoc fontSize */ + /** \copydoc fontSize */ void setFontSize(double __value); - /*! \copydoc fontSize */ + /** \copydoc fontSize */ double getFontSize() const; /** \brief add a font pair to the table with font replacements * @@ -329,82 +329,82 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { \see setFontRoman(), useXITS(), useSTIX() for more information */ void setFontRomanOrSpecial(const QString & fontName); - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEroman */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEroman */ void setFontRoman(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for text in the logical font MTEroman */ + /** \brief retrieves the font to be used for text in the logical font MTEroman */ QString getFontRoman() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEsans */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEsans */ void setFontSans(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for text in the logical font MTEsans */ + /** \brief retrieves the font to be used for text in the logical font MTEsans */ QString getFontSans() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEtypewriter */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEtypewriter */ void setFontTypewriter(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for text in the logical font MTEtypewriter */ + /** \brief retrieves the font to be used for text in the logical font MTEtypewriter */ QString getFontTypewriter() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEscript */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEscript */ void setFontScript(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for text in the logical font MTEscript */ + /** \brief retrieves the font to be used for text in the logical font MTEscript */ QString getFontScript() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEfraktur */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEfraktur */ void setFontFraktur(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for text in the logical font MTEfraktur */ + /** \brief retrieves the font to be used for text in the logical font MTEfraktur */ QString getFontFraktur() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEcaligraphic */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEcaligraphic */ void setFontCaligraphic(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for text in the logical font MTEcaligraphic */ + /** \brief retrieves the font to be used for text in the logical font MTEcaligraphic */ QString getFontCaligraphic() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEblackboard */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEblackboard */ void setFontBlackboard(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief blackboard font is simulated by using roman with outlines only */ + /** \brief blackboard font is simulated by using roman with outlines only */ void setFontBlackboardSimulated(bool doSimulate); - /*! \brief is blackboard font simulated by using roman with outlines only */ + /** \brief is blackboard font simulated by using roman with outlines only */ bool isFontBlackboardSimulated() const; - /*! \brief retrieves the font to be used for text in the logical font MTEblackboard */ + /** \brief retrieves the font to be used for text in the logical font MTEblackboard */ QString getFontBlackboard() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for greek letters in the logical font \a font */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for greek letters in the logical font \a font */ void setSymbolfontGreek(MTenvironmentFont font, const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for integrals in all logical fonts */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for integrals in all logical fonts */ void setSymbolfontGreek(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for greek letters in the logical font \a font */ + /** \brief retrieves the font to be used for greek letters in the logical font \a font */ QString getSymbolfontGreek(MTenvironmentFont font) const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for symbols in the logical font \a font */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for symbols in the logical font \a font */ void setSymbolfontSymbol(MTenvironmentFont font, const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for integrals in all logical fonts */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for integrals in all logical fonts */ void setSymbolfontSymbol(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for symbols in the logical font \a font */ + /** \brief retrieves the font to be used for symbols in the logical font \a font */ QString getSymbolfontSymbol(MTenvironmentFont font) const; - /*! \brief retrieves the encoding used for the symbol font to be used for symbols in the logical font \a font */ + /** \brief retrieves the encoding used for the symbol font to be used for symbols in the logical font \a font */ MTfontEncoding getSymbolfontEncodingSymbol(MTenvironmentFont font) const; - /*! \brief retrieves the encoding used for the greek letter font to be used for symbols in the logical font \a font */ + /** \brief retrieves the encoding used for the greek letter font to be used for symbols in the logical font \a font */ MTfontEncoding getSymbolfontEncodingGreek(MTenvironmentFont font) const; - /*! \brief retrieves the encoding used for the script font */ + /** \brief retrieves the encoding used for the script font */ MTfontEncoding getFontEncodingScript() const; - /*! \brief retrieves the encoding used for the Fraktur font */ + /** \brief retrieves the encoding used for the Fraktur font */ MTfontEncoding getFontEncodingFraktur() const; - /*! \brief retrieves the encoding used for the typewriter font */ + /** \brief retrieves the encoding used for the typewriter font */ MTfontEncoding getFontEncodingTypewriter() const; - /*! \brief retrieves the encoding used for the sans-serif font */ + /** \brief retrieves the encoding used for the sans-serif font */ MTfontEncoding getFontEncodingSans() const; - /*! \brief retrieves the encoding used for the roman font */ + /** \brief retrieves the encoding used for the roman font */ MTfontEncoding getFontEncodingRoman() const; - /*! \brief retrieves the encoding used for the blackboard font */ + /** \brief retrieves the encoding used for the blackboard font */ MTfontEncoding getFontEncodingBlackboard() const; - /*! \brief retrieves the encoding used for the caligraphic font */ + /** \brief retrieves the encoding used for the caligraphic font */ JKQTMathText::MTfontEncoding getFontEncodingCaligraphic() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEmathRoman */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEmathRoman */ void setFontMathRoman(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for text in the logical font MTEroman */ + /** \brief retrieves the font to be used for text in the logical font MTEroman */ QString getFontMathRoman() const; - /*! \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEmathSans */ + /** \brief set the font \a fontName and it's encoding \a encoding to be used for text in the logical font MTEmathSans */ void setFontMathSans(const QString & fontName, MTfontEncoding encoding=MTfontEncoding::MTFEStandard); - /*! \brief retrieves the font to be used for text in the logical font MTEsans */ + /** \brief retrieves the font to be used for text in the logical font MTEsans */ QString getFontMathSans() const; - /*! \brief retrieves the encoding used for the math-mode sans-serif font */ + /** \brief retrieves the encoding used for the math-mode sans-serif font */ MTfontEncoding getFontEncodingMathSans() const; - /*! \brief retrieves the encoding used for the math-mode roman font */ + /** \brief retrieves the encoding used for the math-mode roman font */ MTfontEncoding getFontEncodingMathRoman() const; /** \brief configures the class to use the STIX fonts in mathmode @@ -452,71 +452,71 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { - /*! \copydoc brace_factor */ + /** \copydoc brace_factor */ void setBraceFactor(double __value); - /*! \copydoc brace_factor */ + /** \copydoc brace_factor */ double getBraceFactor() const; - /*! \copydoc subsuper_size_factor */ + /** \copydoc subsuper_size_factor */ void setSubsuperSizeFactor(double __value); - /*! \copydoc subsuper_size_factor */ + /** \copydoc subsuper_size_factor */ double getSubsuperSizeFactor() const; - /*! \copydoc italic_correction_factor */ + /** \copydoc italic_correction_factor */ void setItalicCorrectionFactor(double __value); - /*! \copydoc italic_correction_factor */ + /** \copydoc italic_correction_factor */ double getItalicCorrectionFactor() const; - /*! \copydoc operatorsubsuper_size_factor */ + /** \copydoc operatorsubsuper_size_factor */ void setOperatorsubsuperSizeFactor(double __value); - /*! \copydoc operatorsubsuper_size_factor */ + /** \copydoc operatorsubsuper_size_factor */ double getOperatorsubsuperSizeFactor() const; - /*! \copydoc mathoperator_width_factor */ + /** \copydoc mathoperator_width_factor */ void setMathoperatorWidthFactor(double __value); - /*! \copydoc mathoperator_width_factor */ + /** \copydoc mathoperator_width_factor */ double getMathoperatorWidthFactor() const; - /*! \copydoc super_shift_factor */ + /** \copydoc super_shift_factor */ void setSuperShiftFactor(double __value); - /*! \copydoc super_shift_factor */ + /** \copydoc super_shift_factor */ double getSuperShiftFactor() const; - /*! \copydoc sub_shift_factor */ + /** \copydoc sub_shift_factor */ void setSubShiftFactor(double __value); - /*! \copydoc sub_shift_factor */ + /** \copydoc sub_shift_factor */ double getSubShiftFactor() const; - /*! \copydoc brace_shrink_factor */ + /** \copydoc brace_shrink_factor */ void setBraceShrinkFactor(double __value); - /*! \copydoc brace_shrink_factor */ + /** \copydoc brace_shrink_factor */ double getBraceShrinkFactor() const; - /*! \copydoc underbrace_factor */ + /** \copydoc underbrace_factor */ void setUnderbraceFactor(double __value); - /*! \copydoc underbrace_factor */ + /** \copydoc underbrace_factor */ double getUnderbraceFactor() const; - /*! \copydoc undersetFactor */ + /** \copydoc undersetFactor */ void setUndersetFactor(double __value); - /*! \copydoc undersetFactor */ + /** \copydoc undersetFactor */ double getUndersetFactor() const; - /*! \copydoc frac_factor */ + /** \copydoc frac_factor */ void setFracFactor(double __value); - /*! \copydoc frac_factor */ + /** \copydoc frac_factor */ double getFracFactor() const; - /*! \copydoc frac_shift_factor */ + /** \copydoc frac_shift_factor */ void setFracShiftFactor(double __value); - /*! \copydoc frac_shift_factor */ + /** \copydoc frac_shift_factor */ double getFracShiftFactor() const; - /*! \copydoc brace_y_shift_factor */ + /** \copydoc brace_y_shift_factor */ void setBraceYShiftFactor(double __value); - /*! \copydoc brace_y_shift_factor */ + /** \copydoc brace_y_shift_factor */ double getBraceYShiftFactor() const; - /*! \copydoc decoration_height_factor */ + /** \copydoc decoration_height_factor */ void setDecorationHeightFactor(double __value); - /*! \copydoc decoration_height_factor */ + /** \copydoc decoration_height_factor */ double getDecorationHeightFactor() const; - /*! \copydoc expensiveRendering */ + /** \copydoc expensiveRendering */ void setExpensiveRendering(bool __value); - /*! \copydoc expensiveRendering */ + /** \copydoc expensiveRendering */ bool getExpensiveRendering() const; - /*! \copydoc useUnparsed */ + /** \copydoc useUnparsed */ void setUseUnparsed(bool __value); - /*! \copydoc useUnparsed */ + /** \copydoc useUnparsed */ bool isUsingUnparsed() const; - /*! \copydoc error_list */ + /** \copydoc error_list */ QStringList getErrorList() const; protected: @@ -659,7 +659,7 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { virtual double draw(QPainter& painter, double x, double y, MTenvironment currentEv, const MTnodeSize* prevNodeSize=nullptr) override; /** \copydoc MTnode::toHtml() */ virtual bool toHtml(QString& html, JKQTMathText::MTenvironment currentEv, JKQTMathText::MTenvironment defaultEv) override; - /*! \copydoc text */ + /** \copydoc text */ QString getText() const; virtual QString getTypeName() const override ; protected: @@ -709,7 +709,7 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { virtual double draw(QPainter& painter, double x, double y, MTenvironment currentEv, const MTnodeSize* prevNodeSize=nullptr) override; /** \copydoc MTnode::toHtml() */ virtual bool toHtml(QString& html, JKQTMathText::MTenvironment currentEv, JKQTMathText::MTenvironment defaultEv) override; - /*! \copydoc symbolName */ + /** \copydoc symbolName */ QString getSymbolName() const; QString getSymbolfontName() const; bool getAddWhitespace() const; @@ -772,7 +772,7 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { virtual bool toHtml(QString& html, JKQTMathText::MTenvironment currentEv, JKQTMathText::MTenvironment defaultEv) override; /** \copydoc MTnode::setDrawBoxes() */ virtual void setDrawBoxes(bool draw) override; - /*! \copydoc nodes */ + /** \copydoc nodes */ QList getNodes() const; protected: /** \copydoc MTnode::getSizeInternal() */ @@ -797,11 +797,11 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { virtual bool toHtml(QString& html, JKQTMathText::MTenvironment currentEv, JKQTMathText::MTenvironment defaultEv) override; /** \copydoc MTnode::setDrawBoxes() */ virtual void setDrawBoxes(bool draw) override; - /*! \brief returns the child node */ + /** \brief returns the child node */ MTnode* getChild() const; - /*! \copydoc name */ + /** \copydoc name */ QString getName() const; - /*! \copydoc parameters */ + /** \copydoc parameters */ QStringList getParameters() const; protected: /** \copydoc MTnode::getSizeInternal() */ @@ -827,7 +827,7 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { /** \copydoc MTnode::draw() */ virtual double draw(QPainter& painter, double x, double y, MTenvironment currentEv, const MTnodeSize* prevNodeSize=nullptr) override; /** \copydoc MTnode::getTypeName() */ - virtual QString getTypeName() const override; /*! \brief returns the child node */ + virtual QString getTypeName() const override; /** \brief returns the child node */ MTnode *getChild() const; /** \copydoc MTnode::toHtml() */ virtual bool toHtml(QString& html, JKQTMathText::MTenvironment currentEv, JKQTMathText::MTenvironment defaultEv) override; @@ -852,7 +852,7 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { virtual ~MTsuperscriptNode() override; /** \copydoc MTnode::draw() */ virtual double draw(QPainter& painter, double x, double y, MTenvironment currentEv, const MTnodeSize* prevNodeSize=nullptr) override; - /*! \brief returns the child node */ + /** \brief returns the child node */ MTnode* getChild() const; /** \copydoc MTnode::getTypeName() */ virtual QString getTypeName() const override; @@ -881,19 +881,19 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { virtual void setDrawBoxes(bool draw) override; /** \copydoc MTnode::getTypeName() */ virtual QString getTypeName() const override; - /*! \brief returns the child node */ + /** \brief returns the child node */ inline MTnode* getChild() const { return this->child; } - /*! \copydoc openbrace */ + /** \copydoc openbrace */ inline QString getOpenbrace() const { return this->openbrace; } - /*! \copydoc closebrace */ + /** \copydoc closebrace */ inline QString getClosebrace() const { return this->closebrace; } - /*! \copydoc showRightBrace */ + /** \copydoc showRightBrace */ inline bool getShowRightBrace() const { return this->showRightBrace; } @@ -923,9 +923,9 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { /** \copydoc MTnode::setDrawBoxes() */ virtual void setDrawBoxes(bool draw) override; virtual QString getTypeName() const override ; - /*! \brief returns the child node */ + /** \brief returns the child node */ MTnode *getChild() const; - /*! \copydoc degree */ + /** \copydoc degree */ int getDegree() const; protected: /** \copydoc MTnode::getSizeInternal() */ @@ -963,11 +963,11 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { virtual bool toHtml(QString& html, JKQTMathText::MTenvironment currentEv, JKQTMathText::MTenvironment defaultEv) override; /** \copydoc MTnode::setDrawBoxes() */ virtual void setDrawBoxes(bool draw) override; - /*! \brief returns the 1st child node */ + /** \brief returns the 1st child node */ MTnode* getChild1() const; - /*! \brief returns the 2nd child node */ + /** \brief returns the 2nd child node */ MTnode* getChild2() const; - /*! \copydoc mode */ + /** \copydoc mode */ MTfracMode getMode() const; protected: /** \copydoc MTnode::getSizeInternal() */ @@ -988,11 +988,11 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { virtual QString getTypeName() const override; virtual double draw(QPainter& painter, double x, double y, MTenvironment currentEv, const MTnodeSize* prevNodeSize=nullptr) override; virtual bool toHtml(QString& html, JKQTMathText::MTenvironment currentEv, JKQTMathText::MTenvironment defaultEv) override; - /*! \brief returns the child nodes */ + /** \brief returns the child nodes */ QVector > getChildren() const; - /*! \copydoc columns */ + /** \copydoc columns */ int getColumns() const; - /*! \copydoc lines */ + /** \copydoc lines */ int getLines() const; protected: /** \copydoc MTnode::getSizeInternal() */ @@ -1034,9 +1034,9 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { /** \copydoc MTnode::setDrawBoxes() */ virtual void setDrawBoxes(bool draw) override; virtual QString getTypeName() const override ; - /*! \brief returns the child node */ + /** \brief returns the child node */ MTnode* getChild() const; - /*! \copydoc decoration */ + /** \copydoc decoration */ MTdecoration getDecoration() const; protected: /** \copydoc MTnode::getSizeInternal() */ @@ -1165,7 +1165,7 @@ class JKQTMATHTEXT_LIB_EXPORT JKQTMathText : public QObject { public: - /*! \copydoc parsedNode */ + /** \copydoc parsedNode */ MTnode *getParsedNode() const; struct JKQTMATHTEXT_LIB_EXPORT tbrData { diff --git a/lib/jkqtplotter/graphs/jkqtpbarchartbase.h b/lib/jkqtplotter/graphs/jkqtpbarchartbase.h index 59a30eaa72..4a54b48dca 100644 --- a/lib/jkqtplotter/graphs/jkqtpbarchartbase.h +++ b/lib/jkqtplotter/graphs/jkqtpbarchartbase.h @@ -69,9 +69,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarGraphBase: public JKQTPXYBaselineGraph, pub - /*! \copydoc shift */ + /** \copydoc shift */ double getShift() const; - /*! \copydoc width */ + /** \copydoc width */ double getWidth() const; /** \brief sets the fill color and the color together, where fillColor is set to \a fill and the line-color is set to \c fill.darker(colorDarker) @@ -98,9 +98,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarGraphBase: public JKQTPXYBaselineGraph, pub /** \brief equivalent to \c autoscaleBarWidthAndShift(groupWidth,1); */ void autoscaleBarWidthAndShiftSeparatedGroups(double groupWidth=0.75); - /*! \copydoc shift */ + /** \copydoc shift */ void setShift(double __value); - /*! \copydoc width */ + /** \copydoc width */ void setWidth(double __value); diff --git a/lib/jkqtplotter/graphs/jkqtpboxplotbase.h b/lib/jkqtplotter/graphs/jkqtpboxplotbase.h index 2eafec90b1..2b1cf12397 100644 --- a/lib/jkqtplotter/graphs/jkqtpboxplotbase.h +++ b/lib/jkqtplotter/graphs/jkqtpboxplotbase.h @@ -69,72 +69,72 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotGraphBase: public JKQTPGraph, public JK /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int c) const override; - /*! \copydoc sortData */ + /** \copydoc sortData */ DataSortOrder getDataSortOrder() const; - /*! \copydoc posColumn */ + /** \copydoc posColumn */ int getPositionColumn() const; - /*! \copydoc medianColumn */ + /** \copydoc medianColumn */ int getMedianColumn() const; - /*! \copydoc meanColumn */ + /** \copydoc meanColumn */ int getMeanColumn() const; - /*! \copydoc minColumn */ + /** \copydoc minColumn */ int getMinColumn() const; - /*! \copydoc maxColumn */ + /** \copydoc maxColumn */ int getMaxColumn() const; - /*! \copydoc percentile25Column */ + /** \copydoc percentile25Column */ int getPercentile25Column() const; - /*! \copydoc percentile75Column */ + /** \copydoc percentile75Column */ int getPercentile75Column() const; - /*! \copydoc medianConfidenceColumn */ + /** \copydoc medianConfidenceColumn */ int getMedianConfidenceColumn() const; - /*! \copydoc boxWidthRelative */ + /** \copydoc boxWidthRelative */ double getBoxWidthRelative() const; - /*! \copydoc useRelativeBoxWidth */ + /** \copydoc useRelativeBoxWidth */ bool getUseRelativeBoxWidth() const; public slots: - /*! \brief set the color of the graph (colors all elements, based on the given color \a c )*/ + /** \brief set the color of the graph (colors all elements, based on the given color \a c ) */ virtual void setColor(QColor c); - /*! \copydoc sortData */ + /** \copydoc sortData */ void setDataSortOrder(DataSortOrder __value); - /*! \copydoc sortData */ + /** \copydoc sortData */ void setDataSortOrder(int __value); - /*! \copydoc posColumn */ + /** \copydoc posColumn */ void setPositionColumn(int __value); - /*! \copydoc posColumn */ + /** \copydoc posColumn */ void setPositionColumn (size_t __value); - /*! \copydoc medianColumn */ + /** \copydoc medianColumn */ void setMedianColumn(int __value); - /*! \copydoc medianColumn */ + /** \copydoc medianColumn */ void setMedianColumn (size_t __value); - /*! \copydoc meanColumn */ + /** \copydoc meanColumn */ void setMeanColumn(int __value); - /*! \copydoc meanColumn */ + /** \copydoc meanColumn */ void setMeanColumn (size_t __value); - /*! \copydoc minColumn */ + /** \copydoc minColumn */ void setMinColumn(int __value); - /*! \copydoc minColumn */ + /** \copydoc minColumn */ void setMinColumn( size_t __value); - /*! \copydoc maxColumn */ + /** \copydoc maxColumn */ void setMaxColumn(int __value); - /*! \copydoc maxColumn */ + /** \copydoc maxColumn */ void setMaxColumn (size_t __value); - /*! \copydoc percentile25Column */ + /** \copydoc percentile25Column */ void setPercentile25Column(int __value); - /*! \copydoc percentile25Column */ + /** \copydoc percentile25Column */ void setPercentile25Column (size_t __value); - /*! \copydoc percentile75Column */ + /** \copydoc percentile75Column */ void setPercentile75Column(int __value); - /*! \copydoc percentile75Column */ + /** \copydoc percentile75Column */ void setPercentile75Column (size_t __value); - /*! \copydoc medianConfidenceColumn */ + /** \copydoc medianConfidenceColumn */ void setMedianConfidenceColumn (size_t __value); - /*! \copydoc boxWidthRelative */ + /** \copydoc boxWidthRelative */ void setBoxWidthRelative(double __value); - /*! \copydoc useRelativeBoxWidth */ + /** \copydoc useRelativeBoxWidth */ void setUseRelativeBoxWidth(bool __value); protected: /** \brief width of box in percent of distance between the current two posColumn values @@ -200,59 +200,59 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotElementBase: public JKQTPPlotElement, p /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const override; - /*! \copydoc pos */ + /** \copydoc pos */ double getPos() const; - /*! \copydoc median */ + /** \copydoc median */ double getMedian() const; - /*! \copydoc mean */ + /** \copydoc mean */ double getMean() const; - /*! \copydoc min */ + /** \copydoc min */ double getMin() const; - /*! \copydoc max */ + /** \copydoc max */ double getMax() const; - /*! \copydoc percentile25 */ + /** \copydoc percentile25 */ double getPercentile25() const; - /*! \copydoc percentile75 */ + /** \copydoc percentile75 */ double getPercentile75() const; - /*! \copydoc drawMean */ + /** \copydoc drawMean */ void setDrawMean(bool __value); - /*! \copydoc drawMean */ + /** \copydoc drawMean */ bool getDrawMean() const; - /*! \copydoc drawMedian */ + /** \copydoc drawMedian */ bool getDrawMedian() const; - /*! \copydoc drawMinMax */ + /** \copydoc drawMinMax */ bool getDrawMinMax() const; - /*! \copydoc drawNotch */ + /** \copydoc drawNotch */ bool getDrawNotch() const; - /*! \copydoc medianConfidenceIntervalWidth */ + /** \copydoc medianConfidenceIntervalWidth */ double getMedianConfidenceIntervalWidth() const; public slots: - /*! \brief set the color of the graph (colors all elements, based on the given color \a c )*/ + /** \brief set the color of the graph (colors all elements, based on the given color \a c ) */ virtual void setColor(QColor c); - /*! \copydoc pos */ + /** \copydoc pos */ void setPos(double __value); - /*! \copydoc median */ + /** \copydoc median */ void setMedian(double __value); - /*! \copydoc min */ + /** \copydoc min */ void setMin(double __value); - /*! \copydoc mean */ + /** \copydoc mean */ void setMean(double __value); - /*! \copydoc max */ + /** \copydoc max */ void setMax(double __value); - /*! \copydoc percentile25 */ + /** \copydoc percentile25 */ void setPercentile25(double __value); - /*! \copydoc percentile75 */ + /** \copydoc percentile75 */ void setPercentile75(double __value); - /*! \copydoc drawMedian */ + /** \copydoc drawMedian */ void setDrawMedian(bool __value); - /*! \copydoc drawMinMax */ + /** \copydoc drawMinMax */ void setDrawMinMax(bool __value); - /*! \copydoc drawNotch */ + /** \copydoc drawNotch */ void setDrawNotch(bool __value); - /*! \copydoc medianConfidenceIntervalWidth */ + /** \copydoc medianConfidenceIntervalWidth */ void setMedianConfidenceIntervalWidth(double __value); protected: diff --git a/lib/jkqtplotter/graphs/jkqtpboxplotstylingmixins.h b/lib/jkqtplotter/graphs/jkqtpboxplotstylingmixins.h index 796c087463..f3b1d9eba8 100644 --- a/lib/jkqtplotter/graphs/jkqtpboxplotstylingmixins.h +++ b/lib/jkqtplotter/graphs/jkqtpboxplotstylingmixins.h @@ -49,40 +49,40 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphBoxplotStyleMixin: public JKQTPGraphLineS JKQTPGraphBoxplotStyleMixin(); void initBoxplotStyle(JKQTBasePlotter* parent, int &parentPlotStyle); - /*! \copydoc boxWidthAbsolute */ + /** \copydoc boxWidthAbsolute */ void setBoxWidthAbsolute(double __value); - /*! \copydoc boxWidthAbsolute */ + /** \copydoc boxWidthAbsolute */ double getBoxWidthAbsolute() const; - /*! \copydoc drawBox */ + /** \copydoc drawBox */ void setDrawBox(bool __value); - /*! \copydoc drawBox */ + /** \copydoc drawBox */ bool getDrawBox() const; - /*! \copydoc relativeWhiskerWidth */ + /** \copydoc relativeWhiskerWidth */ void setRelativeWhiskerWidth(double __value); - /*! \copydoc relativeWhiskerWidth */ + /** \copydoc relativeWhiskerWidth */ double getRelativeWhiskerWidth() const; - /*! \copydoc relativeNotchIndent */ + /** \copydoc relativeNotchIndent */ void setRelativeNotchIndent(double __value); - /*! \copydoc relativeNotchIndent */ + /** \copydoc relativeNotchIndent */ double getRelativeNotchIndent() const; - /*! \brief set the line style of whisker lines */ + /** \brief set the line style of whisker lines */ void setWhiskerLineStyle(Qt::PenStyle __value); - /*! \brief get the line style of whisker lines */ + /** \brief get the line style of whisker lines */ Qt::PenStyle getWhiskerLineStyle() const; - /*! \brief set the width [pt] of whisker lines */ + /** \brief set the width [pt] of whisker lines */ void setWhiskerLineWidth(double __value); - /*! \brief get the width [pt] of whisker lines */ + /** \brief get the width [pt] of whisker lines */ double getWhiskerLineWidth() const; - /*! \brief set the color of whisker lines */ + /** \brief set the color of whisker lines */ void setWhiskerLineColor(QColor __value); - /*! \brief get the color of whisker lines */ + /** \brief get the color of whisker lines */ QColor getWhiskerLineColor() const; @@ -132,19 +132,19 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphBoxplotStyleMixin: public JKQTPGraphLineS - /*! \brief set the line style of whisker cap lines */ + /** \brief set the line style of whisker cap lines */ void setWhiskerCapLineStyle(Qt::PenStyle __value); - /*! \brief get the line style of whisker cap lines */ + /** \brief get the line style of whisker cap lines */ Qt::PenStyle getWhiskerCapLineStyle() const; - /*! \brief set the width [pt] of whisker cap lines */ + /** \brief set the width [pt] of whisker cap lines */ void setWhiskerCapLineWidth(double __value); - /*! \brief get the width [pt] of whisker cap lines */ + /** \brief get the width [pt] of whisker cap lines */ double getWhiskerCapLineWidth() const; - /*! \brief set the color of whisker cap lines */ + /** \brief set the color of whisker cap lines */ void setWhiskerCapLineColor(QColor __value); - /*! \brief get the color of whisker cap lines */ + /** \brief get the color of whisker cap lines */ QColor getWhiskerCapLineColor() const; @@ -201,25 +201,25 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphBoxplotStyleMixin: public JKQTPGraphLineS MeanAsLine /*!< \brief draw mean as a lie (specified by the pen settings in JKQTPGraphSymbolStyleMixin) */ }; - /*! \copydoc meanMode */ + /** \copydoc meanMode */ void setMeanMode(MeanMode __value); - /*! \copydoc meanMode */ + /** \copydoc meanMode */ MeanMode getMeanMode() const; - /*! \brief set the line style of median lines */ + /** \brief set the line style of median lines */ void setMedianLineStyle(Qt::PenStyle __value); - /*! \brief get the line style of median lines */ + /** \brief get the line style of median lines */ Qt::PenStyle getMedianLineStyle() const; - /*! \brief set the width [pt] of median lines */ + /** \brief set the width [pt] of median lines */ void setMedianLineWidth(double __value); - /*! \brief get the width [pt] of median lines */ + /** \brief get the width [pt] of median lines */ double getMedianLineWidth() const; - /*! \brief set the color of median lines */ + /** \brief set the color of median lines */ void setMedianLineColor(QColor __value); - /*! \brief get the color of median lines */ + /** \brief get the color of median lines */ QColor getMedianLineColor() const; @@ -271,9 +271,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphBoxplotStyleMixin: public JKQTPGraphLineS - /*! \brief set the line style of Mean lines */ + /** \brief set the line style of Mean lines */ void setMeanLineStyle(Qt::PenStyle __value); - /*! \brief get the line style of Mean lines */ + /** \brief get the line style of Mean lines */ Qt::PenStyle getMeanLineStyle() const; /** \brief sets the dash offset for a custom dash style of Mean lines * \see https://doc.qt.io/qt-5/qpen.html#setDashOffset @@ -323,10 +323,10 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphBoxplotStyleMixin: public JKQTPGraphLineS /** \brief constructs a QPen from the line styling properties */ QBrush getMeanSymbolBrush(JKQTPEnhancedPainter &painter, JKQTBasePlotter* parent) const; - /*! \brief set the color of the graph (colors all elements, based on the given color \a c )*/ + /** \brief set the color of the graph (colors all elements, based on the given color \a c ) */ void setBoxplotColor(QColor c, JKQTBasePlotter *parent); - /*! \brief set the color of the graph (colors all elements, based on the given color \a c , sets background colors from \a bc )*/ + /** \brief set the color of the graph (colors all elements, based on the given color \a c , sets background colors from \a bc ) */ void setBoxplotColor(QColor c, QColor bc, JKQTBasePlotter *parent); diff --git a/lib/jkqtplotter/graphs/jkqtpcontour.h b/lib/jkqtplotter/graphs/jkqtpcontour.h index 9f8e57e00c..b86233e237 100644 --- a/lib/jkqtplotter/graphs/jkqtpcontour.h +++ b/lib/jkqtplotter/graphs/jkqtpcontour.h @@ -95,15 +95,15 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPContourPlot: public JKQTPMathImage, public JKQ /** \brief creates at least nLevels contour levels with logarithmic spacing. FIXME: Has not been tested yet */ void createContourLevelsLog(int nLevels=3,int m=2); - /*! \copydoc ignoreOnPlane */ + /** \copydoc ignoreOnPlane */ void setIgnoreOnPlane(bool __value); - /*! \copydoc ignoreOnPlane */ + /** \copydoc ignoreOnPlane */ bool getIgnoreOnPlane() const; - /*! \copydoc contourLevels */ + /** \copydoc contourLevels */ int getNumberOfLevels() const; - /*! \copydoc contourColoringMode */ + /** \copydoc contourColoringMode */ void setContourColoringMode(ContourColoringMode __value); - /*! \copydoc contourColoringMode */ + /** \copydoc contourColoringMode */ ContourColoringMode getContourColoringMode() const; /** \brief sets new contour levels from a container \a levels * @@ -121,11 +121,11 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPContourPlot: public JKQTPMathImage, public JKQ */ template void setContourLevels(const TContainer &levels, const TColorContainer& colors); - /*! \copydoc contourLevels */ + /** \copydoc contourLevels */ QVector getContourLevels() const; - /*! \copydoc relativeLevels */ + /** \copydoc relativeLevels */ void setRelativeLevels(bool __value); - /*! \copydoc relativeLevels */ + /** \copydoc relativeLevels */ bool getRelativeLevels() const; /** \brief add another level for which to draw a contour * \see setOverrideColor(), addContourLevel(), hasOverrideColor(), removeOverrideColor(), getOverrideColor() @@ -260,12 +260,12 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColumnContourPlot: public JKQTPContourPlot { /** \brief class constructor */ JKQTPColumnContourPlot(JKQTPlotter* parent); - /*! \copydoc imageColumn */ + /** \copydoc imageColumn */ void setImageColumn(int __value); - /*! \copydoc imageColumn */ + /** \copydoc imageColumn */ void setImageColumn(size_t __value); - /*! \copydoc imageColumn */ + /** \copydoc imageColumn */ int getImageColumn() const; /** \copydoc JKQTPGraph::usesColumn() */ diff --git a/lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h b/lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h index eb1c29b507..1ba1d88278 100644 --- a/lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h +++ b/lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h @@ -64,19 +64,19 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase: p - /*! \copydoc drawErrorPolygons */ + /** \copydoc drawErrorPolygons */ bool getDrawErrorPolygons() const; - /*! \copydoc drawErrorLines */ + /** \copydoc drawErrorLines */ bool getDrawErrorLines() const; - /*! \copydoc errorColor */ + /** \copydoc errorColor */ virtual QColor getErrorLineColor() const; - /*! \copydoc errorFillColor */ + /** \copydoc errorFillColor */ virtual QColor getErrorFillColor() const; - /*! \copydoc errorFillStyle */ + /** \copydoc errorFillStyle */ virtual Qt::BrushStyle getErrorFillStyle() const; - /*! \copydoc errorStyle */ + /** \copydoc errorStyle */ virtual Qt::PenStyle getErrorLineStyle() const; - /*! \copydoc errorLineWidth */ + /** \copydoc errorLineWidth */ virtual double getErrorLineWidth() const; @@ -84,23 +84,23 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase: p public slots: - /*! \brief set color, fill color and error color at the same time */ + /** \brief set color, fill color and error color at the same time */ void setColor(QColor c); - /*! \copydoc drawErrorPolygons */ + /** \copydoc drawErrorPolygons */ void setDrawErrorPolygons(bool __value); - /*! \copydoc drawErrorLines */ + /** \copydoc drawErrorLines */ void setDrawErrorLines(bool __value); - /*! \copydoc errorColor */ + /** \copydoc errorColor */ virtual void setErrorLineColor(const QColor & __value); - /*! \copydoc errorFillColor */ + /** \copydoc errorFillColor */ virtual void setErrorFillColor(const QColor & __value); - /*! \copydoc errorFillStyle */ + /** \copydoc errorFillStyle */ virtual void setErrorFillStyle(Qt::BrushStyle __value); - /*! \copydoc errorStyle */ + /** \copydoc errorStyle */ virtual void setErrorLineStyle(Qt::PenStyle __value); - /*! \copydoc errorLineWidth */ + /** \copydoc errorLineWidth */ virtual void setErrorLineWidth(double __value); protected: @@ -239,7 +239,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPFunctorLineGraphBase: public JKQTPEvaluatedFun * \see errorPlotFunction */ virtual void setErrorPlotFunction (const jkqtpPlotFunctionType & __value); - /*! \copydoc errorPlotFunction */ \ + /** \copydoc errorPlotFunction */ \ virtual jkqtpPlotFunctionType getErrorPlotFunction () const; /** \brief sets a functor to be used for calculating errors * @@ -251,7 +251,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPFunctorLineGraphBase: public JKQTPEvaluatedFun * \see errorSimplePlotFunction */ virtual void setErrorPlotFunction (const jkqtpSimplePlotFunctionType & __value); - /*! \copydoc errorSimplePlotFunction */ \ + /** \copydoc errorSimplePlotFunction */ \ virtual jkqtpSimplePlotFunctionType getErrorSimplePlotFunction () const; diff --git a/lib/jkqtplotter/graphs/jkqtpgeoannotations.h b/lib/jkqtplotter/graphs/jkqtpgeoannotations.h index 6e7dd53622..d3e412a18a 100644 --- a/lib/jkqtplotter/graphs/jkqtpgeoannotations.h +++ b/lib/jkqtplotter/graphs/jkqtpgeoannotations.h @@ -65,9 +65,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoSymbol: public JKQTPPlotAnnotationElement, */ JKQTPGeoSymbol(JKQTPlotter* parent, double x, double y, JKQTPGraphSymbols symbol=JKQTPCross, double symbolSize=10, QColor color=QColor("black"), QColor fillColor=QColor("grey")); - /*! \copydoc x */ + /** \copydoc x */ double getX() const; - /*! \copydoc y */ + /** \copydoc y */ double getY() const; /** \copydoc JKQTPPlotAnnotationElement::getXMinMax() */ @@ -83,12 +83,12 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoSymbol: public JKQTPPlotAnnotationElement, /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const override; public slots: - /*! set the symbol color and symbol fill color */ + /** set the symbol color and symbol fill color */ virtual void setColor(QColor c); - /*! \copydoc x */ + /** \copydoc x */ void setX(double __value); - /*! \copydoc y */ + /** \copydoc y */ void setY(double __value); protected: @@ -146,11 +146,11 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoText: public JKQTPPlotAnnotationElement, pu */ JKQTPGeoText(JKQTPlotter* parent, double x, double y, const QString& text); - /*! \copydoc text */ + /** \copydoc text */ QString getText() const; - /*! \copydoc x */ + /** \copydoc x */ double getX() const; - /*! \copydoc y */ + /** \copydoc y */ double getY() const; @@ -170,11 +170,11 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoText: public JKQTPPlotAnnotationElement, pu /** \brief set line and fill color */ virtual void setColor(QColor c) ; - /*! \copydoc text */ + /** \copydoc text */ void setText(const QString & __value); - /*! \copydoc x */ + /** \copydoc x */ void setX(double __value); - /*! \copydoc y */ + /** \copydoc y */ void setY(double __value); protected: diff --git a/lib/jkqtplotter/graphs/jkqtpgeobase.h b/lib/jkqtplotter/graphs/jkqtpgeobase.h index 035ca694e7..fe7ac12d9a 100644 --- a/lib/jkqtplotter/graphs/jkqtpgeobase.h +++ b/lib/jkqtplotter/graphs/jkqtpgeobase.h @@ -134,7 +134,7 @@ public: \param parent the parent plotter object */ explicit JKQTPGeoBaseDecoratedLine(QColor color, double lineWidth, JKQTPLineDecoratorStyle headStyle, JKQTPLineDecoratorStyle tailStyle, Qt::PenStyle style=Qt::SolidLine, JKQTBasePlotter* parent=nullptr, DrawMode drawMode=DrawAsGraphicElement); - /*! \brief class contructor */ + /** \brief class contructor */ explicit JKQTPGeoBaseDecoratedLine(JKQTBasePlotter* parent, DrawMode drawMode=DrawAsGraphicElement); diff --git a/lib/jkqtplotter/graphs/jkqtpgeoshapes.h b/lib/jkqtplotter/graphs/jkqtpgeoshapes.h index cf9d4ca269..45aab1231a 100644 --- a/lib/jkqtplotter/graphs/jkqtpgeoshapes.h +++ b/lib/jkqtplotter/graphs/jkqtpgeoshapes.h @@ -197,33 +197,33 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoRectangle: public JKQTPGeoBaseFilled { */ virtual void draw(JKQTPEnhancedPainter& painter) override; - /*! \copydoc x */ + /** \copydoc x */ void setX(double __value); - /*! \copydoc x */ + /** \copydoc x */ double getX() const; - /*! \copydoc y */ + /** \copydoc y */ void setY(double __value); - /*! \copydoc y */ + /** \copydoc y */ double getY() const; /** \brief returns the center point of the rectangle */ QPointF getCenter() const; /** \brief sets the center point of the rectangle */ void setCenter(const QPointF& center); - /*! \copydoc width */ + /** \copydoc width */ void setWidth(double __value); - /*! \copydoc width */ + /** \copydoc width */ double getWidth() const; - /*! \copydoc height */ + /** \copydoc height */ void setHeight(double __value); - /*! \copydoc height */ + /** \copydoc height */ double getHeight() const; /** \brief returns the size (width and height) of the rectangle */ QSizeF getSize() const; /** \brief sets the size (width and height) of the rectangle */ void setSize(const QSizeF& size); - /*! \copydoc angle */ + /** \copydoc angle */ void setAngle(double __value); - /*! \copydoc angle */ + /** \copydoc angle */ double getAngle() const; /** \brief set the rectangle using the bottom-left corner, as well as its width and height */ void setBottomLeftRectangle(double x, double y, double width, double height); @@ -329,9 +329,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPolygon: public JKQTPGeoBaseFilled { */ virtual void draw(JKQTPEnhancedPainter& painter) override; - /*! \copydoc points */ + /** \copydoc points */ void setPoints(const QVector & __value); - /*! \copydoc points */ + /** \copydoc points */ QVector getPoints() const; /** \brief append a point to the polygon \see points */ @@ -568,13 +568,13 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPie: public JKQTPGeoEllipse { * parametrization for pies on non-linear axes could be found!*/ virtual void draw(JKQTPEnhancedPainter& painter) override; - /*! \copydoc angleStart */ + /** \copydoc angleStart */ void setAngleStart(double __value); - /*! \copydoc angleStart */ + /** \copydoc angleStart */ double getAngleStart() const; - /*! \copydoc angleStop */ + /** \copydoc angleStop */ void setAngleStop(double __value); - /*! \copydoc angleStop */ + /** \copydoc angleStop */ double getAngleStop() const; protected: /** \brief if we only draw an arc, this is the starting angle */ diff --git a/lib/jkqtplotter/graphs/jkqtpimage.h b/lib/jkqtplotter/graphs/jkqtpimage.h index 19b6f10eff..9b6c3bde07 100644 --- a/lib/jkqtplotter/graphs/jkqtpimage.h +++ b/lib/jkqtplotter/graphs/jkqtpimage.h @@ -86,21 +86,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImageBase: public JKQTPGraph { /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const override; - /*! \copydoc x */ + /** \copydoc x */ void setX(double __value); - /*! \copydoc x */ + /** \copydoc x */ double getX() const; - /*! \copydoc y */ + /** \copydoc y */ void setY(double __value); - /*! \copydoc y */ + /** \copydoc y */ double getY() const; - /*! \copydoc width */ + /** \copydoc width */ void setWidth(double __value); - /*! \copydoc width */ + /** \copydoc width */ double getWidth() const; - /*! \copydoc height */ + /** \copydoc height */ void setHeight(double __value); - /*! \copydoc height */ + /** \copydoc height */ double getHeight() const; protected: @@ -198,35 +198,35 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPMathImageBase: public JKQTPImageBase { /** \brief plots a key marker inside the specified rectangle \a rect */ virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, QRectF& rect) override; - /*! \copydoc Nx */ + /** \copydoc Nx */ void setNx(int __value); - /*! \copydoc Nx */ + /** \copydoc Nx */ void setNx(size_t __value); - /*! \copydoc Nx */ + /** \copydoc Nx */ int getNx() const; - /*! \copydoc Ny */ + /** \copydoc Ny */ void setNy(int __value); - /*! \copydoc Ny */ + /** \copydoc Ny */ void setNy(size_t __value); - /*! \copydoc Ny */ + /** \copydoc Ny */ int getNy() const; - /*! \copydoc data */ + /** \copydoc data */ virtual void setData(void* __value); - /*! \copydoc data */ + /** \copydoc data */ virtual void *getData() const; - /*! \copydoc datatype */ + /** \copydoc datatype */ virtual void setDatatype(JKQTPMathImageDataType __value); - /*! \copydoc datatype */ + /** \copydoc datatype */ virtual JKQTPMathImageDataType getDatatype() const; - /*! \copydoc dataModifier */ + /** \copydoc dataModifier */ virtual void setDataModifier(void* __value); - /*! \copydoc dataModifier */ + /** \copydoc dataModifier */ virtual void *getDataModifier() const; - /*! \copydoc datatypeModifier */ + /** \copydoc datatypeModifier */ virtual void setDatatypeModifier(JKQTPMathImageDataType __value); - /*! \copydoc datatypeModifier */ + /** \copydoc datatypeModifier */ virtual JKQTPMathImageDataType getDatatypeModifier() const; - /*! \copydoc modifierMode */ + /** \copydoc modifierMode */ /** \brief sets dataModifier (\copybrief dataModifier ) and datatypeModifier (\copybrief datatypeModifier ) */ virtual void setDataModifier(void* data, JKQTPMathImageDataType datatype); @@ -370,7 +370,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImage: public JKQTPImageBase { /** \brief deletes the internal image */ void clear_image(); - /*! \copydoc image */ + /** \copydoc image */ inline QImage* getImage() const { return this->image; } protected: /** \brief the image to be plotted. This is freed by the destructor, iff \a image_owned is set to \c true (.e.g by QImage-copy-constructors) */ @@ -495,10 +495,10 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPMathImage: public JKQTPMathImageBase, public J */ virtual void drawOutside(JKQTPEnhancedPainter& painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace) override; - /*! \brief returns a QImage, which contains the plaette drawn outside the plot. \a steps is the number of data-setps (and the size of the output image) used for the palette image. */ + /** \brief returns a QImage, which contains the plaette drawn outside the plot. \a steps is the number of data-setps (and the size of the output image) used for the palette image. */ virtual QImage drawOutsidePalette(uint8_t steps=200); - /*! \brief return the plotted image only as a QImage */ + /** \brief return the plotted image only as a QImage */ virtual QImage drawImage(); /** \brief determine min/max data value of the image */ @@ -837,18 +837,18 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColumnMathImage: public JKQTPMathImage { */ JKQTPColumnMathImage(double x, double y, double width, double height, int imageColumn, JKQTPlotter* parent); - /*! \copydoc imageColumn */ + /** \copydoc imageColumn */ virtual void setImageColumn(int __value); - /*! \copydoc imageColumn */ + /** \copydoc imageColumn */ virtual void setImageColumn(size_t __value); - /*! \copydoc imageColumn */ + /** \copydoc imageColumn */ int getImageColumn() const; - /*! \copydoc modifierColumn */ + /** \copydoc modifierColumn */ virtual void setModifierColumn(int __value); - /*! \copydoc modifierColumn */ + /** \copydoc modifierColumn */ virtual void setModifierColumn(size_t __value); - /*! \copydoc modifierColumn */ + /** \copydoc modifierColumn */ int getModifierColumn() const; /** \copydoc JKQTPGraph::usesColumn() */ diff --git a/lib/jkqtplotter/graphs/jkqtpimageoverlays.h b/lib/jkqtplotter/graphs/jkqtpimageoverlays.h index 0cf995996a..20b32f4e85 100644 --- a/lib/jkqtplotter/graphs/jkqtpimageoverlays.h +++ b/lib/jkqtplotter/graphs/jkqtpimageoverlays.h @@ -56,7 +56,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPOverlayImage: public JKQTPImageBase { /** \brief plots the graph to the plotter object specified as parent */ virtual void draw(JKQTPEnhancedPainter& painter) override; - /*! \brief return the plotted image only as a QImage */ + /** \brief return the plotted image only as a QImage */ virtual QImage drawImage(); /** \brief plots a key marker inside the specified rectangle \a rect */ @@ -64,29 +64,29 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPOverlayImage: public JKQTPImageBase { /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const override; - /*! \copydoc trueColor */ + /** \copydoc trueColor */ void setTrueColor(const QColor & __value); - /*! \copydoc trueColor */ + /** \copydoc trueColor */ QColor getTrueColor() const; - /*! \copydoc falseColor */ + /** \copydoc falseColor */ void setFalseColor(const QColor & __value); - /*! \copydoc falseColor */ + /** \copydoc falseColor */ QColor getFalseColor() const; - /*! \copydoc Nx */ + /** \copydoc Nx */ void setNx(int __value); - /*! \copydoc Nx */ + /** \copydoc Nx */ void setNx(size_t __value); - /*! \copydoc Nx */ + /** \copydoc Nx */ int getNx() const; - /*! \copydoc Ny */ + /** \copydoc Ny */ void setNy(int __value); - /*! \copydoc Ny */ + /** \copydoc Ny */ void setNy(size_t __value); - /*! \copydoc Ny */ + /** \copydoc Ny */ int getNy() const; - /*! \copydoc data */ + /** \copydoc data */ virtual void setData(bool* __value); - /*! \copydoc data */ + /** \copydoc data */ bool *getData() const; /** \brief set the plot-data to a given array \a data with size \a Nx * \a Ny in row-major ordering */ @@ -157,21 +157,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPOverlayImageEnhanced: public JKQTPOverlayImage /** \brief plots a key marker inside the specified rectangle \a rect */ virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, QRectF& rect) override; - /*! \copydoc symbol */ + /** \copydoc symbol */ void setSymbolType(JKQTPGraphSymbols __value); - /*! \copydoc symbol */ + /** \copydoc symbol */ JKQTPGraphSymbols getSymbol() const; - /*! \copydoc symbolLineWidth */ + /** \copydoc symbolLineWidth */ void setSymbolLineWidth(double __value); - /*! \copydoc symbolLineWidth */ + /** \copydoc symbolLineWidth */ double getSymbolLineWidth() const; - /*! \copydoc drawMode */ + /** \copydoc drawMode */ void setDrawMode(OverlayImageEnhancedDrawMode __value); - /*! \copydoc drawMode */ + /** \copydoc drawMode */ OverlayImageEnhancedDrawMode getDrawMode() const; - /*! \copydoc symbolSizeFactor */ + /** \copydoc symbolSizeFactor */ void setSymbolSizeFactor(double __value); - /*! \copydoc symbolSizeFactor */ + /** \copydoc symbolSizeFactor */ double getSymbolSizeFactor() const; protected: @@ -207,9 +207,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColumnOverlayImageEnhanced: public JKQTPOverla JKQTPColumnOverlayImageEnhanced(JKQTBasePlotter* parent=nullptr); JKQTPColumnOverlayImageEnhanced(JKQTPlotter* parent); - /*! \copydoc imageColumn */ + /** \copydoc imageColumn */ virtual void setImageColumn(int __value); - /*! \copydoc imageColumn */ + /** \copydoc imageColumn */ int getImageColumn() const; /** \brief plots the graph to the plotter object specified as parent */ virtual void draw(JKQTPEnhancedPainter& painter) override; diff --git a/lib/jkqtplotter/graphs/jkqtpimagergb.h b/lib/jkqtplotter/graphs/jkqtpimagergb.h index 2294ac2a09..fdfb14c913 100644 --- a/lib/jkqtplotter/graphs/jkqtpimagergb.h +++ b/lib/jkqtplotter/graphs/jkqtpimagergb.h @@ -118,179 +118,179 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPRGBMathImage: public JKQTPMathImageBase { virtual void getDataMinMax(double& imin, double& imax) override; - /*! \copydoc data */ + /** \copydoc data */ virtual void setDataR(void* __value); - /*! \copydoc data */ + /** \copydoc data */ void* getDataR() const; - /*! \copydoc datatype */ + /** \copydoc datatype */ void setDatatypeR(JKQTPMathImageDataType __value); - /*! \copydoc datatype */ + /** \copydoc datatype */ JKQTPMathImageDataType getDatatypeR() const; - /*! \copydoc dataG */ + /** \copydoc dataG */ virtual void setDataG(void* __value); - /*! \copydoc dataG */ + /** \copydoc dataG */ void* getDataG() const; - /*! \copydoc datatypeG */ + /** \copydoc datatypeG */ void setDatatypeG(JKQTPMathImageDataType __value); - /*! \copydoc datatypeG */ + /** \copydoc datatypeG */ JKQTPMathImageDataType getDatatypeG() const; - /*! \copydoc dataB */ + /** \copydoc dataB */ virtual void setDataB(void* __value); - /*! \copydoc dataB */ + /** \copydoc dataB */ void* getDataB() const; - /*! \copydoc datatypeB */ + /** \copydoc datatypeB */ void setDatatypeB(JKQTPMathImageDataType __value); - /*! \copydoc datatypeB */ + /** \copydoc datatypeB */ JKQTPMathImageDataType getDatatypeB() const; - /*! \copydoc showColorBar */ + /** \copydoc showColorBar */ void setShowColorBar(bool __value); - /*! \copydoc showColorBar */ + /** \copydoc showColorBar */ bool getShowColorBar() const; - /*! \copydoc colorBarWidth */ + /** \copydoc colorBarWidth */ void setColorBarWidth(int __value); - /*! \copydoc colorBarWidth */ + /** \copydoc colorBarWidth */ int getColorBarWidth() const; - /*! \copydoc colorBarOffset */ + /** \copydoc colorBarOffset */ void setColorBarOffset(int __value); - /*! \copydoc colorBarOffset */ + /** \copydoc colorBarOffset */ int getColorBarOffset() const; - /*! \copydoc colorBarRelativeHeight */ + /** \copydoc colorBarRelativeHeight */ void setColorBarRelativeHeight(double __value); - /*! \copydoc colorBarRelativeHeight */ + /** \copydoc colorBarRelativeHeight */ double getColorBarRelativeHeight() const; - /*! \copydoc imageMinR */ + /** \copydoc imageMinR */ void setImageMin(double __value); - /*! \copydoc imageMinR */ + /** \copydoc imageMinR */ double getImageMin() const; - /*! \copydoc imageMinR */ + /** \copydoc imageMinR */ void setImageMinR(double m); - /*! \copydoc imageMaxR */ + /** \copydoc imageMaxR */ void setImageMax(double __value); - /*! \copydoc imageMaxR */ + /** \copydoc imageMaxR */ double getImageMax() const; - /*! \copydoc imageMaxR */ + /** \copydoc imageMaxR */ void setImageMaxR(double m); - /*! \copydoc imageMinG */ + /** \copydoc imageMinG */ void setImageMinG(double __value); - /*! \copydoc imageMinG */ + /** \copydoc imageMinG */ double getImageMinG() const; - /*! \copydoc imageMaxG */ + /** \copydoc imageMaxG */ void setImageMaxG(double __value); - /*! \copydoc imageMaxG */ + /** \copydoc imageMaxG */ double getImageMaxG() const; - /*! \copydoc imageMinB */ + /** \copydoc imageMinB */ void setImageMinB(double __value); - /*! \copydoc imageMinB */ + /** \copydoc imageMinB */ double getImageMinB() const; - /*! \copydoc imageMaxB */ + /** \copydoc imageMaxB */ void setImageMaxB(double __value); - /*! \copydoc imageMaxB */ + /** \copydoc imageMaxB */ double getImageMaxB() const; - /*! \copydoc autoImageRange */ + /** \copydoc autoImageRange */ void setAutoImageRange(bool __value); - /*! \copydoc autoImageRange */ + /** \copydoc autoImageRange */ bool getAutoImageRange() const; - /*! \copydoc imageNameR */ + /** \copydoc imageNameR */ void setImageName(const QString & __value); - /*! \copydoc imageNameR */ + /** \copydoc imageNameR */ QString getImageName() const; - /*! \copydoc imageNameR */ + /** \copydoc imageNameR */ QString getImageNameR() const; - /*! \copydoc imageNameR */ + /** \copydoc imageNameR */ void setImageNameR(const QString& m); - /*! \copydoc imageNameG */ + /** \copydoc imageNameG */ void setImageNameG(const QString & __value); - /*! \copydoc imageNameG */ + /** \copydoc imageNameG */ QString getImageNameG() const; - /*! \copydoc imageNameB */ + /** \copydoc imageNameB */ void setImageNameB(const QString & __value); - /*! \copydoc imageNameB */ + /** \copydoc imageNameB */ QString getImageNameB() const; - /*! \copydoc imageNameFontName */ + /** \copydoc imageNameFontName */ void setImageNameFontName(const QString & __value); - /*! \copydoc imageNameFontName */ + /** \copydoc imageNameFontName */ QString getImageNameFontName() const; - /*! \copydoc imageNameFontSize */ + /** \copydoc imageNameFontSize */ void setImageNameFontSize(double __value); - /*! \copydoc imageNameFontSize */ + /** \copydoc imageNameFontSize */ double getImageNameFontSize() const; - /*! \copydoc colorBarRightAxis */ + /** \copydoc colorBarRightAxis */ JKQTPVerticalIndependentAxis* getColorBarRightAxis(); - /*! \copydoc colorBarTopAxis */ + /** \copydoc colorBarTopAxis */ JKQTPHorizontalIndependentAxis* getColorBarTopAxis(); - /*! \copydoc colorBarRightAxis */ + /** \copydoc colorBarRightAxis */ JKQTPVerticalIndependentAxis* getColorBarRightAxisR(); - /*! \copydoc colorBarTopAxis */ + /** \copydoc colorBarTopAxis */ JKQTPHorizontalIndependentAxis *getColorBarTopAxisR(); - /*! \copydoc colorBarRightAxisG */ + /** \copydoc colorBarRightAxisG */ JKQTPVerticalIndependentAxis* getColorBarRightAxisG(); - /*! \copydoc colorBarTopAxisG */ + /** \copydoc colorBarTopAxisG */ JKQTPHorizontalIndependentAxis* getColorBarTopAxisG(); - /*! \copydoc colorBarRightAxisB */ + /** \copydoc colorBarRightAxisB */ JKQTPVerticalIndependentAxis* getColorBarRightAxisB(); - /*! \copydoc colorBarTopAxisB */ + /** \copydoc colorBarTopAxisB */ JKQTPHorizontalIndependentAxis* getColorBarTopAxisB(); - /*! \copydoc colorBarRightAxis */ + /** \copydoc colorBarRightAxis */ const JKQTPVerticalIndependentAxis* getColorBarRightAxis() const; - /*! \copydoc colorBarTopAxis */ + /** \copydoc colorBarTopAxis */ const JKQTPHorizontalIndependentAxis* getColorBarTopAxis() const; - /*! \copydoc colorBarRightAxis */ + /** \copydoc colorBarRightAxis */ const JKQTPVerticalIndependentAxis* getColorBarRightAxisR() const; - /*! \copydoc colorBarTopAxis */ + /** \copydoc colorBarTopAxis */ const JKQTPHorizontalIndependentAxis* getColorBarTopAxisR() const; - /*! \copydoc colorBarRightAxisG */ + /** \copydoc colorBarRightAxisG */ const JKQTPVerticalIndependentAxis* getColorBarRightAxisG() const; - /*! \copydoc colorBarTopAxisG */ + /** \copydoc colorBarTopAxisG */ const JKQTPHorizontalIndependentAxis *getColorBarTopAxisG() const; - /*! \copydoc colorBarRightAxisB */ + /** \copydoc colorBarRightAxisB */ const JKQTPVerticalIndependentAxis* getColorBarRightAxisB() const; - /*! \copydoc colorBarTopAxisB */ + /** \copydoc colorBarTopAxisB */ const JKQTPHorizontalIndependentAxis *getColorBarTopAxisB() const; - /*! \copydoc colorBarTopVisible */ + /** \copydoc colorBarTopVisible */ void setColorBarTopVisible(bool __value); - /*! \copydoc colorBarTopVisible */ + /** \copydoc colorBarTopVisible */ bool getColorBarTopVisible() const; - /*! \copydoc colorBarRightVisible */ + /** \copydoc colorBarRightVisible */ void setColorBarRightVisible(bool __value); - /*! \copydoc colorBarRightVisible */ + /** \copydoc colorBarRightVisible */ bool getColorBarRightVisible() const; - /*! \copydoc colorbarsSideBySide */ + /** \copydoc colorbarsSideBySide */ void setColorbarsSideBySide(bool __value); - /*! \copydoc colorbarsSideBySide */ + /** \copydoc colorbarsSideBySide */ bool getColorbarsSideBySide() const; - /*! \copydoc rgbMode */ + /** \copydoc rgbMode */ void setRgbMode(JKQTPRGBMathImageRGBMode __value); - /*! \copydoc rgbMode */ + /** \copydoc rgbMode */ JKQTPRGBMathImageRGBMode getRgbMode() const; - /*! \copydoc modifierMode */ + /** \copydoc modifierMode */ void setModifierMode(const JKQTPMathImageModifierMode & __value); - /*! \copydoc modifierMode */ + /** \copydoc modifierMode */ JKQTPMathImageModifierMode getModifierMode() const; - /*! \copydoc colorBarModifiedWidth */ + /** \copydoc colorBarModifiedWidth */ void setColorBarModifiedWidth(double __value); - /*! \copydoc colorBarModifiedWidth */ + /** \copydoc colorBarModifiedWidth */ double getColorBarModifiedWidth() const; - /*! \copydoc modifierColorBarTopAxis */ + /** \copydoc modifierColorBarTopAxis */ JKQTPVerticalIndependentAxis* getModifierColorBarTopAxis(); - /*! \copydoc modifierColorBarRightAxis */ + /** \copydoc modifierColorBarRightAxis */ JKQTPHorizontalIndependentAxis* getModifierColorBarRightAxis(); - /*! \copydoc modifierColorBarTopAxis */ + /** \copydoc modifierColorBarTopAxis */ const JKQTPVerticalIndependentAxis* getModifierColorBarTopAxis() const; - /*! \copydoc modifierColorBarRightAxis */ + /** \copydoc modifierColorBarRightAxis */ const JKQTPHorizontalIndependentAxis *getModifierColorBarRightAxis() const; - /*! \copydoc autoModifierRange */ + /** \copydoc autoModifierRange */ void setAutoModifierRange(bool __value); - /*! \copydoc autoModifierRange */ + /** \copydoc autoModifierRange */ bool getAutoModifierRange() const; - /*! \copydoc modifierMin */ + /** \copydoc modifierMin */ void setModifierMin(double __value); - /*! \copydoc modifierMin */ + /** \copydoc modifierMin */ double getModifierMin() const; - /*! \copydoc modifierMax */ + /** \copydoc modifierMax */ void setModifierMax(double __value); - /*! \copydoc modifierMax */ + /** \copydoc modifierMax */ double getModifierMax() const; /** \brief return the data of the green channel used for plotting as a QVector in row-major data-ordering */ @@ -313,7 +313,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPRGBMathImage: public JKQTPMathImageBase { */ virtual void drawOutside(JKQTPEnhancedPainter& painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace) override; - /*! \brief return the plotted image only as a QImage */ + /** \brief return the plotted image only as a QImage */ virtual QImage drawImage(); /** \brief determine min/max data value of the image */ @@ -594,21 +594,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColumnRGBMathImage: public JKQTPRGBMathImage { */ JKQTPColumnRGBMathImage(double x, double y, double width, double height, int imageRColumn, int imageGColumn, int imageBColumn, JKQTPlotter* parent); - /*! \copydoc imageRColumn */ + /** \copydoc imageRColumn */ virtual void setImageRColumn(int __value); - /*! \copydoc imageRColumn */ + /** \copydoc imageRColumn */ int getImageRColumn() const; - /*! \copydoc imageGColumn */ + /** \copydoc imageGColumn */ virtual void setImageGColumn(int __value); - /*! \copydoc imageGColumn */ + /** \copydoc imageGColumn */ int getImageGColumn() const; - /*! \copydoc imageBColumn */ + /** \copydoc imageBColumn */ virtual void setImageBColumn(int __value); - /*! \copydoc imageBColumn */ + /** \copydoc imageBColumn */ int getImageBColumn() const; - /*! \copydoc modifierColumn */ + /** \copydoc modifierColumn */ virtual void setModifierColumn(int __value); - /*! \copydoc modifierColumn */ + /** \copydoc modifierColumn */ int getModifierColumn() const; /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int c) const override; diff --git a/lib/jkqtplotter/graphs/jkqtpimpulses.h b/lib/jkqtplotter/graphs/jkqtpimpulses.h index 361fa99178..66636daae1 100644 --- a/lib/jkqtplotter/graphs/jkqtpimpulses.h +++ b/lib/jkqtplotter/graphs/jkqtpimpulses.h @@ -41,14 +41,14 @@ public: /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const override; - /*! \copydoc drawSymbols */ + /** \copydoc drawSymbols */ bool getDrawSymbols() const; public slots: - /*! \brief color of symbols and impulses in one call */ + /** \brief color of symbols and impulses in one call */ virtual void setColor(QColor c); - /*! \copydoc drawSymbols */ + /** \copydoc drawSymbols */ void setDrawSymbols(bool __value); protected: diff --git a/lib/jkqtplotter/graphs/jkqtppeakstream.h b/lib/jkqtplotter/graphs/jkqtppeakstream.h index 83d4e3e9b8..eb13ae62b9 100644 --- a/lib/jkqtplotter/graphs/jkqtppeakstream.h +++ b/lib/jkqtplotter/graphs/jkqtppeakstream.h @@ -72,21 +72,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPeakStreamGraph: public JKQTPSingleColumnGraph virtual QColor getKeyLabelColor() const override; /** \brief set symbol color and fill color at the same time */ void setColor(QColor col); - /*! \copydoc baseline */ + /** \copydoc baseline */ void setBaseline(double __value); - /*! \copydoc baseline */ + /** \copydoc baseline */ double getBaseline() const; - /*! \copydoc peakHeight */ + /** \copydoc peakHeight */ void setPeakHeight(double __value); - /*! \copydoc peakHeight */ + /** \copydoc peakHeight */ double getPeakHeight() const; - /*! \copydoc yPeaks */ + /** \copydoc yPeaks */ void setYPeaks(bool __value); - /*! \copydoc yPeaks */ + /** \copydoc yPeaks */ bool getYPeaks() const; - /*! \copydoc drawBaseline */ + /** \copydoc drawBaseline */ void setDrawBaseline(bool __value); - /*! \copydoc drawBaseline */ + /** \copydoc drawBaseline */ bool getDrawBaseline() const; protected: diff --git a/lib/jkqtplotter/graphs/jkqtprange.h b/lib/jkqtplotter/graphs/jkqtprange.h index e8df35c5a0..8af592bb3d 100644 --- a/lib/jkqtplotter/graphs/jkqtprange.h +++ b/lib/jkqtplotter/graphs/jkqtprange.h @@ -65,64 +65,64 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPRangeBase: public JKQTPPlotElement, public JKQ virtual QColor getKeyLabelColor() const override; - /*! \copydoc centerColor */ + /** \copydoc centerColor */ QColor getCenterColor() const; - /*! \copydoc centerStyle */ + /** \copydoc centerStyle */ Qt::PenStyle getCenterStyle() const; - /*! \copydoc centerLineWidth */ + /** \copydoc centerLineWidth */ void setCenterLineWidth(double __value); - /*! \copydoc centerLineWidth */ + /** \copydoc centerLineWidth */ double getCenterLineWidth() const; - /*! \copydoc rangeMin */ + /** \copydoc rangeMin */ double getRangeMin() const; - /*! \copydoc rangeMax */ + /** \copydoc rangeMax */ double getRangeMax() const; - /*! \copydoc sizeMin */ + /** \copydoc sizeMin */ double getSizeMin() const; - /*! \copydoc sizeMax */ + /** \copydoc sizeMax */ double getSizeMax() const; - /*! \copydoc unlimitedSizeMin */ + /** \copydoc unlimitedSizeMin */ bool getUnlimitedSizeMin() const; - /*! \copydoc unlimitedSizeMax */ + /** \copydoc unlimitedSizeMax */ bool getUnlimitedSizeMax() const; - /*! \copydoc rangeCenter */ + /** \copydoc rangeCenter */ double getRangeCenter() const; - /*! \copydoc plotCenterLine */ + /** \copydoc plotCenterLine */ bool getPlotCenterLine() const; - /*! \copydoc invertedRange */ + /** \copydoc invertedRange */ bool getInvertedRange() const; - /*! \copydoc plotRange */ + /** \copydoc plotRange */ bool getPlotRange() const; - /*! \copydoc fillRange */ + /** \copydoc fillRange */ bool getFillRange() const; - /*! \copydoc plotRangeLines */ + /** \copydoc plotRangeLines */ bool getPlotRangeLines() const; public slots: - /*! \brief set the color of the graph (all lines and filling) */ + /** \brief set the color of the graph (all lines and filling) */ virtual void setColor(QColor c); /** \brief disables all drawing features except the centerline */ void setDrawCenterLineOnly(); - /*! \copydoc centerColor */ + /** \copydoc centerColor */ void setCenterColor(const QColor & __value); - /*! \copydoc centerStyle */ + /** \copydoc centerStyle */ void setCenterStyle(Qt::PenStyle __value); - /*! \copydoc plotRangeLines */ + /** \copydoc plotRangeLines */ void setPlotRangeLines(bool __value); - /*! \copydoc fillRange */ + /** \copydoc fillRange */ void setFillRange(bool __value); - /*! \copydoc plotRange */ + /** \copydoc plotRange */ void setPlotRange(bool __value); - /*! \copydoc invertedRange */ + /** \copydoc invertedRange */ void setInvertedRange(bool __value); - /*! \copydoc rangeCenter */ + /** \copydoc rangeCenter */ void setRangeCenter(double __value); - /*! \copydoc plotCenterLine */ + /** \copydoc plotCenterLine */ void setPlotCenterLine(bool __value); - /*! \copydoc unlimitedSizeMax */ + /** \copydoc unlimitedSizeMax */ void setUnlimitedSizeMax(bool __value); - /*! \copydoc unlimitedSizeMin */ + /** \copydoc unlimitedSizeMin */ void setUnlimitedSizeMin(bool __value); /** \copydoc sizeMax * diff --git a/lib/jkqtplotter/graphs/jkqtpscatter.h b/lib/jkqtplotter/graphs/jkqtpscatter.h index f86cb867d4..8b49e12d22 100644 --- a/lib/jkqtplotter/graphs/jkqtpscatter.h +++ b/lib/jkqtplotter/graphs/jkqtpscatter.h @@ -68,9 +68,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYLineGraph: public JKQTPXYGraph, public JKQTP /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const override; - /*! \copydoc drawLine */ + /** \copydoc drawLine */ void setDrawLine(bool __value); - /*! \copydoc drawLine */ + /** \copydoc drawLine */ bool getDrawLine() const; /** \brief set color of line and symbol */ @@ -135,11 +135,11 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYParametrizedScatterGraph: public JKQTPXYLine /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const override; - /*! \copydoc sizeColumn */ + /** \copydoc sizeColumn */ void setSizeColumn(int __value); - /*! \copydoc sizeColumn */ + /** \copydoc sizeColumn */ void setSizeColumn (size_t __value); - /*! \copydoc sizeColumn */ + /** \copydoc sizeColumn */ int getSizeColumn() const; /** \brief defines a functor, which converts a value from the sizeColumn into an actual symbol size in pt * @@ -162,19 +162,19 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYParametrizedScatterGraph: public JKQTPXYLine FunctorToSize getSizeColumnFunctor(); - /*! \copydoc colorColumn */ + /** \copydoc colorColumn */ void setColorColumn(int __value); - /*! \copydoc colorColumn */ + /** \copydoc colorColumn */ int getColorColumn() const; - /*! \copydoc colorColumn */ + /** \copydoc colorColumn */ void setColorColumn (size_t __value); - /*! \copydoc symbolColumn */ + /** \copydoc symbolColumn */ void setSymbolColumn(int __value); - /*! \copydoc symbolColumn */ + /** \copydoc symbolColumn */ int getSymbolColumn() const; - /*! \copydoc symbolColumn */ + /** \copydoc symbolColumn */ void setSymbolColumn (size_t __value); /** \brief defines a functor, which converts a value from the symbolColumn into an actual symbol type * @@ -226,11 +226,11 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYParametrizedScatterGraph: public JKQTPXYLine FunctorToSymbol getSymbolColumnFunctor(); - /*! \copydoc linewidthColumn */ + /** \copydoc linewidthColumn */ void setLinewidthColumn(int __value); - /*! \copydoc linewidthColumn */ + /** \copydoc linewidthColumn */ int getLinewidthColumn() const; - /*! \copydoc linewidthColumn */ + /** \copydoc linewidthColumn */ void setLinewidthColumn( size_t __value); /** \brief defines a functor, which converts a value from the symbolColumn into an actual line width in pt * @@ -260,31 +260,31 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYParametrizedScatterGraph: public JKQTPXYLine - /*! \copydoc colorColumnContainsRGB */ + /** \copydoc colorColumnContainsRGB */ void setColorColumnContainsRGB(bool __value); - /*! \copydoc colorColumnContainsRGB */ + /** \copydoc colorColumnContainsRGB */ bool getColorColumnContainsRGB() const; - /*! \copydoc gridModeForSymbolSize */ + /** \copydoc gridModeForSymbolSize */ void setGridModeForSymbolSize(bool __value); - /*! \copydoc gridModeForSymbolSize */ + /** \copydoc gridModeForSymbolSize */ bool getGridModeForSymbolSize() const; - /*! \copydoc gridDeltaX */ + /** \copydoc gridDeltaX */ void setGridDeltaX(double __value); - /*! \copydoc gridDeltaX */ + /** \copydoc gridDeltaX */ double getGridDeltaX() const; - /*! \copydoc gridDeltaY */ + /** \copydoc gridDeltaY */ void setGridDeltaY(double __value); - /*! \copydoc gridDeltaY */ + /** \copydoc gridDeltaY */ double getGridDeltaY() const; - /*! \copydoc gridSymbolFractionSize */ + /** \copydoc gridSymbolFractionSize */ void setGridSymbolFractionSize(double __value); - /*! \copydoc gridSymbolFractionSize */ + /** \copydoc gridSymbolFractionSize */ double getGridSymbolFractionSize() const; - /*! \copydoc symbolFillDerivationMode */ + /** \copydoc symbolFillDerivationMode */ JKQTPColorDerivationMode getSymbolFillDerivationMode() const; - /*! \copydoc symbolFillDerivationMode */ + /** \copydoc symbolFillDerivationMode */ void setSymbolFillDerivationMode(JKQTPColorDerivationMode m); /** \copydoc JKQTPGraph::setParent() */ diff --git a/lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h b/lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h index eb47b7e63c..a7e4392e02 100644 --- a/lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h +++ b/lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h @@ -86,21 +86,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPSingleColumnSymbolsGraph: public JKQTPSingleCo /** \brief set symbol color and fill color at the same time */ void setColor(QColor col); - /*! \copydoc position */ + /** \copydoc position */ void setPosition(double __value); - /*! \copydoc position */ + /** \copydoc position */ double getPosition() const; - /*! \copydoc width */ + /** \copydoc width */ void setWidth(double __value); - /*! \copydoc width */ + /** \copydoc width */ double getWidth() const; - /*! \copydoc positionScatterStyle */ + /** \copydoc positionScatterStyle */ void setPositionScatterStyle(ScatterStyle __value); - /*! \copydoc positionScatterStyle */ + /** \copydoc positionScatterStyle */ ScatterStyle getPositionScatterStyle() const; diff --git a/lib/jkqtplotter/graphs/jkqtpviolinplotstylingmixins.h b/lib/jkqtplotter/graphs/jkqtpviolinplotstylingmixins.h index d2fc17aedb..b5700ed74f 100644 --- a/lib/jkqtplotter/graphs/jkqtpviolinplotstylingmixins.h +++ b/lib/jkqtplotter/graphs/jkqtpviolinplotstylingmixins.h @@ -48,30 +48,30 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphViolinplotStyleMixin: public JKQTPGraphLi JKQTPGraphViolinplotStyleMixin(); void initViolinplotStyle(JKQTBasePlotter* parent, int &parentPlotStyle); - /*! \copydoc violinWidthAbsolute */ + /** \copydoc violinWidthAbsolute */ void setViolinWidthAbsolute(double __value); - /*! \copydoc violinWidthAbsolute */ + /** \copydoc violinWidthAbsolute */ double getViolinWidthAbsolute() const; - /*! \copydoc relativeWhiskerWidth */ + /** \copydoc relativeWhiskerWidth */ void setRelativeWhiskerWidth(double __value); - /*! \copydoc relativeWhiskerWidth */ + /** \copydoc relativeWhiskerWidth */ double getRelativeWhiskerWidth() const; - /*! \brief set the line style of whisker lines */ + /** \brief set the line style of whisker lines */ void setWhiskerLineStyle(Qt::PenStyle __value); - /*! \brief get the line style of whisker lines */ + /** \brief get the line style of whisker lines */ Qt::PenStyle getWhiskerLineStyle() const; - /*! \brief set the width [pt] of whisker lines */ + /** \brief set the width [pt] of whisker lines */ void setWhiskerLineWidth(double __value); - /*! \brief get the width [pt] of whisker lines */ + /** \brief get the width [pt] of whisker lines */ double getWhiskerLineWidth() const; - /*! \brief set the color of whisker lines */ + /** \brief set the color of whisker lines */ void setWhiskerLineColor(QColor __value); - /*! \brief get the color of whisker lines */ + /** \brief get the color of whisker lines */ QColor getWhiskerLineColor() const; @@ -121,19 +121,19 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphViolinplotStyleMixin: public JKQTPGraphLi - /*! \brief set the line style of whisker cap lines */ + /** \brief set the line style of whisker cap lines */ void setWhiskerCapLineStyle(Qt::PenStyle __value); - /*! \brief get the line style of whisker cap lines */ + /** \brief get the line style of whisker cap lines */ Qt::PenStyle getWhiskerCapLineStyle() const; - /*! \brief set the width [pt] of whisker cap lines */ + /** \brief set the width [pt] of whisker cap lines */ void setWhiskerCapLineWidth(double __value); - /*! \brief get the width [pt] of whisker cap lines */ + /** \brief get the width [pt] of whisker cap lines */ double getWhiskerCapLineWidth() const; - /*! \brief set the color of whisker cap lines */ + /** \brief set the color of whisker cap lines */ void setWhiskerCapLineColor(QColor __value); - /*! \brief get the color of whisker cap lines */ + /** \brief get the color of whisker cap lines */ QColor getWhiskerCapLineColor() const; @@ -183,19 +183,19 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphViolinplotStyleMixin: public JKQTPGraphLi - /*! \brief set the line style of median lines */ + /** \brief set the line style of median lines */ void setMedianLineStyle(Qt::PenStyle __value); - /*! \brief get the line style of median lines */ + /** \brief get the line style of median lines */ Qt::PenStyle getMedianLineStyle() const; - /*! \brief set the width [pt] of median lines */ + /** \brief set the width [pt] of median lines */ void setMedianLineWidth(double __value); - /*! \brief get the width [pt] of median lines */ + /** \brief get the width [pt] of median lines */ double getMedianLineWidth() const; - /*! \brief set the color of median lines */ + /** \brief set the color of median lines */ void setMedianLineColor(QColor __value); - /*! \brief get the color of median lines */ + /** \brief get the color of median lines */ QColor getMedianLineColor() const; @@ -247,9 +247,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphViolinplotStyleMixin: public JKQTPGraphLi - /*! \brief set the line style of Mean lines */ + /** \brief set the line style of Mean lines */ void setMeanLineStyle(Qt::PenStyle __value); - /*! \brief get the line style of Mean lines */ + /** \brief get the line style of Mean lines */ Qt::PenStyle getMeanLineStyle() const; /** \brief sets the dash offset for a custom dash style of Mean lines * \see https://doc.qt.io/qt-5/qpen.html#setDashOffset @@ -326,10 +326,10 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphViolinplotStyleMixin: public JKQTPGraphLi /** \brief constructs a QPen from the line styling properties */ QBrush getMeanSymbolBrush(JKQTPEnhancedPainter &painter, JKQTBasePlotter* parent) const; - /*! \brief set the color of the graph (colors all elements, based on the given color \a c )*/ + /** \brief set the color of the graph (colors all elements, based on the given color \a c ) */ void setViolinplotColor(QColor c, JKQTBasePlotter *parent); - /*! \brief set the color of the graph (colors all elements, based on the given color \a c , sets background colors from \a bc )*/ + /** \brief set the color of the graph (colors all elements, based on the given color \a c , sets background colors from \a bc ) */ void setViolinplotColor(QColor c, QColor bc, JKQTBasePlotter *parent); protected: /*! \brief plot a symbol at location x,y (in painter coordinates), using the current style diff --git a/lib/jkqtplotter/jkqtpbaseplotter.h b/lib/jkqtplotter/jkqtpbaseplotter.h index 6e748413c0..15563a878c 100644 --- a/lib/jkqtplotter/jkqtpbaseplotter.h +++ b/lib/jkqtplotter/jkqtpbaseplotter.h @@ -687,88 +687,88 @@ class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject { QBrush getExportBackgroundBrush() const; /** \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ QBrush getPlotBackgroundBrush() const; - /*! \copydoc JKQTPKeyStyle::fontSize */ + /** \copydoc JKQTPKeyStyle::fontSize */ double getKeyFontSize() const; - /*! \copydoc JKQTPKeyStyle::itemWidth */ + /** \copydoc JKQTPKeyStyle::itemWidth */ double getKeyItemWidth() const; - /*! \copydoc JKQTPKeyStyle::itemHeight */ + /** \copydoc JKQTPKeyStyle::itemHeight */ double getKeyItemHeight() const; - /*! \copydoc JKQTPKeyStyle::ySeparation */ + /** \copydoc JKQTPKeyStyle::ySeparation */ double getKeyYSeparation() const; - /*! \copydoc JKQTPKeyStyle::sampleLineLength */ + /** \copydoc JKQTPKeyStyle::sampleLineLength */ double getKeyLineLength() const; - /*! \copydoc JKQTPKeyStyle::xMargin */ + /** \copydoc JKQTPKeyStyle::xMargin */ double getKeyXMargin() const; - /*! \copydoc JKQTPKeyStyle::yMargin */ + /** \copydoc JKQTPKeyStyle::yMargin */ double getKeyYMargin() const; - /*! \copydoc JKQTPKeyStyle::xSeparation */ + /** \copydoc JKQTPKeyStyle::xSeparation */ double getKeyXSeparation() const; - /*! \copydoc JKQTPKeyStyle::xOffset */ + /** \copydoc JKQTPKeyStyle::xOffset */ double getKeyXOffset() const; - /*! \copydoc JKQTPKeyStyle::yOffset */ + /** \copydoc JKQTPKeyStyle::yOffset */ double getKeyYOffset() const; - /*! \copydoc JKQTPKeyStyle::visible */ + /** \copydoc JKQTPKeyStyle::visible */ bool getShowKey() const; - /*! \copydoc JKQTPKeyStyle::frameVisible */ + /** \copydoc JKQTPKeyStyle::frameVisible */ bool getShowKeyFrame() const; - /*! \copydoc JKQTPKeyStyle::frameColor */ + /** \copydoc JKQTPKeyStyle::frameColor */ QColor getKeyFrameColor() const; - /*! \copydoc JKQTPKeyStyle::backgroundBrush */ + /** \copydoc JKQTPKeyStyle::backgroundBrush */ QColor getKeyBackgroundColor() const; - /*! \copydoc JKQTPKeyStyle::backgroundBrush */ + /** \copydoc JKQTPKeyStyle::backgroundBrush */ QBrush getKeyBackgroundBrush() const; - /*! \copydoc JKQTPKeyStyle::textColor */ + /** \copydoc JKQTPKeyStyle::textColor */ QColor getKeyTextColor() const; - /*! \copydoc JKQTPKeyStyle::frameWidth */ + /** \copydoc JKQTPKeyStyle::frameWidth */ double getKeyFrameWidth() const; - /*! \copydoc JKQTPKeyStyle::frameRounding */ + /** \copydoc JKQTPKeyStyle::frameRounding */ double getKeyFrameRounding() const; - /*! \copydoc JKQTPKeyStyle::autosize */ + /** \copydoc JKQTPKeyStyle::autosize */ bool getKeyAutosize() const; - /*! \copydoc JKQTPKeyStyle::position */ + /** \copydoc JKQTPKeyStyle::position */ JKQTPKeyPosition getKeyPosition() const; - /*! \copydoc JKQTPKeyStyle::layout */ + /** \copydoc JKQTPKeyStyle::layout */ JKQTPKeyLayout getKeyLayout() const; - /*! \copydoc JKQTBasePlotterStyle::defaultTextColor */ + /** \copydoc JKQTBasePlotterStyle::defaultTextColor */ QColor getDefaultTextColor() const; - /*! \copydoc JKQTBasePlotterStyle::defaultFontSize */ + /** \copydoc JKQTBasePlotterStyle::defaultFontSize */ double getDefaultTextSize() const; - /*! \copydoc JKQTBasePlotterStyle::defaultFontName */ + /** \copydoc JKQTBasePlotterStyle::defaultFontName */ QString getDefaultTextFontName() const; /** \brief if set \c true (default: \c false ) the JKQTBasePlotter draws colored rectangles to indicate the different regions in the plot (border, axes, ...) * * \see JKQTBasePlotterStyle::debugShowRegionBoxes, enableDebugShowRegionBoxes() */ bool isDebugShowRegionBoxesEnabled() const; - /*! \copydoc JKQTBasePlotterStyle::plotFrameVisible */ + /** \copydoc JKQTBasePlotterStyle::plotFrameVisible */ bool isPlotFrameVisible() const; - /*! \copydoc JKQTBasePlotterStyle::plotFrameColor */ + /** \copydoc JKQTBasePlotterStyle::plotFrameColor */ QColor getPlotFrameColor() const; - /*! \copydoc JKQTBasePlotterStyle::plotFrameWidth */ + /** \copydoc JKQTBasePlotterStyle::plotFrameWidth */ double getPlotFrameWidth() const; - /*! \copydoc JKQTBasePlotterStyle::plotFrameRounding */ + /** \copydoc JKQTBasePlotterStyle::plotFrameRounding */ double getPlotFrameRounding() const; - /*! \copydoc JKQTBasePlotterStyle::plotLabelFontSize */ + /** \copydoc JKQTBasePlotterStyle::plotLabelFontSize */ double getPlotLabelFontSize() const; - /*! \copydoc JKQTBasePlotterStyle::plotLabelFontName */ + /** \copydoc JKQTBasePlotterStyle::plotLabelFontName */ QString getplotLabelFontName() const; - /*! \copydoc plotLabel */ + /** \copydoc plotLabel */ QString getPlotLabel() const; - /*! \copydoc gridPrinting */ + /** \copydoc gridPrinting */ void setGridPrinting(bool __value); - /*! \copydoc gridPrinting */ + /** \copydoc gridPrinting */ bool getGridPrinting() const; - /*! \copydoc gridPrintingCurrentX */ + /** \copydoc gridPrintingCurrentX */ void setGridPrintingCurrentX(size_t __value); - /*! \copydoc gridPrintingCurrentX */ + /** \copydoc gridPrintingCurrentX */ size_t getGridPrintingCurrentX() const; - /*! \copydoc gridPrintingCurrentY */ + /** \copydoc gridPrintingCurrentY */ void setGridPrintingCurrentY(size_t __value); - /*! \copydoc gridPrintingCurrentY */ + /** \copydoc gridPrintingCurrentY */ size_t getGridPrintingCurrentY() const; /** \brief set the x- and y-positions of this JKQTPlotter in the grid-printing grid @@ -787,17 +787,17 @@ class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject { /** \brief set the string used to introduce comments in text output when exporting data */ QString getCSVcommentInitializer() const; - /*! \copydoc internalPlotBorderTop */ + /** \copydoc internalPlotBorderTop */ inline double getInternalPlotBorderTop() const { return this->internalPlotBorderTop; } - /*! \copydoc internalPlotBorderLeft */ + /** \copydoc internalPlotBorderLeft */ inline double getInternalPlotBorderLeft() const { return this->internalPlotBorderLeft; } - /*! \copydoc internalPlotBorderBottom */ + /** \copydoc internalPlotBorderBottom */ inline double getInternalPlotBorderBottom() const { return this->internalPlotBorderBottom; } - /*! \copydoc internalPlotBorderRight */ + /** \copydoc internalPlotBorderRight */ inline double getInternalPlotBorderRight() const { return this->internalPlotBorderRight; } - /*! \copydoc internalPlotWidth */ + /** \copydoc internalPlotWidth */ inline int getPlotWidth() const { return this->internalPlotWidth; } - /*! \copydoc internalPlotHeight */ + /** \copydoc internalPlotHeight */ inline int getPlotHeight() const { return this->internalPlotHeight; } /** \brief returns the internal JKQTMathText, used to render text with LaTeX markup */ JKQTMathText* getMathText(); @@ -813,35 +813,35 @@ class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject { const JKQTPVerticalAxis *getYAxis() const; - /*! \copydoc actSavePlot */ + /** \copydoc actSavePlot */ QAction* getActionSavePlot() const; - /*! \copydoc actSaveData */ + /** \copydoc actSaveData */ QAction* getActionSaveData() const; - /*! \copydoc actCopyData */ + /** \copydoc actCopyData */ QAction* getActionCopyData() const; - /*! \copydoc actCopyPixelImage */ + /** \copydoc actCopyPixelImage */ QAction* getActionCopyPixelImage() const; - /*! \copydoc actCopyMatlab */ + /** \copydoc actCopyMatlab */ QAction* getActionCopyMatlab() const; - /*! \copydoc actSavePDF */ + /** \copydoc actSavePDF */ QAction* getActionSavePDF() const; - /*! \copydoc actSavePix */ + /** \copydoc actSavePix */ QAction* getActionSavePix() const; - /*! \copydoc actSaveSVG */ + /** \copydoc actSaveSVG */ QAction* getActionSaveSVG() const; - /*! \copydoc actPrint */ + /** \copydoc actPrint */ QAction* getActionPrint() const; - /*! \copydoc actSaveCSV */ + /** \copydoc actSaveCSV */ QAction* getActionSaveCSV() const; - /*! \copydoc actZoomAll */ + /** \copydoc actZoomAll */ QAction* getActionZoomAll() const; - /*! \copydoc actZoomIn */ + /** \copydoc actZoomIn */ QAction* getActionZoomIn() const; - /*! \copydoc actZoomOut */ + /** \copydoc actZoomOut */ QAction *getActionZoomOut() const; - /*! \copydoc actShowPlotData */ + /** \copydoc actShowPlotData */ QAction *getActionShowPlotData() const; - /*! \copydoc lstAdditionalPlotterActions */ + /** \copydoc lstAdditionalPlotterActions */ AdditionalActionsMap getLstAdditionalPlotterActions() const; /** \brief this function registers additional actions to lstAdditionalPlotterActions, which are displayed in the context-menu */ @@ -852,21 +852,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject { */ void deregisterAdditionalAction(QAction* act); - /*! \copydoc masterSynchronizeWidth */ + /** \copydoc masterSynchronizeWidth */ bool getMasterSynchronizeWidth() const; - /*! \copydoc masterSynchronizeHeight */ + /** \copydoc masterSynchronizeHeight */ bool getMasterSynchronizeHeight() const; - /*! \copydoc fontSizePrintMultiplier */ + /** \copydoc fontSizePrintMultiplier */ void setFontSizePrintMultiplier(double __value); - /*! \copydoc fontSizePrintMultiplier */ + /** \copydoc fontSizePrintMultiplier */ double getFontSizePrintMultiplier() const; - /*! \copydoc lineWidthPrintMultiplier */ + /** \copydoc lineWidthPrintMultiplier */ void setLineWidthPrintMultiplier(double __value); - /*! \copydoc lineWidthPrintMultiplier */ + /** \copydoc lineWidthPrintMultiplier */ double getLineWidthPrintMultiplier() const; - /*! \copydoc fontSizeMultiplier */ + /** \copydoc fontSizeMultiplier */ double getFontSizeMultiplier() const; - /*! \copydoc lineWidthMultiplier */ + /** \copydoc lineWidthMultiplier */ double getLineWidthMultiplier() const; @@ -1453,115 +1453,115 @@ class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject { void setAspectRatio(double __value); /** \brief sets the axis aspect ratio, enforced with setMaintainAxisApsectRatio(true) \see axisAspectRatio */ void setAxisAspectRatio(double __value); - /*! \copydoc JKQTBasePlotterStyle::useAntiAliasingForSystem */ + /** \copydoc JKQTBasePlotterStyle::useAntiAliasingForSystem */ void setUseAntiAliasingForSystem(bool __value); - /*! \copydoc JKQTBasePlotterStyle::useAntiAliasingForGraphs */ + /** \copydoc JKQTBasePlotterStyle::useAntiAliasingForGraphs */ void setUseAntiAliasingForGraphs(bool __value); - /*! \copydoc JKQTBasePlotterStyle::useAntiAliasingForText */ + /** \copydoc JKQTBasePlotterStyle::useAntiAliasingForText */ void setUseAntiAliasingForText(bool __value); - /*! \copydoc JKQTBasePlotterStyle::defaultGraphWidth */ + /** \copydoc JKQTBasePlotterStyle::defaultGraphWidth */ void setGraphWidth(double __value); - /*! \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ void setBackgroundColor(const QColor & __value); - /*! \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ void setExportBackgroundColor(const QColor & __value); - /*! \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ void setPlotBackgroundColor(const QColor & __value); - /*! \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ void setBackgroundBrush(const QBrush & __value); - /*! \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ void setExportBackgroundBrush(const QBrush & __value); - /*! \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ void setPlotBackgroundBrush(const QBrush & __value); - /*! \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ void setBackgroundGradient(const QGradient & __value); - /*! \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ void setExportBackgroundGradient(const QGradient & __value); - /*! \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ void setPlotBackgroundGradient(const QGradient & __value); - /*! \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ void setBackgroundTexture(const QPixmap & __value); - /*! \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ void setExportBackgroundTexture(const QPixmap & __value); - /*! \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ void setPlotBackgroundTexture(const QPixmap & __value); - /*! \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::widgetBackgroundBrush */ void setBackgroundTexture(const QImage & __value); - /*! \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::exportBackgroundBrush */ void setExportBackgroundTexture(const QImage & __value); - /*! \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ + /** \copydoc JKQTBasePlotterStyle::plotBackgroundBrush */ void setPlotBackgroundTexture(const QImage & __value); - /*! \copydoc JKQTPKeyStyle::textColor */ + /** \copydoc JKQTPKeyStyle::textColor */ void setKeyTextColor(const QColor & __value); - /*! \copydoc JKQTBasePlotterStyle::plotFrameWidth */ + /** \copydoc JKQTBasePlotterStyle::plotFrameWidth */ void setPlotFrameWidth(double __value); - /*! \copydoc JKQTBasePlotterStyle::plotFrameRounding */ + /** \copydoc JKQTBasePlotterStyle::plotFrameRounding */ void setPlotFrameRounding(double __value); - /*! \copydoc JKQTBasePlotterStyle::plotFrameColor */ + /** \copydoc JKQTBasePlotterStyle::plotFrameColor */ void setPlotFrameColor(QColor col); - /*! \copydoc JKQTBasePlotterStyle::plotFrameVisible */ + /** \copydoc JKQTBasePlotterStyle::plotFrameVisible */ void setPlotFrameVisible(bool enabled); - /*! \copydoc JKQTPKeyStyle::fontSize */ + /** \copydoc JKQTPKeyStyle::fontSize */ void setKeyFontSize(double __value); - /*! \copydoc JKQTPKeyStyle::itemWidth */ + /** \copydoc JKQTPKeyStyle::itemWidth */ void setKeyItemWidth(double __value); - /*! \copydoc JKQTPKeyStyle::itemHeight */ + /** \copydoc JKQTPKeyStyle::itemHeight */ void setKeyItemHeight(double __value); - /*! \copydoc JKQTPKeyStyle::ySeparation */ + /** \copydoc JKQTPKeyStyle::ySeparation */ void setKeyYSeparation(double __value); - /*! \copydoc JKQTPKeyStyle::sampleLineLength */ + /** \copydoc JKQTPKeyStyle::sampleLineLength */ void setKeyLineLength(double __value); - /*! \copydoc JKQTPKeyStyle::xMargin */ + /** \copydoc JKQTPKeyStyle::xMargin */ void setKeyXMargin(double __value); - /*! \copydoc JKQTPKeyStyle::yMargin */ + /** \copydoc JKQTPKeyStyle::yMargin */ void setKeyYMargin(double __value); - /*! \copydoc JKQTPKeyStyle::xSeparation */ + /** \copydoc JKQTPKeyStyle::xSeparation */ void setKeyXSeparation(double __value); - /*! \copydoc JKQTPKeyStyle::yOffset */ + /** \copydoc JKQTPKeyStyle::yOffset */ void setKeyXOffset(double __value); - /*! \copydoc JKQTPKeyStyle::xOffset */ + /** \copydoc JKQTPKeyStyle::xOffset */ void setKeyYOffset(double __value); - /*! \copydoc JKQTPKeyStyle::visible */ + /** \copydoc JKQTPKeyStyle::visible */ void setShowKey(bool __value); - /*! \copydoc JKQTPKeyStyle::frameVisible */ + /** \copydoc JKQTPKeyStyle::frameVisible */ void setShowKeyFrame(bool __value); - /*! \copydoc JKQTPKeyStyle::frameColor */ + /** \copydoc JKQTPKeyStyle::frameColor */ void setKeyFrameColor(const QColor & __value); - /*! \copydoc JKQTPKeyStyle::backgroundBrush */ + /** \copydoc JKQTPKeyStyle::backgroundBrush */ void setKeyBackgroundColor(const QColor & __value, Qt::BrushStyle __style); - /*! \copydoc JKQTPKeyStyle::backgroundBrush */ + /** \copydoc JKQTPKeyStyle::backgroundBrush */ void setKeyBackgroundBrush(const QBrush & __value); - /*! \copydoc JKQTPKeyStyle::backgroundBrush */ + /** \copydoc JKQTPKeyStyle::backgroundBrush */ void setKeyBackgroundGradient(const QGradient & __value); - /*! \copydoc JKQTPKeyStyle::backgroundBrush */ + /** \copydoc JKQTPKeyStyle::backgroundBrush */ void setKeyBackgroundTexture(const QImage & __value); - /*! \copydoc JKQTPKeyStyle::backgroundBrush */ + /** \copydoc JKQTPKeyStyle::backgroundBrush */ void setKeyBackgroundTexture(const QPixmap & __value); - /*! \copydoc JKQTPKeyStyle::frameWidth */ + /** \copydoc JKQTPKeyStyle::frameWidth */ void setKeyFrameWidth(double __value); - /*! \copydoc JKQTPKeyStyle::frameRounding */ + /** \copydoc JKQTPKeyStyle::frameRounding */ void setKeyFrameRounding(double __value); - /*! \copydoc JKQTPKeyStyle::autosize */ + /** \copydoc JKQTPKeyStyle::autosize */ void setKeyAutosize(bool __value); - /*! \copydoc JKQTPKeyStyle::position */ + /** \copydoc JKQTPKeyStyle::position */ void setKeyPosition(const JKQTPKeyPosition & __value); - /*! \copydoc JKQTPKeyStyle::layout */ + /** \copydoc JKQTPKeyStyle::layout */ void setKeyLayout(const JKQTPKeyLayout & __value); - /*! \copydoc JKQTBasePlotterStyle::plotLabelFontSize */ + /** \copydoc JKQTBasePlotterStyle::plotLabelFontSize */ void setPlotLabelFontSize(double __value); - /*! \copydoc JKQTBasePlotterStyle::plotLabelFontName */ + /** \copydoc JKQTBasePlotterStyle::plotLabelFontName */ void setplotLabelFontName(const QString & __value); /** \brief set the plot label text */ void setPlotLabel(const QString & __value); - /*! \copydoc JKQTBasePlotterStyle::defaultTextColor */ + /** \copydoc JKQTBasePlotterStyle::defaultTextColor */ void setDefaultTextColor(QColor __value) ; - /*! \copydoc JKQTBasePlotterStyle::defaultFontSize */ + /** \copydoc JKQTBasePlotterStyle::defaultFontSize */ void setDefaultTextSize(double __value) ; - /*! \copydoc JKQTBasePlotterStyle::defaultFontName */ + /** \copydoc JKQTBasePlotterStyle::defaultFontName */ void setDefaultTextFontName(const QString& __value) ; /** \brief sets the current directory in which to open SaveAs ... dialogs */ void setCurrentSaveDirectory(const QString & __value); @@ -1651,17 +1651,17 @@ class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject { /** \brief show the export preview window for a given page size \a pageSize, either in pixels (\a unitIsMM \c ==false ) or in millimeters (\a unitIsMM \c ==true ) */ bool exportpreview(QSizeF pageSize, bool unitIsMM=false); - /*! \copydoc fontSizeMultiplier */ + /** \copydoc fontSizeMultiplier */ void setFontSizeMultiplier(double __value); - /*! \copydoc lineWidthMultiplier */ + /** \copydoc lineWidthMultiplier */ void setLineWidthMultiplier(double __value); - /*! \copydoc printMagnification */ + /** \copydoc printMagnification */ void setPrintMagnification(double __value); - /*! \copydoc printMagnification */ + /** \copydoc printMagnification */ double getPrintMagnification() const; - /*! \copydoc paintMagnification */ + /** \copydoc paintMagnification */ void setPaintMagnification(double __value); - /*! \copydoc paintMagnification */ + /** \copydoc paintMagnification */ double getPaintMagnification() const; diff --git a/lib/jkqtplotter/jkqtpcoordinateaxes.h b/lib/jkqtplotter/jkqtpcoordinateaxes.h index c77e3401f1..b28a723b86 100644 --- a/lib/jkqtplotter/jkqtpcoordinateaxes.h +++ b/lib/jkqtplotter/jkqtpcoordinateaxes.h @@ -231,113 +231,113 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPCoordinateAxis: public QObject { virtual void drawGrids(JKQTPEnhancedPainter& painter)=0; - /*! \copydoc tickSpacing */ + /** \copydoc tickSpacing */ inline double getTickSpacing() const { return this->tickSpacing; } - /*! \copydoc JKQTPCoordinateAxisStyle::labelDigits */ + /** \copydoc JKQTPCoordinateAxisStyle::labelDigits */ inline int getLabelDigits() const { return this->axisStyle.labelDigits; } - /*! \copydoc autoAxisSpacing */ + /** \copydoc autoAxisSpacing */ inline bool getAutoAxisSpacing() const { return this->autoAxisSpacing; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickLabelsEnabled */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickLabelsEnabled */ inline bool getMinorTickLabelsEnabled() const { return this->axisStyle.minorTickLabelsEnabled; } - /*! \copydoc logAxis */ + /** \copydoc logAxis */ inline bool getLogAxis() const { return this->logAxis; } - /*! \copydoc inverted */ + /** \copydoc inverted */ inline bool getInverted() const { return this->inverted; } - /*! \copydoc logAxisBase */ + /** \copydoc logAxisBase */ inline double getLogAxisBase() const { return this->logAxisBase; } - /*! \copydoc userTickSpacing */ + /** \copydoc userTickSpacing */ inline double getUserTickSpacing() const { return this->userTickSpacing; } - /*! \copydoc userLogTickSpacing */ + /** \copydoc userLogTickSpacing */ inline double getUserLogTickSpacing() const { return this->userLogTickSpacing; } - /*! \copydoc JKQTPCoordinateAxisStyle::labelType */ + /** \copydoc JKQTPCoordinateAxisStyle::labelType */ inline JKQTPCALabelType getLabelType() const { return this->axisStyle.labelType; } - /*! \copydoc axisLabel */ + /** \copydoc axisLabel */ inline QString getAxisLabel() const { return this->axisLabel; } - /*! \copydoc JKQTPCoordinateAxisStyle::labelPosition */ + /** \copydoc JKQTPCoordinateAxisStyle::labelPosition */ inline JKQTPLabelPosition getLabelPosition() const { return this->axisStyle.labelPosition; } - /*! \copydoc JKQTPCoordinateAxisStyle::labelFontSize */ + /** \copydoc JKQTPCoordinateAxisStyle::labelFontSize */ inline double getLabelFontSize() const { return this->axisStyle.labelFontSize; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickLabelFontSize */ + /** \copydoc JKQTPCoordinateAxisStyle::tickLabelFontSize */ inline double getTickLabelFontSize() const { return this->axisStyle.tickLabelFontSize; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickLabelFontSize */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickLabelFontSize */ inline double getMinorTickLabelFontSize() const { return this->axisStyle.minorTickLabelFontSize; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickLabelFullNumber */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickLabelFullNumber */ inline bool getMinorTickLabelFullNumber() const { return this->axisStyle.minorTickLabelFullNumber; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickLabelAngle */ + /** \copydoc JKQTPCoordinateAxisStyle::tickLabelAngle */ inline double getTickLabelAngle() const { return this->axisStyle.tickLabelAngle; } - /*! \copydoc JKQTPCoordinateAxisStyle::minTicks */ + /** \copydoc JKQTPCoordinateAxisStyle::minTicks */ inline unsigned int getMinTicks() const { return this->axisStyle.minTicks; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorTicks */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTicks */ inline unsigned int getMinorTicks() const { return this->axisStyle.minorTicks; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickOutsideLength */ + /** \copydoc JKQTPCoordinateAxisStyle::tickOutsideLength */ inline double getTickOutsideLength() const { return this->axisStyle.tickOutsideLength; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickOutsideLength */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickOutsideLength */ inline double getMinorTickOutsideLength() const { return this->axisStyle.minorTickOutsideLength; } - /*! \copydoc JKQTPCoordinateAxisStyle::axisColor */ + /** \copydoc JKQTPCoordinateAxisStyle::axisColor */ inline QColor getAxisColor() const { return this->axisStyle.axisColor; } - /*! \copydoc JKQTPCoordinateAxisStyle::showZeroAxis */ + /** \copydoc JKQTPCoordinateAxisStyle::showZeroAxis */ inline bool getShowZeroAxis() const { return this->axisStyle.showZeroAxis; } - /*! \copydoc JKQTPCoordinateAxisStyle::gridColor */ + /** \copydoc JKQTPCoordinateAxisStyle::gridColor */ inline QColor getGridColor() const { return this->axisStyle.gridColor; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorGridColor */ + /** \copydoc JKQTPCoordinateAxisStyle::minorGridColor */ inline QColor getMinorGridColor() const { return this->axisStyle.minorGridColor; } - /*! \copydoc JKQTPCoordinateAxisStyle::gridWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::gridWidth */ inline double getGridWidth() const { return this->axisStyle.gridWidth; } - /*! \copydoc JKQTPCoordinateAxisStyle::gridStyle */ + /** \copydoc JKQTPCoordinateAxisStyle::gridStyle */ inline Qt::PenStyle getGridStyle() const { return this->axisStyle.gridStyle; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorGridWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::minorGridWidth */ inline double getMinorGridWidth() const { return this->axisStyle.minorGridWidth; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorGridStyle */ + /** \copydoc JKQTPCoordinateAxisStyle::minorGridStyle */ inline Qt::PenStyle getMinorGridStyle() const { return this->axisStyle.minorGridStyle; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickTimeFormat */ + /** \copydoc JKQTPCoordinateAxisStyle::tickTimeFormat */ inline QString getTickTimeFormat() const { return this->axisStyle.tickTimeFormat; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickDateFormat */ + /** \copydoc JKQTPCoordinateAxisStyle::tickDateFormat */ inline QString getTickDateFormat() const { return this->axisStyle.tickDateFormat; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickDateTimeFormat */ + /** \copydoc JKQTPCoordinateAxisStyle::tickDateTimeFormat */ inline QString getTickDateTimeFormat() const { return this->axisStyle.tickDateTimeFormat; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickMode */ + /** \copydoc JKQTPCoordinateAxisStyle::tickMode */ inline JKQTPLabelTickMode getTickMode() const { return this->axisStyle.tickMode; } - /*! \copydoc JKQTPCoordinateAxisStyle::drawMode1 */ + /** \copydoc JKQTPCoordinateAxisStyle::drawMode1 */ inline JKQTPCADrawMode getDrawMode1() const { return this->axisStyle.drawMode1; } - /*! \copydoc JKQTPCoordinateAxisStyle::drawMode2 */ + /** \copydoc JKQTPCoordinateAxisStyle::drawMode2 */ inline JKQTPCADrawMode getDrawMode2() const { return this->axisStyle.drawMode2; } - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickWidth */ inline double getMinorTickWidth() const { return this->axisStyle.minorTickWidth; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::tickWidth */ inline double getTickWidth() const { return this->axisStyle.tickWidth; } - /*! \copydoc JKQTPCoordinateAxisStyle::lineWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::lineWidth */ inline double getLineWidth() const { return this->axisStyle.lineWidth; } - /*! \copydoc JKQTPCoordinateAxisStyle::lineWidthZeroAxis */ + /** \copydoc JKQTPCoordinateAxisStyle::lineWidthZeroAxis */ inline double getLineWidthZeroAxis() const { return this->axisStyle.lineWidthZeroAxis; } - /*! \copydoc JKQTPCoordinateAxisStyle::tickLabelDistance */ + /** \copydoc JKQTPCoordinateAxisStyle::tickLabelDistance */ inline double getTickLabelDistance() const { return this->axisStyle.tickLabelDistance; } - /*! \copydoc JKQTPCoordinateAxisStyle::labelDistance */ + /** \copydoc JKQTPCoordinateAxisStyle::labelDistance */ inline double getLabelDistance() const { return this->axisStyle.labelDistance; } - /*! \copydoc JKQTPCoordinateAxisStyle::drawGrid */ + /** \copydoc JKQTPCoordinateAxisStyle::drawGrid */ inline bool getDrawGrid() const { return this->axisStyle.drawGrid; } - /*! \copydoc JKQTPCoordinateAxisStyle::drawMinorGrid */ + /** \copydoc JKQTPCoordinateAxisStyle::drawMinorGrid */ inline bool getDrawMinorGrid() const { return this->axisStyle.drawMinorGrid; } - /*! \copydoc JKQTPCoordinateAxisStyle::autoLabelDigits */ + /** \copydoc JKQTPCoordinateAxisStyle::autoLabelDigits */ inline void setAutoLabelDigits(bool __value) { this->axisStyle.autoLabelDigits = __value; } - /*! \copydoc JKQTPCoordinateAxisStyle::autoLabelDigits */ + /** \copydoc JKQTPCoordinateAxisStyle::autoLabelDigits */ inline bool getAutoLabelDigits() const { return this->axisStyle.autoLabelDigits; } - /*! \copydoc parent */ + /** \copydoc parent */ inline const JKQTBasePlotter* getParent() const { return this->parent; } - /*! \copydoc parent */ + /** \copydoc parent */ inline JKQTBasePlotter* getParent() { return this->parent; } - /*! \copydoc doUpdateScaling */ + /** \copydoc doUpdateScaling */ inline void setDoUpdateScaling(bool __value) { this->doUpdateScaling = __value; } - /*! \copydoc doUpdateScaling */ + /** \copydoc doUpdateScaling */ inline bool getDoUpdateScaling() const { return this->doUpdateScaling; @@ -416,150 +416,150 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPCoordinateAxis: public QObject { /** \brief do not use an absolute range of plot axis */ void setNoAbsoluteRange(); - /*! \copydoc tickSpacing */ + /** \copydoc tickSpacing */ void setTickSpacing(double __value); - /*! \copydoc axisMinWidth */ + /** \copydoc axisMinWidth */ void setAxisMinWidth(double __value); - /*! \copydoc autoAxisSpacing */ + /** \copydoc autoAxisSpacing */ void setAutoAxisSpacing(bool __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickLabelsEnabled */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickLabelsEnabled */ void setMinorTickLabelsEnabled(bool __value); - /*! \copydoc logAxis */ + /** \copydoc logAxis */ void setLogAxis(bool __value) ; - /*! \copydoc logAxisBase */ + /** \copydoc logAxisBase */ void setLogAxisBase (double __value); - /*! \copydoc userTickSpacing */ + /** \copydoc userTickSpacing */ void setUserTickSpacing (double __value); - /*! \copydoc userLogTickSpacing */ + /** \copydoc userLogTickSpacing */ void setUserLogTickSpacing (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::labelType */ + /** \copydoc JKQTPCoordinateAxisStyle::labelType */ void setLabelType (JKQTPCALabelType __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickMode */ + /** \copydoc JKQTPCoordinateAxisStyle::tickMode */ void setTickMode (JKQTPLabelTickMode __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickMode */ + /** \copydoc JKQTPCoordinateAxisStyle::tickMode */ void setTickMode (int __value); - /*! \copydoc axisLabel */ + /** \copydoc axisLabel */ void setAxisLabel (const QString& __value); - /*! \copydoc JKQTPCoordinateAxisStyle::labelPosition */ + /** \copydoc JKQTPCoordinateAxisStyle::labelPosition */ void setLabelPosition (JKQTPLabelPosition __value); - /*! \copydoc JKQTPCoordinateAxisStyle::labelFontSize */ + /** \copydoc JKQTPCoordinateAxisStyle::labelFontSize */ void setLabelFontSize (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickTimeFormat */ + /** \copydoc JKQTPCoordinateAxisStyle::tickTimeFormat */ void setTickTimeFormat (const QString& __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickDateFormat */ + /** \copydoc JKQTPCoordinateAxisStyle::tickDateFormat */ void setTickDateFormat (const QString& __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickDateTimeFormat */ + /** \copydoc JKQTPCoordinateAxisStyle::tickDateTimeFormat */ void setTickDateTimeFormat (const QString& __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickLabelFontSize */ + /** \copydoc JKQTPCoordinateAxisStyle::tickLabelFontSize */ void setTickLabelFontSize (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickLabelFontSize */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickLabelFontSize */ void setMinorTickLabelFontSize (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickLabelFullNumber */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickLabelFullNumber */ void setMinorTickLabelFullNumber (bool __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minTicks */ + /** \copydoc JKQTPCoordinateAxisStyle::minTicks */ void setMinTicks(unsigned int __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorTicks */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTicks */ void setMinorTicks (unsigned int __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorTicks */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTicks */ void setMinorTicks (int __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickOutsideLength */ + /** \copydoc JKQTPCoordinateAxisStyle::tickOutsideLength */ void setTickOutsideLength(double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickOutsideLength */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickOutsideLength */ void setMinorTickOutsideLength (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickInsideLength */ + /** \copydoc JKQTPCoordinateAxisStyle::tickInsideLength */ void setTickInsideLength(double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickInsideLength */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickInsideLength */ void setMinorTickInsideLength (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::axisColor */ + /** \copydoc JKQTPCoordinateAxisStyle::axisColor */ void setAxisColor (const QColor& __value); - /*! \copydoc JKQTPCoordinateAxisStyle::showZeroAxis */ + /** \copydoc JKQTPCoordinateAxisStyle::showZeroAxis */ void setShowZeroAxis(bool __value); - /*! \copydoc inverted */ + /** \copydoc inverted */ void setInverted(bool __value); - /*! \copydoc JKQTPCoordinateAxisStyle::gridColor */ + /** \copydoc JKQTPCoordinateAxisStyle::gridColor */ void setGridColor(const QColor& __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorGridColor */ + /** \copydoc JKQTPCoordinateAxisStyle::minorGridColor */ void setMinorGridColor(const QColor& __value); - /*! \copydoc JKQTPCoordinateAxisStyle::gridWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::gridWidth */ void setGridWidth (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::gridStyle */ + /** \copydoc JKQTPCoordinateAxisStyle::gridStyle */ void setGridStyle(Qt::PenStyle __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorGridWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::minorGridWidth */ void setMinorGridWidth(double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorGridStyle */ + /** \copydoc JKQTPCoordinateAxisStyle::minorGridStyle */ void setMinorGridStyle (Qt::PenStyle __value); - /*! \copydoc JKQTPCoordinateAxisStyle::drawMode1 */ + /** \copydoc JKQTPCoordinateAxisStyle::drawMode1 */ void setDrawMode1 (JKQTPCADrawMode __value); - /*! \copydoc JKQTPCoordinateAxisStyle::drawMode2 */ + /** \copydoc JKQTPCoordinateAxisStyle::drawMode2 */ void setDrawMode2(JKQTPCADrawMode __value); - /*! \copydoc JKQTPCoordinateAxisStyle::minorTickWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::minorTickWidth */ void setMinorTickWidth(double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::tickWidth */ void setTickWidth (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::lineWidth */ + /** \copydoc JKQTPCoordinateAxisStyle::lineWidth */ void setLineWidth (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::lineWidthZeroAxis */ + /** \copydoc JKQTPCoordinateAxisStyle::lineWidthZeroAxis */ void setLineWidthZeroAxis (double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickLabelDistance */ + /** \copydoc JKQTPCoordinateAxisStyle::tickLabelDistance */ void setTickLabelDistance(double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::labelDistance */ + /** \copydoc JKQTPCoordinateAxisStyle::labelDistance */ void setLabelDistance(double __value); - /*! \copydoc JKQTPCoordinateAxisStyle::labelDigits */ + /** \copydoc JKQTPCoordinateAxisStyle::labelDigits */ void setLabelDigits(int __value); - /*! \copydoc JKQTPCoordinateAxisStyle::drawGrid */ + /** \copydoc JKQTPCoordinateAxisStyle::drawGrid */ void setDrawGrid(bool __value); - /*! \copydoc JKQTPCoordinateAxisStyle::drawMinorGrid */ + /** \copydoc JKQTPCoordinateAxisStyle::drawMinorGrid */ void setDrawMinorGrid(bool __value); - /*! \copydoc JKQTPCoordinateAxisStyle::tickLabelAngle */ + /** \copydoc JKQTPCoordinateAxisStyle::tickLabelAngle */ void setTickLabelAngle(double __value); protected: diff --git a/lib/jkqtplotter/jkqtpdatastorage.h b/lib/jkqtplotter/jkqtpdatastorage.h index 6c286b0a7a..58195fa0b5 100644 --- a/lib/jkqtplotter/jkqtpdatastorage.h +++ b/lib/jkqtplotter/jkqtpdatastorage.h @@ -1474,14 +1474,14 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColumn { && (valid==other.valid); } - /*! \copydoc name */ + /** \copydoc name */ void setName (const QString& __value); - /*! \copydoc name */ + /** \copydoc name */ QString getName () const; - /*! \copydoc imageColumns */ + /** \copydoc imageColumns */ void setImageColumns (size_t imageWidth); - /*! \copydoc imageColumns */ + /** \copydoc imageColumns */ inline size_t getImageColumns () const { return imageColumns; } /** \brief returns the number of rows in this column (accesses the datastore) */ @@ -1599,10 +1599,10 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColumn { /** \brief calculates a checksum over the contents of the column (using qChecksum()) */ inline quint16 calculateChecksum() const; - /*! \copydoc datastoreItem */ \ + /** \copydoc datastoreItem */ \ inline size_t getDatastoreItemNum() const \ { return this->datastoreItem; } - /*! \copydoc datastoreOffset */ \ + /** \copydoc datastoreOffset */ \ inline size_t getDatastoreOffset() const \ { return this->datastoreOffset; } @@ -2290,10 +2290,10 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPDatastoreItem { /** \brief change the size of all columns to the givne number of rows. Returns \c true if the old data could be retained/saved and \c false if the old data was lost (which happens in most of the cases!) */ bool resizeColumns(size_t rows); - /*! \copydoc JKQTPDatastoreItem::rows */ + /** \copydoc JKQTPDatastoreItem::rows */ inline size_t getRows() const { return rows; } - /*! \copydoc JKQTPDatastoreItem::columns */ + /** \copydoc JKQTPDatastoreItem::columns */ inline size_t getColumns() const { return columns; } diff --git a/lib/jkqtplotter/jkqtpgraphsbase.h b/lib/jkqtplotter/jkqtpgraphsbase.h index f3cd827c31..856a98f05d 100644 --- a/lib/jkqtplotter/jkqtpgraphsbase.h +++ b/lib/jkqtplotter/jkqtpgraphsbase.h @@ -91,11 +91,11 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPlotElement: public QObject { /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const=0; - /*! \brief returns the the title of the plot */ + /** \brief returns the the title of the plot */ QString getTitle() const; - /*! \brief returns whether the graph is visible in the plot */ + /** \brief returns whether the graph is visible in the plot */ bool isVisible() const; - /*! \brief returns whether the graph is shown in a highlighted style in the plot */ + /** \brief returns whether the graph is shown in a highlighted style in the plot */ bool isHighlighted() const; /** \brief returns the parent painter class */ @@ -111,9 +111,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPlotElement: public QObject { Q_PROPERTY(QString title READ getTitle WRITE setTitle) Q_PROPERTY(bool highlighted READ isHighlighted WRITE setHighlighted) public slots: - /*! \brief sets whether the graph is visible in the plot */ + /** \brief sets whether the graph is visible in the plot */ void setVisible(bool __value); - /*! \brief sets whether the graph is drawn in a highlighted style in the plot */ + /** \brief sets whether the graph is drawn in a highlighted style in the plot */ void setHighlighted(bool __value); /** \brief sets the title of the plot (for display in key!). * @@ -578,11 +578,11 @@ public: /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int column) const override; - /*! \copydoc xColumn */ + /** \copydoc xColumn */ int getXColumn() const; - /*! \copydoc yColumn */ + /** \copydoc yColumn */ int getYColumn() const; - /*! \copydoc sortData */ + /** \copydoc sortData */ DataSortOrder getDataSortOrder() const; Q_PROPERTY(DataSortOrder sortData READ getDataSortOrder WRITE setDataSortOrder) @@ -613,17 +613,17 @@ public slots: void setXYColumns(QPair xyColPair); /** \brief sets xColumn and yColumn at the same time */ void setXYColumns(QPair xyColPair); - /*! \copydoc sortData */ + /** \copydoc sortData */ void setDataSortOrder(int __value); - /*! \copydoc sortData */ + /** \copydoc sortData */ void setDataSortOrder(DataSortOrder __value); - /*! \copydoc xColumn */ + /** \copydoc xColumn */ void setXColumn(int __value); - /*! \copydoc xColumn */ + /** \copydoc xColumn */ void setXColumn (size_t __value); - /*! \copydoc yColumn */ + /** \copydoc yColumn */ void setYColumn(int __value); - /*! \copydoc yColumn */ + /** \copydoc yColumn */ void setYColumn (size_t __value); protected: @@ -713,7 +713,7 @@ public: /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int column) const override; - /*! \copydoc yColumn2 */ + /** \copydoc yColumn2 */ int getYColumn2() const; /** \copydoc JKQTPXYGraph::hitTest() */ @@ -727,9 +727,9 @@ public slots: void setXYYColumns(int xCol, int yCol, int y2Col); - /*! \copydoc yColumn2 */ + /** \copydoc yColumn2 */ void setYColumn2(int __value); - /*! \copydoc yColumn2 */ + /** \copydoc yColumn2 */ void setYColumn2(size_t __value); protected: @@ -770,7 +770,7 @@ public: /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int column) const override; - /*! \copydoc xColumn2 */ + /** \copydoc xColumn2 */ int getXColumn2() const; /** \copydoc JKQTPXYGraph::hitTest() */ @@ -784,9 +784,9 @@ public slots: void setXXYColumns(int xCol, int x2Col, int yCol); - /*! \copydoc yColumn2 */ + /** \copydoc yColumn2 */ void setXColumn2(int __value); - /*! \copydoc yColumn2 */ + /** \copydoc yColumn2 */ void setXColumn2(size_t __value); protected: @@ -840,14 +840,14 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPSingleColumnGraph: public JKQTPGraph { /** \brief class constructor */ JKQTPSingleColumnGraph(JKQTBasePlotter* parent=nullptr); - /*! \copydoc dataColumn */ + /** \copydoc dataColumn */ int getDataColumn() const; - /*! \copydoc sortData */ + /** \copydoc sortData */ DataSortOrder getDataSortOrder() const; - /*! \copydoc dataDirection */ + /** \copydoc dataDirection */ DataDirection getDataDirection() const; /** \copydoc JKQTPGraph::usesColumn() */ @@ -858,15 +858,15 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPSingleColumnGraph: public JKQTPGraph { Q_PROPERTY(DataDirection dataDirection READ getDataDirection WRITE setDataDirection) public slots: - /*! \copydoc dataColumn */ + /** \copydoc dataColumn */ void setDataColumn(int __value); - /*! \copydoc dataColumn */ + /** \copydoc dataColumn */ void setDataColumn (size_t __value); - /*! \copydoc dataDirection */ + /** \copydoc dataDirection */ void setDataDirection(DataDirection __value); - /*! \copydoc sortData */ + /** \copydoc sortData */ void setDataSortOrder(int __value); - /*! \copydoc sortData */ + /** \copydoc sortData */ void setDataSortOrder(DataSortOrder __value); protected: diff --git a/lib/jkqtplotter/jkqtpgraphsbaseerrors.h b/lib/jkqtplotter/jkqtpgraphsbaseerrors.h index 4dbc1fd3f1..c154525821 100644 --- a/lib/jkqtplotter/jkqtpgraphsbaseerrors.h +++ b/lib/jkqtplotter/jkqtpgraphsbaseerrors.h @@ -53,9 +53,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphErrorStyleMixin { - /*! \copydoc m_errorBarCapSize */ + /** \copydoc m_errorBarCapSize */ void setErrorBarCapSize(double __value); - /*! \copydoc m_errorBarCapSize */ + /** \copydoc m_errorBarCapSize */ double getErrorBarCapSize() const; @@ -198,17 +198,17 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXGraphErrorData { JKQTPXGraphErrorData(); virtual ~JKQTPXGraphErrorData()=default; - /*! \copydoc xErrorSymmetric*/ + /** \copydoc xErrorSymmetric */ void setXErrorSymmetric(bool __value); - /*! \copydoc xErrorSymmetric */ + /** \copydoc xErrorSymmetric */ bool getXErrorSymmetric() const; - /*! \copydoc xErrorColumnLower */ + /** \copydoc xErrorColumnLower */ int getXErrorColumnLower() const; - /*! \copydoc xErrorColumn */ + /** \copydoc xErrorColumn */ int getXErrorColumn() const; - /*! \copydoc xErrorStyle */ + /** \copydoc xErrorStyle */ void setXErrorStyle(JKQTPErrorPlotstyle __value); - /*! \copydoc xErrorStyle */ + /** \copydoc xErrorStyle */ JKQTPErrorPlotstyle getXErrorStyle() const; /** \copydoc xErrorColumn */ void setXErrorColumn(int __value); @@ -248,21 +248,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPYGraphErrorData { JKQTPYGraphErrorData(); virtual ~JKQTPYGraphErrorData()=default; - /*! \copydoc yErrorSymmetric */ + /** \copydoc yErrorSymmetric */ void setYErrorSymmetric(bool __value); - /*! \copydoc yErrorSymmetric */ + /** \copydoc yErrorSymmetric */ bool getYErrorSymmetric() const; - /*! \copydoc yErrorColumnLower */ + /** \copydoc yErrorColumnLower */ int getYErrorColumnLower() const; - /*! \copydoc yErrorColumn */ + /** \copydoc yErrorColumn */ int getYErrorColumn() const; - /*! \copydoc yErrorStyle */ + /** \copydoc yErrorStyle */ void setYErrorStyle(JKQTPErrorPlotstyle __value); - /*! \copydoc yErrorStyle */ + /** \copydoc yErrorStyle */ JKQTPErrorPlotstyle getYErrorStyle() const; - /*! \copydoc yErrorColumn */ + /** \copydoc yErrorColumn */ void setYErrorColumn(int __value); - /*! \copydoc yErrorColumnLower */ + /** \copydoc yErrorColumnLower */ void setYErrorColumnLower(int __value); diff --git a/lib/jkqtplotter/jkqtpgraphsbasestylingmixins.h b/lib/jkqtplotter/jkqtpgraphsbasestylingmixins.h index 730363e0c5..358cd5f8f8 100644 --- a/lib/jkqtplotter/jkqtpgraphsbasestylingmixins.h +++ b/lib/jkqtplotter/jkqtpgraphsbasestylingmixins.h @@ -455,18 +455,18 @@ public: /** \brief class constructor */ JKQTPGraphLineAndFillStyleMixin(); - /*! \copydoc m_drawLine */ + /** \copydoc m_drawLine */ void setDrawLine(bool __value); - /*! \copydoc m_drawLine */ + /** \copydoc m_drawLine */ bool getDrawLine() const; - /*! \copydoc m_drawLine */ + /** \copydoc m_drawLine */ bool doDrawLine() const; - /*! \copydoc m_fillCurve */ + /** \copydoc m_fillCurve */ void setFillCurve(bool __value); - /*! \copydoc m_fillCurve */ + /** \copydoc m_fillCurve */ bool getFillCurve() const; - /*! \copydoc m_fillCurve */ + /** \copydoc m_fillCurve */ bool doFillCurve() const; diff --git a/lib/jkqtplotter/jkqtpimagetools.h b/lib/jkqtplotter/jkqtpimagetools.h index fedc0087c6..261ac92055 100644 --- a/lib/jkqtplotter/jkqtpimagetools.h +++ b/lib/jkqtplotter/jkqtpimagetools.h @@ -47,26 +47,26 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColorPaletteStyleAndToolsMixin { JKQTPColorPaletteStyleAndToolsMixin(JKQTBasePlotter *parent); virtual ~JKQTPColorPaletteStyleAndToolsMixin(); - /*! \brief get list with all available palettes */ + /** \brief get list with all available palettes */ static QStringList getPalettes() ; - /*! \brief get list with all available palettes */ + /** \brief get list with all available palettes */ static int getPalettesCount() ; - /*! \brief get QIcon representing the given palette */ + /** \brief get QIcon representing the given palette */ static QIcon getPaletteIcon(int i) ; - /*! \brief get QIcon representing the given palette */ + /** \brief get QIcon representing the given palette */ static QIcon getPaletteIcon(JKQTPMathImageColorPalette palette) ; - /*! \brief get QIcon representing the given palette */ + /** \brief get QIcon representing the given palette */ static QImage getPaletteImage(int i, size_t width) ; - /*! \brief get QIcon representing the given palette */ + /** \brief get QIcon representing the given palette */ static QImage getPaletteImage(JKQTPMathImageColorPalette palette, size_t width) ; - /*! \brief get QIcon representing the given palette */ + /** \brief get QIcon representing the given palette */ static QIcon getPaletteKeyIcon(int i) ; - /*! \brief get QIcon representing the given palette */ + /** \brief get QIcon representing the given palette */ static QIcon getPaletteKeyIcon(JKQTPMathImageColorPalette palette) ; - /*! \brief get QIcon representing the given palette */ + /** \brief get QIcon representing the given palette */ static QImage getPaletteKeyImage(int i, size_t width, size_t height) ; - /*! \brief get QIcon representing the given palette */ + /** \brief get QIcon representing the given palette */ static QImage getPaletteKeyImage(JKQTPMathImageColorPalette palette, size_t width, size_t height) ; @@ -97,92 +97,92 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColorPaletteStyleAndToolsMixin { - /*! \copydoc palette */ + /** \copydoc palette */ void setColorPalette(int pal); - /*! \copydoc palette */ + /** \copydoc palette */ void setColorPalette(const JKQTPMathImageColorPalette & __value); - /*! \copydoc palette */ + /** \copydoc palette */ JKQTPMathImageColorPalette getColorPalette() const; - /*! \copydoc rangeMinFailAction */ + /** \copydoc rangeMinFailAction */ void setRangeMinFailAction(const JKQTPMathImageColorRangeFailAction & __value); - /*! \copydoc rangeMinFailAction */ + /** \copydoc rangeMinFailAction */ JKQTPMathImageColorRangeFailAction getActionRangeMinFail() const; - /*! \copydoc rangeMaxFailAction */ + /** \copydoc rangeMaxFailAction */ void setRangeMaxFailAction(const JKQTPMathImageColorRangeFailAction & __value); - /*! \copydoc rangeMaxFailAction */ + /** \copydoc rangeMaxFailAction */ JKQTPMathImageColorRangeFailAction getActionRangeMaxFail() const; - /*! \copydoc rangeMinFailColor */ + /** \copydoc rangeMinFailColor */ void setRangeMinFailColor(const QColor & __value); - /*! \copydoc rangeMinFailColor */ + /** \copydoc rangeMinFailColor */ QColor getRangeMinFailColor() const; - /*! \copydoc rangeMaxFailColor */ + /** \copydoc rangeMaxFailColor */ void setRangeMaxFailColor(const QColor & __value); - /*! \copydoc rangeMaxFailColor */ + /** \copydoc rangeMaxFailColor */ QColor getRangeMaxFailColor() const; - /*! \copydoc nanColor */ + /** \copydoc nanColor */ void setNanColor(const QColor & __value); - /*! \copydoc nanColor */ + /** \copydoc nanColor */ QColor getNanColor() const; - /*! \copydoc infColor */ + /** \copydoc infColor */ void setInfColor(const QColor & __value); - /*! \copydoc infColor */ + /** \copydoc infColor */ QColor getInfColor() const; - /*! \copydoc showColorBar */ + /** \copydoc showColorBar */ void setShowColorBar(bool __value); - /*! \copydoc showColorBar */ + /** \copydoc showColorBar */ bool getShowColorBar() const; - /*! \copydoc colorBarWidth */ + /** \copydoc colorBarWidth */ void setColorBarWidth(int __value); - /*! \copydoc colorBarWidth */ + /** \copydoc colorBarWidth */ int getColorBarWidth() const; - /*! \copydoc colorBarOffset */ + /** \copydoc colorBarOffset */ void setColorBarOffset(int __value); - /*! \copydoc colorBarOffset */ + /** \copydoc colorBarOffset */ int getColorBarOffset() const; - /*! \copydoc colorBarRelativeHeight */ + /** \copydoc colorBarRelativeHeight */ void setColorBarRelativeHeight(double __value); - /*! \copydoc colorBarRelativeHeight */ + /** \copydoc colorBarRelativeHeight */ double getColorBarRelativeHeight() const; - /*! \copydoc imageMin */ + /** \copydoc imageMin */ void setImageMin(double __value); - /*! \copydoc imageMin */ + /** \copydoc imageMin */ double getImageMin() const; - /*! \copydoc imageMax */ + /** \copydoc imageMax */ void setImageMax(double __value); - /*! \copydoc imageMax */ + /** \copydoc imageMax */ double getImageMax() const; - /*! \copydoc autoImageRange */ + /** \copydoc autoImageRange */ void setAutoImageRange(bool __value); - /*! \copydoc autoImageRange */ + /** \copydoc autoImageRange */ bool getAutoImageRange() const; - /*! \copydoc imageName */ + /** \copydoc imageName */ void setImageName(const QString & __value); - /*! \copydoc imageName */ + /** \copydoc imageName */ QString getImageName() const; - /*! \copydoc imageNameFontName */ + /** \copydoc imageNameFontName */ void setImageNameFontName(const QString & __value); - /*! \copydoc imageNameFontName */ + /** \copydoc imageNameFontName */ QString getImageNameFontName() const; - /*! \copydoc imageNameFontSize */ + /** \copydoc imageNameFontSize */ void setImageNameFontSize(double __value); - /*! \copydoc imageNameFontSize */ + /** \copydoc imageNameFontSize */ double getImageNameFontSize() const; - /*! \copydoc colorBarRightAxis */ + /** \copydoc colorBarRightAxis */ JKQTPVerticalIndependentAxis* getColorBarRightAxis(); - /*! \copydoc colorBarTopAxis */ + /** \copydoc colorBarTopAxis */ JKQTPHorizontalIndependentAxis* getColorBarTopAxis(); - /*! \copydoc colorBarRightAxis */ + /** \copydoc colorBarRightAxis */ const JKQTPVerticalIndependentAxis* getColorBarRightAxis() const; - /*! \copydoc colorBarTopAxis */ + /** \copydoc colorBarTopAxis */ const JKQTPHorizontalIndependentAxis* getColorBarTopAxis() const; - /*! \copydoc colorBarTopVisible */ + /** \copydoc colorBarTopVisible */ void setColorBarTopVisible(bool __value); - /*! \copydoc colorBarTopVisible */ + /** \copydoc colorBarTopVisible */ bool getColorBarTopVisible() const; - /*! \copydoc colorBarRightVisible */ + /** \copydoc colorBarRightVisible */ void setColorBarRightVisible(bool __value); - /*! \copydoc colorBarRightVisible */ + /** \copydoc colorBarRightVisible */ bool getColorBarRightVisible() const; @@ -282,34 +282,34 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPColorPaletteWithModifierStyleAndToolsMixin : p virtual void cbGetModifierDataMinMax(double& imin, double& imax)=0; - /*! \copydoc modifierMode */ + /** \copydoc modifierMode */ void setModifierMode(const JKQTPMathImageModifierMode & __value); - /*! \copydoc modifierMode */ + /** \copydoc modifierMode */ JKQTPMathImageModifierMode getModifierMode() const; - /*! \copydoc colorBarModifiedWidth */ + /** \copydoc colorBarModifiedWidth */ void setColorBarModifiedWidth(double __value); - /*! \copydoc colorBarModifiedWidth */ + /** \copydoc colorBarModifiedWidth */ double getColorBarModifiedWidth() const; - /*! \copydoc modifierColorBarTopAxis */ + /** \copydoc modifierColorBarTopAxis */ JKQTPVerticalIndependentAxis* getModifierColorBarTopAxis(); - /*! \copydoc modifierColorBarRightAxis */ + /** \copydoc modifierColorBarRightAxis */ JKQTPHorizontalIndependentAxis* getModifierColorBarRightAxis(); - /*! \copydoc modifierColorBarTopAxis */ + /** \copydoc modifierColorBarTopAxis */ const JKQTPVerticalIndependentAxis* getModifierColorBarTopAxis() const; - /*! \copydoc modifierColorBarRightAxis */ + /** \copydoc modifierColorBarRightAxis */ const JKQTPHorizontalIndependentAxis *getModifierColorBarRightAxis() const; - /*! \copydoc autoModifierRange */ + /** \copydoc autoModifierRange */ void setAutoModifierRange(bool __value); - /*! \copydoc autoModifierRange */ + /** \copydoc autoModifierRange */ bool getAutoModifierRange() const; - /*! \copydoc modifierMin */ + /** \copydoc modifierMin */ void setModifierMin(double __value); - /*! \copydoc modifierMin */ + /** \copydoc modifierMin */ double getModifierMin() const; - /*! \copydoc modifierMax */ + /** \copydoc modifierMax */ void setModifierMax(double __value); - /*! \copydoc modifierMax */ + /** \copydoc modifierMax */ double getModifierMax() const;