From eca4f57c854874ec6e4f616e663b43675d76cff4 Mon Sep 17 00:00:00 2001
From: Miikka Heikkinen <miikka.heikkinen@digia.com>
Date: Thu, 3 Oct 2013 10:41:45 +0300
Subject: Improve documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

+QML types now in their own group
+Overview improved, though some linked pages are still just stubs
+Some missing documentation added
+Some needed tags added to qml type documentations
+Removed license page
+Fixed lisence footer

Change-Id: Ic5e3d922cd5caf9f23294aea6f0e5d2ac493ae63
Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
---
 src/datavisualization/axis/q3dabstractaxis.cpp | 6 +++++-
 src/datavisualization/axis/q3dabstractaxis.h   | 1 -
 src/datavisualization/axis/q3dcategoryaxis.cpp | 4 ++++
 src/datavisualization/axis/q3dcategoryaxis.h   | 3 ---
 src/datavisualization/axis/q3dvalueaxis.cpp    | 4 ++++
 src/datavisualization/axis/q3dvalueaxis.h      | 1 -
 6 files changed, 13 insertions(+), 6 deletions(-)

(limited to 'src/datavisualization/axis')

diff --git a/src/datavisualization/axis/q3dabstractaxis.cpp b/src/datavisualization/axis/q3dabstractaxis.cpp
index 8e1e6a35..07761d0c 100644
--- a/src/datavisualization/axis/q3dabstractaxis.cpp
+++ b/src/datavisualization/axis/q3dabstractaxis.cpp
@@ -34,9 +34,13 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
 
 /*!
  * \qmltype AbstractAxis3D
+ * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \since com.digia.QtDataVisualization 1.0
+ * \ingroup datavisualization_qml
  * \instantiates Q3DAbstractAxis
+ * \brief AbstractAxis3D is base type for axes of a graph.
  *
- * You should not need to use this type directly.
+ * This type is uncreatable, but contains properties that are exposed via subtypes.
  */
 
 /*!
diff --git a/src/datavisualization/axis/q3dabstractaxis.h b/src/datavisualization/axis/q3dabstractaxis.h
index 31b7ab55..9e5c426a 100644
--- a/src/datavisualization/axis/q3dabstractaxis.h
+++ b/src/datavisualization/axis/q3dabstractaxis.h
@@ -73,7 +73,6 @@ public:
     qreal max() const;
     bool isAutoAdjustRange() const;
 
-public slots:
     void setTitle(QString title);
     void setRange(qreal min, qreal max);
     void setMin(qreal min);
diff --git a/src/datavisualization/axis/q3dcategoryaxis.cpp b/src/datavisualization/axis/q3dcategoryaxis.cpp
index fec2442c..05f52cdc 100644
--- a/src/datavisualization/axis/q3dcategoryaxis.cpp
+++ b/src/datavisualization/axis/q3dcategoryaxis.cpp
@@ -38,8 +38,12 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
 
 /*!
  * \qmltype CategoryAxis3D
+ * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \since com.digia.QtDataVisualization 1.0
+ * \ingroup datavisualization_qml
  * \instantiates Q3DCategoryAxis
  * \inherits AbstractAxis3D
+ * \brief The CategoryAxis3D type is used for manipulating an axis of a graph.
  *
  * This type provides an axis that can be given labels.
  */
diff --git a/src/datavisualization/axis/q3dcategoryaxis.h b/src/datavisualization/axis/q3dcategoryaxis.h
index 7376760b..ef545950 100644
--- a/src/datavisualization/axis/q3dcategoryaxis.h
+++ b/src/datavisualization/axis/q3dcategoryaxis.h
@@ -35,9 +35,6 @@ public:
     virtual ~Q3DCategoryAxis();
 
     QStringList categoryLabels() const;
-
-
-public slots:
     void setCategoryLabels(const QStringList &labels);
 
 protected:
diff --git a/src/datavisualization/axis/q3dvalueaxis.cpp b/src/datavisualization/axis/q3dvalueaxis.cpp
index a32a96e7..5e38e4ca 100644
--- a/src/datavisualization/axis/q3dvalueaxis.cpp
+++ b/src/datavisualization/axis/q3dvalueaxis.cpp
@@ -38,8 +38,12 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
 
 /*!
  * \qmltype ValueAxis3D
+ * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \since com.digia.QtDataVisualization 1.0
+ * \ingroup datavisualization_qml
  * \instantiates Q3DValueAxis
  * \inherits AbstractAxis3D
+ * \brief The ValueAxis3D type is used for manipulating an axis of a graph.
  *
  * This type provides an axis that can be given a range of values and segment and subsegment
  * counts to divide the range into.
diff --git a/src/datavisualization/axis/q3dvalueaxis.h b/src/datavisualization/axis/q3dvalueaxis.h
index 3e0a8cb1..f1280e25 100644
--- a/src/datavisualization/axis/q3dvalueaxis.h
+++ b/src/datavisualization/axis/q3dvalueaxis.h
@@ -40,7 +40,6 @@ public:
     int subSegmentCount() const;
     QString labelFormat() const;
 
-public slots:
     void setSegmentCount(int count);
     void setSubSegmentCount(int count);
     void setLabelFormat(const QString &format);
-- 
cgit v1.2.3