diff --git a/lib/jkqtplotter/graphs/jkqtpbarchart.h b/lib/jkqtplotter/graphs/jkqtpbarchart.h index 585305d78d..c5718275d2 100644 --- a/lib/jkqtplotter/graphs/jkqtpbarchart.h +++ b/lib/jkqtplotter/graphs/jkqtpbarchart.h @@ -104,15 +104,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarVerticalGraph: public JKQTPBarGraphBase { /** \brief plots the graph to the plotter object specified as parent */ virtual void draw(JKQTPEnhancedPainter& painter) override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; public Q_SLOTS: @@ -242,15 +236,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarHorizontalGraph: public JKQTPBarGraphBase { /** \brief plots the graph to the plotter object specified as parent */ virtual void draw(JKQTPEnhancedPainter& painter) override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief returns the column used as "key" for the current graph (typically this call getXColumn(), but for horizontal graphs like filled curves or barcharts it may call getYColumn() ) */ virtual int getKeyColumn() const override; @@ -290,10 +278,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarHorizontalErrorGraph: public JKQTPBarHorizo /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int c) const override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; diff --git a/lib/jkqtplotter/graphs/jkqtpboxplot.h b/lib/jkqtplotter/graphs/jkqtpboxplot.h index 9db83e6386..92001c2dd6 100644 --- a/lib/jkqtplotter/graphs/jkqtpboxplot.h +++ b/lib/jkqtplotter/graphs/jkqtpboxplot.h @@ -114,15 +114,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotVerticalGraph: public JKQTPBoxplotGraph /** \brief plots a key marker inside the specified rectangle \a rect */ virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; protected: @@ -156,15 +150,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotHorizontalGraph: public JKQTPBoxplotGra virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; }; @@ -211,15 +199,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotVerticalElement: public JKQTPBoxplotEle virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; @@ -258,15 +240,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotHorizontalElement: public JKQTPBoxplotE virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; }; diff --git a/lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h b/lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h index 5804c015e7..88f4e74a2d 100644 --- a/lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h +++ b/lib/jkqtplotter/graphs/jkqtpevaluatedfunction.h @@ -323,14 +323,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXFunctionLineGraph: public JKQTPFunctorLineGra /** \copydoc JKQTPEvaluatedFunctionWithErrorsGraphBase::buildPlotFunctorSpec() */ virtual std::function buildErrorFunctorSpec() override; - /** \brief get the maximum and minimum x-value of the graph - * - * This functions returns 0 for both parameters, so that the plotter uses the predefined - * min and max values. - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; @@ -379,11 +374,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPYFunctionLineGraph: public JKQTPFunctorLineGra virtual std::function buildErrorFunctorSpec() override; - /** \brief get the maximum and minimum x-value of the graph - */ - virtual bool getXMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ + virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; diff --git a/lib/jkqtplotter/graphs/jkqtpevaluatedfunctionbase.h b/lib/jkqtplotter/graphs/jkqtpevaluatedfunctionbase.h index 94414eb826..ee1f9cc711 100644 --- a/lib/jkqtplotter/graphs/jkqtpevaluatedfunctionbase.h +++ b/lib/jkqtplotter/graphs/jkqtpevaluatedfunctionbase.h @@ -84,14 +84,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPEvaluatedFunctionGraphBase: public JKQTPGraph /** \brief class destructor */ virtual ~JKQTPEvaluatedFunctionGraphBase() ; - /** \brief get the maximum and minimum x-value of the graph - * - * This functions returns 0 for both parameters, so that the plotter uses the predefined - * min and max values. - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief sets the params as a pointer to an internal COPY of the given vector (not the data of the vector, as then the size would be unknown!!!) */ diff --git a/lib/jkqtplotter/graphs/jkqtpfilledcurve.h b/lib/jkqtplotter/graphs/jkqtpfilledcurve.h index 1c5d507c39..57249c0aa9 100644 --- a/lib/jkqtplotter/graphs/jkqtpfilledcurve.h +++ b/lib/jkqtplotter/graphs/jkqtpfilledcurve.h @@ -215,10 +215,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPFilledCurveYGraph: public JKQTPFilledCurveGrap /** \brief class constructor */ JKQTPFilledCurveYGraph(JKQTPlotter* parent); - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; /** \brief plots the graph to the plotter object specified as parent */ @@ -253,10 +250,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPFilledCurveYErrorGraph: public JKQTPFilledCurv /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int c) const override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; diff --git a/lib/jkqtplotter/graphs/jkqtpgeoannotations.h b/lib/jkqtplotter/graphs/jkqtpgeoannotations.h index a027474c1b..ae1db820a1 100644 --- a/lib/jkqtplotter/graphs/jkqtpgeoannotations.h +++ b/lib/jkqtplotter/graphs/jkqtpgeoannotations.h @@ -144,9 +144,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoSymbol: public JKQTPPlotAnnotationElement, /** \brief returns x and y at the same time \see x, y */ QPointF getP() const; - /** \copydoc JKQTPPlotAnnotationElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPPlotAnnotationElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief plots the graph to the plotter object specified as parent */ diff --git a/lib/jkqtplotter/graphs/jkqtpgeolines.h b/lib/jkqtplotter/graphs/jkqtpgeolines.h index 61fa1f6cf8..5e01f015da 100644 --- a/lib/jkqtplotter/graphs/jkqtpgeolines.h +++ b/lib/jkqtplotter/graphs/jkqtpgeolines.h @@ -120,9 +120,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoLine: public JKQTPGeoBaseDecoratedLine { - /** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief plots the graph to the plotter object specified as parent @@ -299,9 +299,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoInfiniteLine: public JKQTPGeoBaseDecoratedH JKQTPGeoInfiniteLine(JKQTPlotter* parent, double x, double y, double dx, double dy); - /** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief plots the graph to the plotter object specified as parent @@ -402,9 +402,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPolyLines: public JKQTPGeoBaseDecoratedLine JKQTPGeoPolyLines(JKQTPlotter* parent); - /** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief plots the graph to the plotter object specified as parent @@ -494,9 +494,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoArc: public JKQTPGeoBaseLine { */ JKQTPGeoArc(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop); - /** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; diff --git a/lib/jkqtplotter/graphs/jkqtpgeoshapes.h b/lib/jkqtplotter/graphs/jkqtpgeoshapes.h index 12128673a0..80bb1fc4b8 100644 --- a/lib/jkqtplotter/graphs/jkqtpgeoshapes.h +++ b/lib/jkqtplotter/graphs/jkqtpgeoshapes.h @@ -115,9 +115,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoRectangle: public JKQTPGeoBaseFilled { - /** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief plots the graph to the plotter object specified as parent @@ -231,9 +231,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPolygon: public JKQTPGeoBaseFilled { JKQTPGeoPolygon(JKQTPlotter* parent, DrawMode drawMode=DrawAsGraphicElement); - /** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief plots the graph to the plotter object specified as parent @@ -430,9 +430,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPie: public JKQTPGeoEllipse { JKQTPGeoPie(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop, DrawMode drawMode=DrawAsGraphicElement); - /** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; @@ -502,9 +502,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoChord: public JKQTPGeoPie { */ JKQTPGeoChord(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop, DrawMode drawMode=DrawAsGraphicElement); - /** \copydoc JKQTPGeometricPlotElement::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPGeometricPlotElement::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief plots the graph to the plotter object specified as parent diff --git a/lib/jkqtplotter/graphs/jkqtpimage.h b/lib/jkqtplotter/graphs/jkqtpimage.h index c9c4ad0eae..67f32b555e 100644 --- a/lib/jkqtplotter/graphs/jkqtpimage.h +++ b/lib/jkqtplotter/graphs/jkqtpimage.h @@ -73,15 +73,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImageBase: public JKQTPGraph { /** \brief plots a key marker inside the specified rectangle \a rect */ virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \brief returns the color to be used for the key label */ virtual QColor getKeyLabelColor() const override; diff --git a/lib/jkqtplotter/graphs/jkqtpimpulses.h b/lib/jkqtplotter/graphs/jkqtpimpulses.h index 3f6ab0ab17..82e304c171 100644 --- a/lib/jkqtplotter/graphs/jkqtpimpulses.h +++ b/lib/jkqtplotter/graphs/jkqtpimpulses.h @@ -126,9 +126,9 @@ public: virtual int getValueColumn() const override; - /** \copydoc JKQTPXYGraph::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPXYGraph::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; public Q_SLOTS: @@ -158,7 +158,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesHorizontalErrorGraph: public JKQTPImpu /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int c) const override; - /** \copydoc JKQTPXYGraph::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; /** \brief returns the column that contains the bar height errors */ @@ -214,9 +214,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesVerticalGraph: public JKQTPImpulsesGra virtual void draw(JKQTPEnhancedPainter& painter) override; /** \brief plots a key marker inside the specified rectangle \a rect */ virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; - /** \copydoc JKQTPXYGraph::getXMinMax() */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \copydoc JKQTPXYGraph::getYMinMax() */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; }; diff --git a/lib/jkqtplotter/graphs/jkqtplines.h b/lib/jkqtplotter/graphs/jkqtplines.h index 408e1965b5..9b72a8ceb9 100644 --- a/lib/jkqtplotter/graphs/jkqtplines.h +++ b/lib/jkqtplotter/graphs/jkqtplines.h @@ -117,15 +117,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYLineErrorGraph: public JKQTPXYLineGraph, pub /** \brief class constructor */ JKQTPXYLineErrorGraph(JKQTPlotter* parent); - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int c) const override; diff --git a/lib/jkqtplotter/graphs/jkqtppeakstream.h b/lib/jkqtplotter/graphs/jkqtppeakstream.h index 3a135a06f6..adaa554b64 100644 --- a/lib/jkqtplotter/graphs/jkqtppeakstream.h +++ b/lib/jkqtplotter/graphs/jkqtppeakstream.h @@ -52,15 +52,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPeakStreamGraph: public JKQTPSingleColumnGraph JKQTPPeakStreamGraph(JKQTBasePlotter* parent=nullptr); JKQTPPeakStreamGraph(JKQTPlotter* parent); - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; diff --git a/lib/jkqtplotter/graphs/jkqtpscatter.h b/lib/jkqtplotter/graphs/jkqtpscatter.h index 96e6c73f3d..d6070cc204 100644 --- a/lib/jkqtplotter/graphs/jkqtpscatter.h +++ b/lib/jkqtplotter/graphs/jkqtpscatter.h @@ -101,15 +101,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYScatterErrorGraph: public JKQTPXYScatterGrap /** \brief class constructor */ JKQTPXYScatterErrorGraph(JKQTPlotter* parent); - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int c) const override; @@ -441,15 +435,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYParametrizedErrorScatterGraph: public JKQTPX JKQTPXYParametrizedErrorScatterGraph(JKQTPlotter* parent); - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \copydoc JKQTPGraph::usesColumn() */ virtual bool usesColumn(int c) const override; diff --git a/lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h b/lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h index 5357ca92df..c56f9eae33 100644 --- a/lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h +++ b/lib/jkqtplotter/graphs/jkqtpsinglecolumnsymbols.h @@ -65,15 +65,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPSingleColumnSymbolsGraph: public JKQTPSingleCo JKQTPSingleColumnSymbolsGraph(JKQTBasePlotter* parent=nullptr); JKQTPSingleColumnSymbolsGraph(JKQTPlotter* parent); - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; diff --git a/lib/jkqtplotter/graphs/jkqtpviolinplot.h b/lib/jkqtplotter/graphs/jkqtpviolinplot.h index c71e0061ac..84cb1555ba 100644 --- a/lib/jkqtplotter/graphs/jkqtpviolinplot.h +++ b/lib/jkqtplotter/graphs/jkqtpviolinplot.h @@ -178,15 +178,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPViolinplotVerticalElement: public JKQTPViolinp - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; @@ -233,15 +227,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPViolinplotHorizontalElement: public JKQTPVioli virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, const QRectF& rect) override; - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; }; diff --git a/lib/jkqtplotter/jkqtpgraphsbase.h b/lib/jkqtplotter/jkqtpgraphsbase.h index 37ff287411..ad12e87f15 100644 --- a/lib/jkqtplotter/jkqtpgraphsbase.h +++ b/lib/jkqtplotter/jkqtpgraphsbase.h @@ -81,11 +81,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPlotElement: public QObject { /** \brief get the maximum and minimum x-value of the graph * * The result is given in the two parameters which are call-by-reference parameters! + * + * \param[out] minx minimal x-value used in the graph + * \param[out] maxx maximal x-value used in the graph + * \param[out] smallestGreaterZero the smalles x-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes) + * \return \c true on success, i.e. if there were datapoints in the plot, or \c false on failure (e.g. when the graph is empty) */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero)=0; /** \brief get the maximum and minimum y-value of the graph * * The result is given in the two parameters which are call-by-reference parameters! + * + * \param[out] miny minimal y-value used in the graph + * \param[out] maxy maximal y-value used in the graph + * \param[out] smallestGreaterZero the smalles y-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes) + * \return \c true on success, i.e. if there were datapoints in the plot, or \c false on failure (e.g. when the graph is empty) */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero)=0; /** \brief returns the color to be used for the key label */ @@ -388,7 +398,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPlotElement: public QObject { - /** \brief dataset with graph-points and associated data fro the function hitTest() + /** \brief dataset with graph-points and associated data from the function hitTest() * \see hitTest(), HitTestLocation */ QVector m_hitTestData; @@ -590,15 +600,9 @@ public: /** \brief class constructor */ JKQTPXYGraph(JKQTBasePlotter* parent=nullptr); - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \copydoc JKQTPGraph::usesColumn() */ @@ -752,10 +756,7 @@ public: JKQTPXYYGraph(JKQTBasePlotter* parent=nullptr); - /** \brief get the maximum and minimum y-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getYMinMax() */ virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override; /** \copydoc JKQTPGraph::usesColumn() */ @@ -813,10 +814,7 @@ public: JKQTPXXYGraph(JKQTBasePlotter* parent=nullptr); - /** \brief get the maximum and minimum x-value of the graph - * - * The result is given in the two parameters which are call-by-reference parameters! - */ + /** \copydoc JKQTPPlotElement::getXMinMax() */ virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override; /** \copydoc JKQTPGraph::usesColumn() */ diff --git a/lib/jkqtplotter/jkqtpgraphsbaseerrors.h b/lib/jkqtplotter/jkqtpgraphsbaseerrors.h index 1a7e728d07..48be6b9eef 100644 --- a/lib/jkqtplotter/jkqtpgraphsbaseerrors.h +++ b/lib/jkqtplotter/jkqtpgraphsbaseerrors.h @@ -161,9 +161,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGraphErrorStyleMixin { double m_errorLineWidth; - /** \brief fill style of the graph */ + /** \brief fill brush for the error indicators */ QBrush m_errorFillBrush; - /** \brief last fill color of the graph */ + /** \brief fill color for the error indicators */ QColor m_errorFillColor;