From 9349f486cbe9194b5eef97996f58a2cbd5ef3e52 Mon Sep 17 00:00:00 2001 From: jkriege2 Date: Wed, 14 Feb 2024 00:03:38 +0100 Subject: [PATCH] docfix --- examples/geo_bezier/README.md | 2 +- lib/jkqtplotter/graphs/jkqtpgeolines.h | 24 +++++++++++++++++------- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/examples/geo_bezier/README.md b/examples/geo_bezier/README.md index 1b1402c4a6..a4058c73fd 100644 --- a/examples/geo_bezier/README.md +++ b/examples/geo_bezier/README.md @@ -30,5 +30,5 @@ Finally we also add symbols for each control point and a poly-line connecting th Here is the resulting plot: -![geo_bezier](https://raw.githubusercontent.com/jkriege2/JKQtPlotter/master/doc/images/geo_bezier.png) +![geo_bezier](https://raw.githubusercontent.com/jkriege2/JKQtPlotter/master/screenshots/geo_bezier.png) diff --git a/lib/jkqtplotter/graphs/jkqtpgeolines.h b/lib/jkqtplotter/graphs/jkqtpgeolines.h index f0913dc146..268da0ad7e 100644 --- a/lib/jkqtplotter/graphs/jkqtpgeolines.h +++ b/lib/jkqtplotter/graphs/jkqtpgeolines.h @@ -456,7 +456,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPolyLines: public JKQTPGeoBaseDecoratedLine /** \brief This JKQTPGeometricPlotElement is used to draw a bezier curve * \ingroup jkqtplotter_geoplots * - * \image html JKQTPlotterGeometricBezierGraphic.png "drawn with JKQTPGeometricPlotElement::DrawMode::DrawAsGraphicElement" + * \image html JKQTPGeoBezierCurveGraphic.png "drawn with JKQTPGeometricPlotElement::DrawMode::DrawAsGraphicElement" * * \see \ref JKQTPlotterGeometricBezier, JKQTPGeoBaseDecoratedLine * @@ -466,8 +466,8 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPolyLines: public JKQTPGeoBaseDecoratedLine * * On logarithmic axes (x&y) the two modes draw very different shapes: * - * \image html JKQTPlotterGeometricBezierLogMath.png "drawn with JKQTPGeometricPlotElement::DrawMode::DrawAsMathematicalCurve" - * \image html JKQTPlotterGeometricBezierLogGraphic.png "drawn with JKQTPGeometricPlotElement::DrawMode::DrawAsGraphicElement" + * \image html JKQTPGeoBezierCurveLogMath.png "drawn with JKQTPGeometricPlotElement::DrawMode::DrawAsMathematicalCurve" + * \image html JKQTPGeoBezierCurveLogGraphic.png "drawn with JKQTPGeometricPlotElement::DrawMode::DrawAsGraphicElement" * * For DrawAsGraphicElement only the control points are converted to screen-coordinates, but drawing takes place in the (linear) screen-system. * For DrawAsMathematicalCurve drawing is done in the log-coordinate system. @@ -489,25 +489,35 @@ public: /** \brief class constructor with start, end and one control point (i.e. a quadratic bezier curve) * * \param parent the parent plotter object - * \param points points on the polygon + * \param start start point + * \param control1 control-point in between start and end + * \param end end point */ JKQTPGeoBezierCurve(JKQTBasePlotter* parent, const QPointF& start, const QPointF& control1, const QPointF& end); /** \brief class constructor with start, end and one control point (i.e. a quadratic bezier curve) * * \param parent the parent plotter object - * \param points points on the polygon + * \param start start point + * \param control1 control-point in between start and end + * \param end end point */ JKQTPGeoBezierCurve(JKQTPlotter* parent, const QPointF& start, const QPointF& control1, const QPointF& end); /** \brief class constructor with start, end and two control points (i.e. a cubic bezier curve) * * \param parent the parent plotter object - * \param points points on the polygon + * \param start start point + * \param control1 1st control-point in between start and end + * \param control2 2nd control-point in between start and end + * \param end end point */ JKQTPGeoBezierCurve(JKQTBasePlotter* parent, const QPointF& start, const QPointF& control1, const QPointF& control2, const QPointF& end); /** \brief class constructor with start, end and two control points (i.e. a cubic bezier curve) * * \param parent the parent plotter object - * \param points points on the polygon + * \param start start point + * \param control1 1st control-point in between start and end + * \param control2 2nd control-point in between start and end + * \param end end point */ JKQTPGeoBezierCurve(JKQTPlotter* parent, const QPointF& start, const QPointF& control1, const QPointF& control2, const QPointF& end); /** \brief class constructor