From aa412a1538c7aaca41872ba44f0fbb4c12753653 2012-07-04 08:03:25
From: sauimone <samu.uimonen@digia.com>
Date: 2012-07-04 08:03:25
Subject: [PATCH] barcategoriesaxis documentation. Doc stub to intervalaxis

---

diff --git a/doc/src/classes.qdoc b/doc/src/classes.qdoc
index 03152cd..67e00e5 100644
--- a/doc/src/classes.qdoc
+++ b/doc/src/classes.qdoc
@@ -29,7 +29,10 @@
                 <td valign="top">
                     <ul>
                     <li><a href="qchart.html">QChart</a></li>
-                    <li><a href="qaxis.html">QAxis</a></li>
+                    <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="qintervalaxis.html">QIntervalAxis</a></li>
                     <li><a href="qaxiscategories.html">QAxisCategories</a></li>
                     <li><a href="qchartview.html">QChartView</a></li>
                     <li><a href="qlegend.html">QLegend</a></li>
diff --git a/src/axis/qbarcategoriesaxis.cpp b/src/axis/qbarcategoriesaxis.cpp
index 4757217..0be680d 100644
--- a/src/axis/qbarcategoriesaxis.cpp
+++ b/src/axis/qbarcategoriesaxis.cpp
@@ -26,6 +26,71 @@
 #include <QDebug>
 
 QTCOMMERCIALCHART_BEGIN_NAMESPACE
+/*!
+    \class QBarCategoriesAxis
+    \brief The QBarCategoriesAxis class is used for manipulating chart's axis.
+    \mainclass
+
+    Axis can be setup to show axis line with tick marks, grid lines and shades.
+*/
+
+/*!
+    \qmlclass Axis QBarCategoriesAxis
+    \brief The Axis element is used for manipulating chart's axes.
+
+    Axis can be setup to show axis line with tick marks, grid lines and shades.
+
+    To access Axes you can use ChartView API. For example:
+    \code
+        ChartView {
+            axisX.min: "Feb"
+            axisX.max: "Jun"
+            // Add a few series...
+        }
+    \endcode
+*/
+
+/*!
+  \property QBarCategoriesAxis::categories
+  Defines the categories of axis
+*/
+/*!
+  \qmlproperty QStringList Axis::categories
+  Defines the categories of axis
+*/
+
+/*!
+  \property QBarCategoriesAxis::min
+  Defines the minimum value on the axis.
+*/
+/*!
+  \qmlproperty real Axis::min
+  Defines the minimum value on the axis.
+*/
+
+/*!
+  \property QBarCategoriesAxis::max
+  Defines the maximum value on the axis.
+*/
+/*!
+  \qmlproperty real Axis::max
+  Defines the maximum value on the axis.
+*/
+
+/*!
+  \fn void QBarCategoriesAxis::minChanged(const QString &min)
+  Axis emits signal when \a min of axis has changed.
+*/
+
+/*!
+  \fn void QBarCategoriesAxis::maxChanged(const QString &max)
+  Axis emits signal when \a max of axis has changed.
+*/
+
+/*!
+  \fn void QBarCategoriesAxis::rangeChanged(const QString &min, const QString &max)
+  Axis emits signal when \a min or \a max of axis has changed.
+*/
 
 QBarCategoriesAxis::QBarCategoriesAxis(QObject *parent):
     QAbstractAxis(*new QBarCategoriesAxisPrivate(this),parent)
diff --git a/src/axis/qintervalaxis.cpp b/src/axis/qintervalaxis.cpp
index 446ad9e..1b3df24 100644
--- a/src/axis/qintervalaxis.cpp
+++ b/src/axis/qintervalaxis.cpp
@@ -26,6 +26,26 @@
 #include <QDebug>
 
 QTCOMMERCIALCHART_BEGIN_NAMESPACE
+/*!
+    \class QIntervalAxis
+    \brief The QIntervalAxis class is used for manipulating chart's axis.
+    \mainclass
+
+    Axis can be setup to show axis line with tick marks, grid lines and shades.
+*/
+
+/*!
+    \qmlclass Axis QIntervalAxis
+    \brief The Axis element is used for manipulating chart's axes.
+
+    Axis can be setup to show axis line with tick marks, grid lines and shades.
+
+    To access Axes you can use ChartView API. For example:
+    \code
+    // TODO :)
+    \endcode
+*/
+
 
 QIntervalAxis::QIntervalAxis(QObject *parent):
     QValuesAxis(*new QIntervalAxisPrivate(this),parent)