summaryrefslogtreecommitdiffstats
path: root/src/qabstractseries.cpp
diff options
context:
space:
mode:
authorTero Ahola <tero.ahola@digia.com>2012-06-21 13:13:03 +0300
committerTero Ahola <tero.ahola@digia.com>2012-06-21 13:43:55 +0300
commitdbd0ff0f2ce9e3e80bf2161a3acb5e6a66a89946 (patch)
tree41fc42f9f7fb65350b74673999c100687ce72cc2 /src/qabstractseries.cpp
parenta557edf16956b9e140afaaa8c98310ed7bb5f3ce (diff)
QML methods of series: several fixes and documentation
Diffstat (limited to 'src/qabstractseries.cpp')
-rw-r--r--src/qabstractseries.cpp34
1 files changed, 18 insertions, 16 deletions
diff --git a/src/qabstractseries.cpp b/src/qabstractseries.cpp
index 7638a421..9105aa43 100644
--- a/src/qabstractseries.cpp
+++ b/src/qabstractseries.cpp
@@ -33,6 +33,11 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE
\sa QXYSeries, QLineSeries, QSplineSeries, QScatterSeries, QAreaSeries, QBarSeries, QStackedBarSeries,
QPercentBarSeries, QPieSeries
*/
+/*!
+ \qmlclass AbstractSeries
+ AbstractSeries is the base class for all series.
+ The class cannot be instantiated by the user.
+*/
/*!
\enum QAbstractSeries::SeriesType
@@ -54,18 +59,27 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE
\property QAbstractSeries::type
The type of the series.
*/
+/*!
+ \qmlproperty ChartView.SeriesType AbstractSeries::type
+ The type of the series.
+*/
/*!
\property QAbstractSeries::name
- \brief name of the series property
+ \brief name of the series property. The name is shown in legend for QXYSeries.
+*/
+/*!
+ \qmlproperty string AbstractSeries::name
+ Name of the series. The name is shown in legend for QXYSeries.
*/
/*!
\fn void QAbstractSeries::nameChanged()
-
This signal is emitted when the series name changes.
-
- \sa name
+*/
+/*!
+ \qmlsignal AbstractSeries::nameChanged()
+ This signal is emitted when the series name changes.
*/
/*!
@@ -96,14 +110,6 @@ QAbstractSeries::~QAbstractSeries()
if(d_ptr->m_dataset) qFatal("Still binded series detected !");
}
-/*!
- \brief Sets a \a name for the series.
-
- The name of a series is shown in the legend for QXYSeries.
- \sa QChart::setTitle()
- \sa QPieSlice::setLabel()
- \sa QBarSet::setName()
-*/
void QAbstractSeries::setName(const QString& name)
{
if (name != d_ptr->m_name) {
@@ -112,10 +118,6 @@ void QAbstractSeries::setName(const QString& name)
}
}
-/*!
- \brief Returns the name of the series.
- \sa setName()
-*/
QString QAbstractSeries::name() const
{
return d_ptr->m_name;