From 0d55302d18fcd4276c823116036427b8a8fd2969 2012-08-21 09:58:19
From: Marek Rosa <marek.rosa@digia.com>
Date: 2012-08-21 09:58:19
Subject: [PATCH] Some interval axis docs updates

---

diff --git a/doc/src/classes.qdoc b/doc/src/classes.qdoc
index f4d13ce..91d5ad9 100644
--- a/doc/src/classes.qdoc
+++ b/doc/src/classes.qdoc
@@ -34,6 +34,7 @@
                     <li><a href="qabstractaxis.html">QAbstractAxis</a></li>
                     <li><a href="qvaluesaxis.html">QValuesAxis</a></li>
                     <li><a href="qbarcategoriesaxis.html">QBarCategoriesAxis</a></li>                   
+                    <li><a href="qintervalsaxis.html">QIntervalsAxis</a></li>
                     <li><a href="qlegend.html">QLegend</a></li>
                     <li><a href="qabstractseries.html">QAbstractSeries</a></li>
                     <li><a href="qchartglobal.html">QChartGlobal</a></li>
diff --git a/src/axis/intervalsaxis/qintervalsaxis.cpp b/src/axis/intervalsaxis/qintervalsaxis.cpp
index d545a31..2032163 100644
--- a/src/axis/intervalsaxis/qintervalsaxis.cpp
+++ b/src/axis/intervalsaxis/qintervalsaxis.cpp
@@ -27,12 +27,9 @@
 
 QTCOMMERCIALCHART_BEGIN_NAMESPACE
 /*!
-    \internal
     \class QIntervalsAxis
     \brief The QIntervalsAxis class is used for manipulating chart's axis.
     \mainclass
-
-    Axis can be setup to show axis line with tick marks, grid lines and shades.
 */
 
 /*!
@@ -77,7 +74,7 @@ QIntervalsAxis::QIntervalsAxis(QIntervalsAxisPrivate &d,QObject *parent):QValues
 /*!
     Appends new interval to the axis with an \a intervalLabel.
     Interval label has to be unique.
-    Parameter \a interval specifies the high end limit of the interval.
+    Parameter \a intervalEnd specifies the high end limit of the interval.
     It has to be greater than the high end limit of the previous interval.
     Otherwise the method returns without adding a new interval.
 */
@@ -132,7 +129,7 @@ qreal QIntervalsAxis::intervalMax(const QString& intervalLabel) const
 }
 
 /*!
-    Removes \a interval from axis
+    Removes an interval specified by the \a intervalLabel from the axis
 */
 void QIntervalsAxis::remove(const QString &intervalLabel)
 {
@@ -162,6 +159,10 @@ void QIntervalsAxis::remove(const QString &intervalLabel)
     }
 }
 
+/*!
+  Replaces \a oldLabel of an existing interval with a \a newLabel
+  If the old label does not exist the method returns without making any changes.
+ */
 void QIntervalsAxis::replaceLabel(const QString& oldLabel, const QString& newLabel)
 {
     Q_D(QIntervalsAxis);
@@ -178,6 +179,9 @@ void QIntervalsAxis::replaceLabel(const QString& oldLabel, const QString& newLab
 
 }
 
+/*!
+  Returns the list of the intervals labels
+ */
 QStringList QIntervalsAxis::intervalsLabels()
 {
     Q_D(QIntervalsAxis);
diff --git a/tests/auto/qintervalsaxis/tst_qintervalsaxis.cpp b/tests/auto/qintervalsaxis/tst_qintervalsaxis.cpp
index 6cfc6f9..877ee49 100644
--- a/tests/auto/qintervalsaxis/tst_qintervalsaxis.cpp
+++ b/tests/auto/qintervalsaxis/tst_qintervalsaxis.cpp
@@ -293,7 +293,7 @@ void tst_QIntervalsAxis::interval()
     QCOMPARE(m_intervalsaxis->intervalMax("second"), (qreal)75);
 
     // remove one interval
-    m_intervalsaxis->replace("second", "replaced");
+    m_intervalsaxis->replaceLabel("second", "replaced");
     QCOMPARE(m_intervalsaxis->count(), 2);
     QCOMPARE(m_intervalsaxis->intervalMin("replaced"), (qreal)0); // second interval should extend to firstInterval minimum
     QCOMPARE(m_intervalsaxis->intervalMax("replaced"), (qreal)75);