From 29373936de0b7815e8ef7ca2d3c6886862cc3570 2012-04-11 10:08:13
From: sauimone <samu.uimonen@digia.com>
Date: 2012-04-11 10:08:13
Subject: [PATCH] barchart: doc update for hover signals

---

diff --git a/src/barchart/qbarseries.cpp b/src/barchart/qbarseries.cpp
index 1132331..2b322a1 100644
--- a/src/barchart/qbarseries.cpp
+++ b/src/barchart/qbarseries.cpp
@@ -68,6 +68,14 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE
 */
 
 /*!
+    \fn void QBarSeries::hovered(QBarSet* barset, bool status)
+
+    The signal is emitted if mouse is hovered on top of series.
+    Parameter \a barset is the pointer of barset, where hover happened.
+    Parameter \a status is true, if mouse entered on top of series, false if mouse left from top of series.
+*/
+
+/*!
     Constructs empty QBarSeries. Parameter \a categories defines the categories for chart.
     QBarSeries is QObject which is a child of a \a parent.
 */
@@ -77,6 +85,14 @@ QBarSeries::QBarSeries(QBarCategories categories, QObject *parent) :
 }
 
 /*!
+    Destructs barseries and owned barsets.
+*/
+QBarSeries::~QBarSeries()
+{
+    // NOTE: d_ptr destroyed by QObject
+}
+
+/*!
     \internal
 */
 QBarSeries::QBarSeries(QBarSeriesPrivate &d, QObject *parent) :
@@ -84,6 +100,9 @@ QBarSeries::QBarSeries(QBarSeriesPrivate &d, QObject *parent) :
 {
 }
 
+/*!
+    Returns the type of series. Derived classes override this.
+*/
 QSeries::QSeriesType QBarSeries::type() const
 {
     return QSeries::SeriesTypeBar;
diff --git a/src/barchart/qbarseries.h b/src/barchart/qbarseries.h
index 10fc95b..8415261 100644
--- a/src/barchart/qbarseries.h
+++ b/src/barchart/qbarseries.h
@@ -41,6 +41,7 @@ class QTCOMMERCIALCHART_EXPORT QBarSeries : public QSeries
     Q_OBJECT
 public:
     explicit QBarSeries(QBarCategories categories, QObject *parent = 0);
+    virtual ~QBarSeries();
 
     QSeries::QSeriesType type() const;
 
diff --git a/src/barchart/qbarset.cpp b/src/barchart/qbarset.cpp
index 079f001..ff979fa 100644
--- a/src/barchart/qbarset.cpp
+++ b/src/barchart/qbarset.cpp
@@ -45,8 +45,16 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE
 */
 
 /*!
+    \fn void QBarSet::selected()
+    \brief signals that set has been selected
+*/
+
+/*!
     \fn void QBarSet::hovered(bool status)
     \brief signals that mouse has hovered over the set. If \a status is true, then mouse was entered. If \a status is false, then mouse was left.
+
+    The signal is emitted if mouse is hovered on top of set
+    Parameter \a status is true, if mouse entered on top of series, false if mouse left from top of series.
 */
 
 /*!
@@ -58,9 +66,12 @@ QBarSet::QBarSet(QString name, QObject *parent)
 {
 }
 
+/*!
+    Destroys the barset
+*/
 QBarSet::~QBarSet()
 {
-
+    // NOTE: d_ptr destroyed by QObject
 }
 
 /*!
diff --git a/src/barchart/qbarset.h b/src/barchart/qbarset.h
index 700ead5..fc83a8a 100644
--- a/src/barchart/qbarset.h
+++ b/src/barchart/qbarset.h
@@ -35,7 +35,7 @@ class QTCOMMERCIALCHART_EXPORT QBarSet : public QObject
 
 public:
     explicit QBarSet(QString name, QObject *parent = 0);
-    ~QBarSet();
+    virtual ~QBarSet();
 
     void setName(QString name);
     QString name() const;