summaryrefslogtreecommitdiffstats
path: root/src/charts/barchart
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2016-12-23 16:13:49 +0100
committerJani Heikkinen <jani.heikkinen@qt.io>2017-01-05 05:46:13 +0000
commit79413865a388ba99260dba7a2218c1b19b83b345 (patch)
tree07203003dcf943cef3574757a9841f0d57f3b9d8 /src/charts/barchart
parent4d576be31a74114cae6ca7e59fcf572a54aae8ea (diff)
Doc: Add method docs for the BarSet type
Task-number: QTBUG-57795 Change-Id: Ia104822dd11c07ff280012f86ace679c740ea5b9 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Diffstat (limited to 'src/charts/barchart')
-rw-r--r--src/charts/barchart/qbarset.cpp24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/charts/barchart/qbarset.cpp b/src/charts/barchart/qbarset.cpp
index 8d88788f..fa42b191 100644
--- a/src/charts/barchart/qbarset.cpp
+++ b/src/charts/barchart/qbarset.cpp
@@ -332,6 +332,11 @@ QString QBarSet::label() const
}
/*!
+ \qmlmethod BarSet::append(real value)
+ Appends the new value specified by \a value to the end of the bar set.
+*/
+
+/*!
Appends the new value specified by \a value to the end of the bar set.
*/
void QBarSet::append(const qreal value)
@@ -379,6 +384,14 @@ void QBarSet::insert(const int index, const qreal value)
}
/*!
+ \qmlmethod BarSet::remove(int index, int count)
+ Removes the number of values specified by \a count from the bar set starting
+ with the value specified by \a index.
+
+ If you leave out \a count, only the value specified by \a index is removed.
+*/
+
+/*!
Removes the number of values specified by \a count from the bar set starting with
the value specified by \a index.
\sa insert()
@@ -392,6 +405,12 @@ void QBarSet::remove(const int index, const int count)
}
/*!
+ \qmlmethod BarSet::replace(int index, real value)
+ Adds the value specified by \a value to the bar set at the position
+ specified by \a index.
+*/
+
+/*!
Adds the value specified by \a value to the bar set at the position specified by \a index.
*/
void QBarSet::replace(const int index, const qreal value)
@@ -402,6 +421,11 @@ void QBarSet::replace(const int index, const qreal value)
}
}
+/*!
+ \qmlmethod BarSet::at(int index)
+ Returns the value specified by \a index from the bar set.
+ If the index is out of bounds, 0.0 is returned.
+*/
/*!
Returns the value specified by \a index from the bar set.