From 5c9e4e8ea61d2968524036a1efabbaa2c82a92dd 2012-07-02 12:27:38 From: sauimone Date: 2012-07-02 12:27:38 Subject: [PATCH] fixed documentation errors --- diff --git a/src/axis/qabstractaxis.cpp b/src/axis/qabstractaxis.cpp index a96a08a..cb5ab69 100644 --- a/src/axis/qabstractaxis.cpp +++ b/src/axis/qabstractaxis.cpp @@ -63,7 +63,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \value AxisTypeCategories */ -/*! +/* \property QAbstractAxis::type The type of the axis. */ @@ -77,20 +77,20 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Defines if axis labels are visible. */ -/*! +/* \property QAbstractAxis::min Defines the minimum value on the axis. */ -/*! +/* \qmlproperty real Axis::min Defines the minimum value on the axis. */ -/*! +/* \property QAbstractAxis::max Defines the maximum value on the axis. */ -/*! +/* \qmlproperty real Axis::max Defines the maximum value on the axis. */ @@ -123,9 +123,10 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE */ /*! - \property QAxis::labelsFont + \property QAbstractAxis::labelsFont The font of the axis labels. */ + /*! \qmlproperty Font Axis::labelsFont The font of the axis labels. @@ -179,24 +180,6 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE */ /*! - \property QAbstractAxis::ticksCount - The number of tick marks for the axis. -*/ -/*! - \qmlproperty int Axis::ticksCount - The number of tick marks for the axis. -*/ - -/*! - \property QAbstractAxis::niceNumbersEnabled - Whether the nice numbers algorithm is enabled or not for the axis. -*/ -/*! - \qmlproperty bool Axis::niceNumbersEnabled - Whether the nice numbers algorithm is enabled or not for the axis. -*/ - -/*! \fn void QAbstractAxis::visibleChanged(bool) Visiblity of the axis has changed to \a visible. */ @@ -211,22 +194,22 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Visiblity of the grid lines of the axis has changed to \a visible. */ -/*! +/* \fn void QAbstractAxis::minChanged(qreal min) Axis emits signal when \a min of axis has changed. */ -/*! +/* \fn void QAbstractAxis::maxChanged(qreal max) Axis emits signal when \a max of axis has changed. */ -/*! +/* \fn void QAbstractAxis::rangeChanged(qreal min, qreal max) Axis emits signal when \a min or \a max of axis has changed. */ -/*! +/* \fn QChartAxisCategories* QAbstractAxis::categories() Returns pointer to the list of categories which correspond to the values on the axis. */ diff --git a/src/axis/qvaluesaxis.cpp b/src/axis/qvaluesaxis.cpp index f952919..328b04c 100644 --- a/src/axis/qvaluesaxis.cpp +++ b/src/axis/qvaluesaxis.cpp @@ -85,6 +85,26 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Axis emits signal when \a min or \a max of axis has changed. */ +/*! + \property QValuesAxis::ticksCount + The number of tick marks for the axis. +*/ + +/*! + \qmlproperty int Axis::ticksCount + The number of tick marks for the axis. +*/ + +/*! + \property QValuesAxis::niceNumbersEnabled + Whether the nice numbers algorithm is enabled or not for the axis. +*/ + +/*! + \qmlproperty bool Axis::niceNumbersEnabled + Whether the nice numbers algorithm is enabled or not for the axis. +*/ + QValuesAxis::QValuesAxis(QObject *parent) : QAbstractAxis(*new QValuesAxisPrivate(this),parent) { @@ -147,7 +167,7 @@ void QValuesAxis::setTicksCount(int count) } /*! - \fn int QAbstractAxis::ticksCount() const + \fn int QValuesAxis::ticksCount() const Return number of ticks on the axis */ int QValuesAxis::ticksCount() const diff --git a/src/legend/qlegend.cpp b/src/legend/qlegend.cpp index 48a67eb..c565a06 100644 --- a/src/legend/qlegend.cpp +++ b/src/legend/qlegend.cpp @@ -159,26 +159,11 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE */ /*! - \fn void QLegend::labelBrushChanged(QBrush brush) - This signal is emitted when the brush used to draw labels has changed to \a brush. -*/ - -/*! \fn void QLegend::labelColorChanged(QColor color) This signal is emitted when the color of brush used to draw labels has changed to \a color. */ /*! - \fn qreal QLegend::minWidth() const - Returns minimum width of the legend - */ - -/*! - \fn qreal QLegend::minHeight() const - Returns minimum height of the legend - */ - -/*! Constructs the legend object and sets the parent to \a parent */ diff --git a/src/qchart.cpp b/src/qchart.cpp index 73ab871..d0e948e 100644 --- a/src/qchart.cpp +++ b/src/qchart.cpp @@ -134,7 +134,7 @@ QChart::~QChart() } /*! - Adds the \a series and optional \a axisY onto the chart and takes the ownership of the objects. + Adds the \a series onto the chart and takes the ownership of the object. If auto scaling is enabled, re-scales the axes the series is bound to (both the x axis and the y axis). @@ -354,7 +354,7 @@ QChart::AnimationOptions QChart::animationOptions() const } /*! - Scrolls the visible area of the chart by the distance defined in the \a delta. + Scrolls the visible area of the chart by the distance defined in the \a dx and \a dy. */ void QChart::scroll(qreal dx, qreal dy) {