From 73d53b3b614aa0a4c2c1b7e70aaf5f0445d34a46 2013-05-17 08:47:33 From: Miikka Heikkinen Date: 2013-05-17 08:47:33 Subject: [PATCH] Fix some documentation issues Change-Id: Idccfc1bdb7691175b37d570ea88eb3df5c3075c0 Reviewed-by: Tomi Korpipää --- diff --git a/src/areachart/qareaseries.cpp b/src/areachart/qareaseries.cpp index 4d21caf..3ef2d1b 100644 --- a/src/areachart/qareaseries.cpp +++ b/src/areachart/qareaseries.cpp @@ -199,7 +199,7 @@ QAreaSeries::~QAreaSeries() } /*! - Returns QChartSeries::SeriesTypeArea. + Returns QAbstractSeries::SeriesTypeArea. */ QAbstractSeries::SeriesType QAreaSeries::type() const { diff --git a/src/axis/datetimeaxis/qdatetimeaxis.cpp b/src/axis/datetimeaxis/qdatetimeaxis.cpp index ac5900d..2ada2a2 100644 --- a/src/axis/datetimeaxis/qdatetimeaxis.cpp +++ b/src/axis/datetimeaxis/qdatetimeaxis.cpp @@ -75,7 +75,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \qmlclass DateTimeAxis QDateTimeAxis - \brief The DateTimeAxis element is used for manipulating chart's axes + \brief The DateTimeAxis element is used for manipulating chart's axes. \inherits AbstractAxis The labels can be configured by setting an appropriate DateTime format. diff --git a/src/axis/logvalueaxis/qlogvalueaxis.cpp b/src/axis/logvalueaxis/qlogvalueaxis.cpp index 879fe24..8b4011f 100644 --- a/src/axis/logvalueaxis/qlogvalueaxis.cpp +++ b/src/axis/logvalueaxis/qlogvalueaxis.cpp @@ -42,7 +42,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \qmlclass LogValueAxis QLogValueAxis - \brief The LogValueAxis element is used for manipulating chart's axes + \brief The LogValueAxis element is used for manipulating chart's axes. \inherits AbstractAxis \note If a LogValueAxis is attached to a series with one or more points with diff --git a/src/axis/qabstractaxis.cpp b/src/axis/qabstractaxis.cpp index e2dc872..7e2704d 100644 --- a/src/axis/qabstractaxis.cpp +++ b/src/axis/qabstractaxis.cpp @@ -41,7 +41,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \qmlclass AbstractAxis QAbstractAxis - \brief The AbstractAxis is a base element used for specialized axis elements + \brief The AbstractAxis is a base element used for specialized axis elements. Each series can be bound to only one horizontal and vertical axis. diff --git a/src/barchart/horizontal/bar/qhorizontalbarseries.cpp b/src/barchart/horizontal/bar/qhorizontalbarseries.cpp index 23ddba2..7e6360b 100644 --- a/src/barchart/horizontal/bar/qhorizontalbarseries.cpp +++ b/src/barchart/horizontal/bar/qhorizontalbarseries.cpp @@ -31,7 +31,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHorizontalBarSeries - \brief Series for creating horizontal bar chart + \brief Series for creating horizontal bar chart. \mainclass QHorizontalBarSeries represents a series of data shown as bars. The purpose of this class is to draw bars diff --git a/src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp b/src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp index 57aaaa6..fc0b040 100644 --- a/src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp +++ b/src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp @@ -28,7 +28,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHorizontalPercentBarSeries - \brief Series for creating horizontal percent bar chart + \brief Series for creating horizontal percent bar chart. \mainclass QHorizontalPercentBarSeries represents a series of data shown as bars. The purpose of this class is to draw bars @@ -62,7 +62,7 @@ QHorizontalPercentBarSeries::QHorizontalPercentBarSeries(QObject *parent) : } /*! - Returns QChartSeries::SeriesTypeHorizontalPercentBar. + Returns QAbstractSeries::SeriesTypeHorizontalPercentBar. */ QAbstractSeries::SeriesType QHorizontalPercentBarSeries::type() const { diff --git a/src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp b/src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp index 418dd27..eaa26f6 100644 --- a/src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp +++ b/src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp @@ -27,7 +27,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHorizontalStackedBarSeries - \brief Series for creating horizontal stacked bar chart + \brief Series for creating horizontal stacked bar chart. \mainclass QHorizontalStackedBarSeries represents a series of data shown as bars. The purpose of this class is to draw bars @@ -72,7 +72,7 @@ QHorizontalStackedBarSeries::~QHorizontalStackedBarSeries() } /*! - Returns QChartSeries::SeriesTypeHorizontalStackedBar. + Returns QAbstractSeries::SeriesTypeHorizontalStackedBar. */ QAbstractSeries::SeriesType QHorizontalStackedBarSeries::type() const { diff --git a/src/barchart/qabstractbarseries.cpp b/src/barchart/qabstractbarseries.cpp index 7fedd09..4108dc4 100644 --- a/src/barchart/qabstractbarseries.cpp +++ b/src/barchart/qabstractbarseries.cpp @@ -36,7 +36,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QAbstractBarSeries - \brief Series for creating a bar chart + \brief Series for creating a bar chart. \mainclass QAbstractBarSeries represents a series of data shown as bars. The purpose of this class is to draw bars to diff --git a/src/barchart/qbarset.cpp b/src/barchart/qbarset.cpp index 868e481..2b4b465 100644 --- a/src/barchart/qbarset.cpp +++ b/src/barchart/qbarset.cpp @@ -27,7 +27,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBarSet - \brief Building block for different bar charts + \brief Building block for different bar charts. QBarSet represents one set of bars. Set of bars contains one data value for each category. First value of set is assumed to belong to first category, second to second category and so on. @@ -50,36 +50,36 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QBarSet::label - Defines the label of the barSet. + Defines the label of the bar set. */ /*! \qmlproperty string BarSet::label - Defines the label of the barSet. + Defines the label of the bar set. */ /*! \property QBarSet::pen - \brief Defines the pen used by the barSet. + \brief Defines the pen used by the bar set. */ /*! \property QBarSet::brush - \brief Defines the brush used by the barSet. + \brief Defines the brush used by the bar set. */ /*! \property QBarSet::labelBrush - \brief Defines the brush used by the barSet's label. + \brief Defines the brush used by the bar set's label. */ /*! \property QBarSet::labelFont - \brief Defines the font used by the barSet's label. + \brief Defines the font used by the bar set's label. */ /*! \qmlproperty Font BarSet::labelFont - Defines the font used by the barSet's label. + Defines the font used by the bar set's label. See the \l {Font} {QML Font Element} for detailed documentation. */ @@ -119,49 +119,49 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \fn void QBarSet::clicked(int index) - The signal is emitted if the user clicks with a mouse on top of barset. + The signal is emitted if the user clicks with a mouse on top of bar set. Clicked bar inside set is indexed by \a index */ /*! \fn void QBarSet::hovered(bool status) - The signal is emitted if mouse is hovered on top of barset. - Parameter \a status is true, if mouse entered on top of barset, false if mouse left from top of barset. + The signal is emitted if mouse is hovered on top of bar set. + Parameter \a status is true, if mouse entered on top of bar set, false if mouse left from top of bar set. */ /*! \fn void QBarSet::labelChanged() - This signal is emitted when the label of the barSet has changed. + This signal is emitted when the label of the bar set has changed. \sa label */ /*! \qmlsignal BarSet::onLabelChanged() - This signal is emitted when the label of the barSet has changed. + This signal is emitted when the label of the bar set has changed. */ /*! \fn void QBarSet::penChanged() - This signal is emitted when the pen of the barSet has changed. + This signal is emitted when the pen of the bar set has changed. \sa pen */ /*! \fn void QBarSet::brushChanged() - This signal is emitted when the brush of the barSet has changed. + This signal is emitted when the brush of the bar set has changed. \sa brush */ /*! \fn void QBarSet::labelBrushChanged() - This signal is emitted when the brush of the barSet's label has changed. + This signal is emitted when the brush of the bar set's label has changed. \sa labelBrush */ /*! \fn void QBarSet::labelFontChanged() - This signal is emitted when the font of the barSet's label has changed. + This signal is emitted when the font of the bar set's label has changed. \sa labelBrush */ @@ -234,12 +234,12 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \qmlproperty int BarSet::count - The count of values on the barset + The count of values on the bar set */ /*! \qmlproperty QVariantList BarSet::values - The values of the barset. You can set either a list of reals or a list of points as values. If you set a list of + The values of the bar set. You can set either a list of reals or a list of points as values. If you set a list of reals as values, the values are automatically completed to points by using the index of a value as it's x-coordinate. For example: \code @@ -258,7 +258,7 @@ QBarSet::QBarSet(const QString label, QObject *parent) } /*! - Destroys the barset. + Destroys the bar set. */ QBarSet::~QBarSet() { @@ -295,7 +295,7 @@ void QBarSet::append(const qreal value) /*! Appends a list of reals to set. Works like append with single real value. The \a values in list - are appended to end of barset + are appended to end of bar set. \sa append() */ void QBarSet::append(const QList &values) @@ -379,7 +379,7 @@ int QBarSet::count() const } /*! - Returns sum of all values in barset. + Returns sum of all values in the bar set. */ qreal QBarSet::sum() const { @@ -413,7 +413,7 @@ QPen QBarSet::pen() const } /*! - Sets brush for the set. Bars of this set are drawn using \a brush + Sets brush for the set. Bars of this set are drawn using \a brush. */ void QBarSet::setBrush(const QBrush &brush) { @@ -436,7 +436,7 @@ QBrush QBarSet::brush() const } /*! - Sets \a brush of the values that are drawn on top of this barset + Sets \a brush of the values that are drawn on top of this bar set. */ void QBarSet::setLabelBrush(const QBrush &brush) { @@ -448,7 +448,7 @@ void QBarSet::setLabelBrush(const QBrush &brush) } /*! - Returns brush of the values that are drawn on top of this barset + Returns brush of the values that are drawn on top of this bar set. */ QBrush QBarSet::labelBrush() const { @@ -459,7 +459,7 @@ QBrush QBarSet::labelBrush() const } /*! - Sets the \a font for values that are drawn on top of this barset + Sets the \a font for values that are drawn on top of this bar set. */ void QBarSet::setLabelFont(const QFont &font) { @@ -472,7 +472,7 @@ void QBarSet::setLabelFont(const QFont &font) } /*! - Returns the pen for values that are drawn on top of this barset + Returns the pen for values that are drawn on top of this bar set. */ QFont QBarSet::labelFont() const { @@ -480,7 +480,7 @@ QFont QBarSet::labelFont() const } /*! - Returns the color of the brush of barset. + Returns the color of the brush of bar set. */ QColor QBarSet::color() { @@ -488,7 +488,7 @@ QColor QBarSet::color() } /*! - Sets the \a color of brush for this barset + Sets the \a color of brush for this bar set. */ void QBarSet::setColor(QColor color) { @@ -508,7 +508,7 @@ void QBarSet::setColor(QColor color) } /*! - Returns the color of pen of this barset + Returns the color of pen of this bar set. */ QColor QBarSet::borderColor() { @@ -516,7 +516,7 @@ QColor QBarSet::borderColor() } /*! - Sets the color of pen for this barset + Sets the color of pen for this bar set. */ void QBarSet::setBorderColor(QColor color) { @@ -529,7 +529,7 @@ void QBarSet::setBorderColor(QColor color) } /*! - Returns the color of labels of this barset + Returns the color of labels of this bar set. */ QColor QBarSet::labelColor() { @@ -537,7 +537,7 @@ QColor QBarSet::labelColor() } /*! - Sets the color of labels for this barset + Sets the color of labels for this bar set. */ void QBarSet::setLabelColor(QColor color) { diff --git a/src/barchart/qhbarmodelmapper.cpp b/src/barchart/qhbarmodelmapper.cpp index 86bf662..f03cc71 100644 --- a/src/barchart/qhbarmodelmapper.cpp +++ b/src/barchart/qhbarmodelmapper.cpp @@ -24,7 +24,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHBarModelMapper - \brief Horizontal model mapper for bar series + \brief Horizontal model mapper for bar series. \mainclass Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series. @@ -81,7 +81,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHBarModelMapper::firstBarSetRow - \brief Defines which column of the model is used as the data source for the first bar set + \brief Defines which column of the model is used as the data source for the first bar set. + Default value is: -1 (invalid mapping) */ /*! @@ -92,7 +93,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHBarModelMapper::lastBarSetRow - \brief Defines which column of the model is used as the data source for the last bar set + \brief Defines which column of the model is used as the data source for the last bar set. + Default value is: -1 (invalid mapping) */ /*! @@ -104,6 +106,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHBarModelMapper::firstColumn \brief Defines which column of the model contains the first values of the QBarSets in the series. + Minimal and default value is: 0 */ /*! @@ -114,7 +117,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHBarModelMapper::columnCount - \brief Defines the number of columns of the model that are mapped as the data for QAbstractBarSeries + \brief Defines the number of columns of the model that are mapped as the data for QAbstractBarSeries. + Minimal and default value is: -1 (count limited by the number of columns in the model) */ /*! diff --git a/src/barchart/qvbarmodelmapper.cpp b/src/barchart/qvbarmodelmapper.cpp index ab05737..3f261f4 100644 --- a/src/barchart/qvbarmodelmapper.cpp +++ b/src/barchart/qvbarmodelmapper.cpp @@ -24,7 +24,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QVBarModelMapper - \brief Vertical model mapper for bar series + \brief Vertical model mapper for bar series. \mainclass Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series. @@ -82,7 +82,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVBarModelMapper::firstBarSetColumn - \brief Defines which column of the model is used as the data source for the first bar set + \brief Defines which column of the model is used as the data source for the first bar set. + Default value is: -1 (invalid mapping) */ /*! @@ -93,7 +94,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVBarModelMapper::lastBarSetColumn - \brief Defines which column of the model is used as the data source for the last bar set + \brief Defines which column of the model is used as the data source for the last bar set. + Default value is: -1 (invalid mapping) */ /*! @@ -105,6 +107,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVBarModelMapper::firstRow \brief Defines which row of the model contains the first values of the QBarSets in the series. + Minimal and default value is: 0 */ /*! @@ -115,7 +118,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVBarModelMapper::rowCount - \brief Defines the number of rows of the model that are mapped as the data for QAbstractBarSeries + \brief Defines the number of rows of the model that are mapped as the data for QAbstractBarSeries. + Minimal and default value is: -1 (count limited by the number of rows in the model) */ /*! diff --git a/src/barchart/vertical/bar/qbarseries.cpp b/src/barchart/vertical/bar/qbarseries.cpp index bf669b2..7a77e20 100644 --- a/src/barchart/vertical/bar/qbarseries.cpp +++ b/src/barchart/vertical/bar/qbarseries.cpp @@ -30,7 +30,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBarSeries - \brief Series for creating bar chart + \brief Series for creating bar chart. \mainclass QBarSeries represents a series of data shown as bars. The purpose of this class is to draw bars @@ -65,7 +65,7 @@ QBarSeries::QBarSeries(QObject *parent) } /*! - Returns QChartSeries::SeriesTypeBar. + Returns QAbstractSeries::SeriesTypeBar. */ QAbstractSeries::SeriesType QBarSeries::type() const { diff --git a/src/barchart/vertical/percent/qpercentbarseries.cpp b/src/barchart/vertical/percent/qpercentbarseries.cpp index bec0d4b..be05430 100644 --- a/src/barchart/vertical/percent/qpercentbarseries.cpp +++ b/src/barchart/vertical/percent/qpercentbarseries.cpp @@ -29,7 +29,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QPercentBarSeries - \brief Series for creating percent bar chart + \brief Series for creating percent bar chart. \mainclass QPercentBarSeries represents a series of data shown as bars. The purpose of this class is to draw bars @@ -73,7 +73,7 @@ QPercentBarSeries::~QPercentBarSeries() } /*! - Returns QChartSeries::SeriesTypePercentBar. + Returns QAbstractSeries::SeriesTypePercentBar. */ QAbstractSeries::SeriesType QPercentBarSeries::type() const { diff --git a/src/barchart/vertical/stacked/qstackedbarseries.cpp b/src/barchart/vertical/stacked/qstackedbarseries.cpp index b681fad..699c3c5 100644 --- a/src/barchart/vertical/stacked/qstackedbarseries.cpp +++ b/src/barchart/vertical/stacked/qstackedbarseries.cpp @@ -29,7 +29,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QStackedBarSeries - \brief Series for creating stacked bar chart + \brief Series for creating stacked bar chart. \mainclass QStackedBarSeries represents a series of data shown as bars. The purpose of this class is to draw bars @@ -73,7 +73,7 @@ QStackedBarSeries::~QStackedBarSeries() d->m_chart->removeSeries(this); } /*! - Returns QChartSeries::SeriesTypeStackedBar. + Returns QAbstractSeries::SeriesTypeStackedBar. */ QAbstractSeries::SeriesType QStackedBarSeries::type() const { diff --git a/src/legend/qarealegendmarker.cpp b/src/legend/qarealegendmarker.cpp index cc00387..5f5fc35 100644 --- a/src/legend/qarealegendmarker.cpp +++ b/src/legend/qarealegendmarker.cpp @@ -27,7 +27,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QAreaLegendMarker - \brief QAreaLegendMarker object + \brief QAreaLegendMarker object. \mainclass QAreaLegendMarker is related to QAreaSeries. One QAreaSeries results in one marker. diff --git a/src/legend/qbarlegendmarker.cpp b/src/legend/qbarlegendmarker.cpp index 50fac40..64d62dd 100644 --- a/src/legend/qbarlegendmarker.cpp +++ b/src/legend/qbarlegendmarker.cpp @@ -27,7 +27,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBarLegendMarker - \brief QBarLegendMarker object + \brief QBarLegendMarker object. \mainclass QBarLegendMarker is related to QAbstractBarSeries derived classes. With bar series, each marker is related to one QBarSet. diff --git a/src/legend/qlegend.cpp b/src/legend/qlegend.cpp index f40b6b4..4d6af79 100644 --- a/src/legend/qlegend.cpp +++ b/src/legend/qlegend.cpp @@ -38,7 +38,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QLegend - \brief Legend object + \brief Legend object. \mainclass QLegend is a graphical object for displaying the legend of the chart. Legend state is updated by QChart, when diff --git a/src/legend/qlegendmarker.cpp b/src/legend/qlegendmarker.cpp index 8453a5b..24a0635 100644 --- a/src/legend/qlegendmarker.cpp +++ b/src/legend/qlegendmarker.cpp @@ -32,7 +32,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QLegendMarker - \brief LegendMarker object + \brief LegendMarker object. \mainclass QLegendMarker is abstract object that can be used to access markers inside QLegend. Legend marker consists of two diff --git a/src/legend/qpielegendmarker.cpp b/src/legend/qpielegendmarker.cpp index 7540026..f681903 100644 --- a/src/legend/qpielegendmarker.cpp +++ b/src/legend/qpielegendmarker.cpp @@ -27,7 +27,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QPieLegendMarker - \brief LegendMarker object + \brief LegendMarker object. \mainclass QPieLegendMarker is related to QPieSeries. With QPieSeries, each slice of pie is related to one marker in QLegend. diff --git a/src/legend/qxylegendmarker.cpp b/src/legend/qxylegendmarker.cpp index b626af2..84439c7 100644 --- a/src/legend/qxylegendmarker.cpp +++ b/src/legend/qxylegendmarker.cpp @@ -27,7 +27,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QXYLegendMarker - \brief QXYLegendMarker object + \brief QXYLegendMarker object. \mainclass QXYLegendMarker is related to QXYSeries derived classes. Each marker is related to one series. diff --git a/src/piechart/qhpiemodelmapper.cpp b/src/piechart/qhpiemodelmapper.cpp index 946fb45..1fc18df 100644 --- a/src/piechart/qhpiemodelmapper.cpp +++ b/src/piechart/qhpiemodelmapper.cpp @@ -79,7 +79,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHPieModelMapper::valuesRow - \brief Defines which row of the model is kept in sync with the values of the pie's slices + \brief Defines which row of the model is kept in sync with the values of the pie's slices. + Default value is: -1 (invalid mapping) */ /*! @@ -90,7 +91,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHPieModelMapper::labelsRow - \brief Defines which row of the model is kept in sync with the labels of the pie's slices + \brief Defines which row of the model is kept in sync with the labels of the pie's slices. + Default value is: -1 (invalid mapping) */ /*! @@ -102,6 +104,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHPieModelMapper::firstColumn \brief Defines which column of the model contains the first slice value. + Minimal and default value is: 0 */ /*! @@ -112,7 +115,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHPieModelMapper::columnCount - \brief Defines the number of columns of the model that are mapped as the data for QPieSeries + \brief Defines the number of columns of the model that are mapped as the data for QPieSeries. + Minimal and default value is: -1 (count limited by the number of columns in the model) */ /*! diff --git a/src/piechart/qpieseries.cpp b/src/piechart/qpieseries.cpp index 9b2aad3..a566757 100644 --- a/src/piechart/qpieseries.cpp +++ b/src/piechart/qpieseries.cpp @@ -35,7 +35,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QPieSeries - \brief Pie series API for QtCommercial Charts + \brief Pie series API for QtCommercial Charts. The pie series defines a pie chart which consists of pie slices which are defined as QPieSlice objects. The slices can have any values as the QPieSeries will calculate its relative value to the sum of all slices. @@ -366,7 +366,7 @@ QPieSeries::~QPieSeries() } /*! - Returns QChartSeries::SeriesTypePie. + Returns QAbstractSeries::SeriesTypePie. */ QAbstractSeries::SeriesType QPieSeries::type() const { diff --git a/src/piechart/qvpiemodelmapper.cpp b/src/piechart/qvpiemodelmapper.cpp index 0c600f5..681a99b 100644 --- a/src/piechart/qvpiemodelmapper.cpp +++ b/src/piechart/qvpiemodelmapper.cpp @@ -78,7 +78,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVPieModelMapper::valuesColumn - \brief Defines which column of the model is kept in sync with the values of the pie's slices + \brief Defines which column of the model is kept in sync with the values of the pie's slices. + Default value is: -1 (invalid mapping) */ /*! @@ -89,7 +90,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVPieModelMapper::labelsColumn - \brief Defines which column of the model is kept in sync with the labels of the pie's slices + \brief Defines which column of the model is kept in sync with the labels of the pie's slices. + Default value is: -1 (invalid mapping) */ /*! @@ -101,6 +103,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVPieModelMapper::firstRow \brief Defines which row of the model contains the first slice value. + Minimal and default value is: 0 */ /*! @@ -111,7 +114,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVPieModelMapper::rowCount - \brief Defines the number of rows of the model that are mapped as the data for QPieSeries + \brief Defines the number of rows of the model that are mapped as the data for QPieSeries. + Minimal and default value is: -1 (count limited by the number of rows in the model) */ /*! diff --git a/src/qabstractseries.cpp b/src/qabstractseries.cpp index f391640..f422cfb 100644 --- a/src/qabstractseries.cpp +++ b/src/qabstractseries.cpp @@ -112,6 +112,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QAbstractSeries::opacity \brief The opacity of the series. + By default the opacity is 1.0. The valid values range from 0.0 (transparent) to 1.0 (opaque). */ /*! @@ -199,7 +200,7 @@ QChart *QAbstractSeries::chart() const } /*! - \brief Sets the visibility of the series to true + \brief Sets the visibility of the series to true. \sa setVisible(), isVisible() */ @@ -209,7 +210,7 @@ void QAbstractSeries::show() } /*! - \brief Sets the visibility of the series to false + \brief Sets the visibility of the series to false. \sa setVisible(), isVisible() */ diff --git a/src/scatterchart/qscatterseries.cpp b/src/scatterchart/qscatterseries.cpp index 2468529..9b3b2ce 100644 --- a/src/scatterchart/qscatterseries.cpp +++ b/src/scatterchart/qscatterseries.cpp @@ -124,8 +124,8 @@ */ /*! - \fn QChartSeriesType QScatterSeries::type() const - Returns QChartSeries::SeriesTypeScatter. + \fn QAbstractSeries::SeriesType QScatterSeries::type() const + Returns QAbstractSeries::SeriesTypeScatter. \sa QAbstractSeries, SeriesType */ diff --git a/src/xychart/qhxymodelmapper.cpp b/src/xychart/qhxymodelmapper.cpp index 1f2bc29..c0d8838 100644 --- a/src/xychart/qhxymodelmapper.cpp +++ b/src/xychart/qhxymodelmapper.cpp @@ -42,6 +42,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHXYModelMapper::series \brief Defines the QXYSeries object that is used by the mapper. + All the data in the series is discarded when it is set to the mapper. When new series is specified the old series is disconnected (it preserves its data) */ @@ -64,7 +65,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHXYModelMapper::xRow - \brief Defines which row of the model is kept in sync with the x values of the QXYSeries + \brief Defines which row of the model is kept in sync with the x values of the QXYSeries. + Default value is: -1 (invalid mapping) */ /*! @@ -75,7 +77,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHXYModelMapper::yRow - \brief Defines which row of the model is kept in sync with the y values of the QXYSeries + \brief Defines which row of the model is kept in sync with the y values of the QXYSeries. + Default value is: -1 (invalid mapping) */ /*! @@ -87,6 +90,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHXYModelMapper::firstColumn \brief Defines which column of the model contains the data for the first point of the series. + Minimal and default value is: 0 */ /*! @@ -97,7 +101,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QHXYModelMapper::columnCount - \brief Defines the number of columns of the model that are mapped as the data for series + \brief Defines the number of columns of the model that are mapped as the data for series. + Minimal and default value is: -1 (count limited by the number of columns in the model) */ /*! diff --git a/src/xychart/qvxymodelmapper.cpp b/src/xychart/qvxymodelmapper.cpp index d6cc9a6..205d68d 100644 --- a/src/xychart/qvxymodelmapper.cpp +++ b/src/xychart/qvxymodelmapper.cpp @@ -42,6 +42,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVXYModelMapper::series \brief Defines the QXYSeries object that is used by the mapper. + All the data in the series is discarded when it is set to the mapper. When new series is specified the old series is disconnected (it preserves its data) */ @@ -64,7 +65,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVXYModelMapper::xColumn - \brief Defines which column of the model is kept in sync with the x values of QXYSeries + \brief Defines which column of the model is kept in sync with the x values of QXYSeries. + Default value is: -1 (invalid mapping) */ /*! @@ -75,7 +77,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVXYModelMapper::yColumn - \brief Defines which column of the model is kept in sync with the y values of QXYSeries + \brief Defines which column of the model is kept in sync with the y values of QXYSeries. + Default value is: -1 (invalid mapping) */ /*! @@ -87,6 +90,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVXYModelMapper::firstRow \brief Defines which row of the model contains the data for the first point of the series. + Minimal and default value is: 0 */ /*! @@ -97,7 +101,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \property QVXYModelMapper::rowCount - \brief Defines the number of rows of the model that are mapped as the data for series + \brief Defines the number of rows of the model that are mapped as the data for series. + Minimal and default value is: -1 (count limited by the number of rows in the model) */ /*!