HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1336:8115fc705636

qxyseries doc update

Jani Honkonen -

r1336:8115fc705636

parent child

Context file:

r1336:8115fc705636

Collapse all files

src/xychart/qxyseries.cpp +36 -15

             */
             /*!
+                \property QXYSeries::pointsVisible
+                Controls if the data points are visible and should be drawn.
+            */
+            /*!
+                \property QXYSeries::count
+                Number of points in the series.
+            */
+            /*!
                \fn QPen QXYSeries::pen() const
                \brief  Returns pen used to draw points for series.
                 \sa setPen()
                 \brief Signal is emitted when user clicks the \a point on chart.
             */
             /*!
-                \fn void QXYSeriesPrivate::pointReplaced(int index)
+                \fn void QXYSeries::pointReplaced(int index)
-                \brief \internal \a index
+                \brief Signal is emitted when user replaces a point at \a index.
+                \sa replace()
             */
             /*!
-                \fn void QXYSeriesPrivate::pointAdded(int index)
+                \fn void QXYSeries::pointAdded(int index)
-                \brief \internal \a index
+                \brief Signal is emitted when user adds a point at \a index.
+                \sa append(), insert()
             */
             /*!
-                \fn void QXYSeriesPrivate::pointRemoved(int index)
+                \fn void QXYSeries::pointRemoved(int index)
-                \brief \internal \a index
+                \brief Signal is emitted when user removes a point at \a index.
+                \sa remove()
             */
             /*!
                 }
             }
+            /*!
+              Replaces data point \a oldX \a oldY with data point \a newX \a newY.
+            */
             void QXYSeries::replace(qreal oldX,qreal oldY,qreal newX,qreal newY)
             {
                 replace(QPointF(oldX,oldY),QPointF(newX,newY));
             }
+            /*!
+              Replaces \a oldPoint with \a newPoint.
+            */
             void QXYSeries::replace(const QPointF &oldPoint,const QPointF &newPoint)
             {
                 Q_D(QXYSeries);
             }
             /*!
-              Removes current \a point x value. Note \a point y value is ignored.
+              Removes current \a point x value.
+              Note: point y value is ignored.
             */
             void QXYSeries::remove(const QPointF &point)
             {
                 }
             }
+            /*!
+               Inserts a \a point in the series at \a index position.
+            */
             void QXYSeries::insert(int index, const QPointF &point)
             {
                 Q_D(QXYSeries);
                 emit pointAdded(index);
             }
+            /*!
+                Removes all points from the series.
+            */
             void QXYSeries::clear()
             {
                 Q_D(QXYSeries);
             }
-            /*!
-                Sets if data points are \a visible and should be drawn on line.
-            */
             void QXYSeries::setPointsVisible(bool visible)
             {
                 Q_D(QXYSeries);
                 }
             }
-            /*!
-                Returns true if drawing the data points of the series is enabled.
-            */
             bool QXYSeries::pointsVisible() const
             {
                 Q_D(const QXYSeries);

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages