HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r2520:73d53b3b614a

Fix some documentation issues...

Miikka Heikkinen -

r2520:73d53b3b614a

parent child

Context file:

r2520:73d53b3b614a

Expand all files

src/areachart/qareaseries.cpp +1 -1

              }
              /*!
-                 Returns QChartSeries::SeriesTypeArea.
+                 Returns QAbstractSeries::SeriesTypeArea.
              */
              QAbstractSeries::SeriesType QAreaSeries::type() const
              {

src/axis/datetimeaxis/qdatetimeaxis.cpp +1 -1

              /*!
                  \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.

src/axis/logvalueaxis/qlogvalueaxis.cpp +1 -1

              /*!
                  \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

src/axis/qabstractaxis.cpp +1 -1

              /*!
                  \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.

src/barchart/horizontal/bar/qhorizontalbarseries.cpp +1 -1

              /*!
                  \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

src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp +2 -2

              /*!
                  \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
              }
              /*!
-                 Returns QChartSeries::SeriesTypeHorizontalPercentBar.
+                 Returns QAbstractSeries::SeriesTypeHorizontalPercentBar.
              */
              QAbstractSeries::SeriesType QHorizontalPercentBarSeries::type() const
              {

src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp +2 -2

              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
              }
              /*!
-                 Returns QChartSeries::SeriesTypeHorizontalStackedBar.
+                 Returns QAbstractSeries::SeriesTypeHorizontalStackedBar.
              */
              QAbstractSeries::SeriesType QHorizontalStackedBarSeries::type() const
              {

src/barchart/qabstractbarseries.cpp +1 -1

              /*!
                  \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

src/barchart/qbarset.cpp +33 -33

              /*!
                  \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.
              /*!
                  \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.
              */
              /*!
                  \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
              */
              /*!
                  \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
              }
              /*!
-                 Destroys the barset.
+                 Destroys the bar set.
              */
              QBarSet::~QBarSet()
              {
              /*!
                  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<qreal> &values)
              }
              /*!
-                 Returns sum of all values in barset.
+                 Returns sum of all values in the bar set.
              */
              qreal QBarSet::sum() 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)
              {
              }
              /*!
-                 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)
              {
              }
              /*!
-                 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
              {
              }
              /*!
-                 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)
              {
              }
              /*!
-                 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
              {
              }
              /*!
-                 Returns the color of the brush of barset.
+                 Returns the color of the brush of bar set.
              */
              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)
              {
              }
              /*!
-                 Returns the color of pen of this barset
+                 Returns the color of pen of this bar set.
              */
              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)
              {
              }
              /*!
-                 Returns the color of labels of this barset
+                 Returns the color of labels of this bar set.
              */
              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)
              {

src/barchart/qhbarmodelmapper.cpp +8 -4

              /*!
                  \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.
              /*!
                  \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)
              */
              /*!
              /*!
                  \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)
              */
              /*!
              /*!
                  \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
              */
              /*!
              /*!
                  \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)
              */
              /*!

src/barchart/qvbarmodelmapper.cpp +8 -4

              /*!
                  \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.
              /*!
                  \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)
              */
              /*!
              /*!
                  \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)
              */
              /*!
              /*!
                  \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
              */
              /*!
              /*!
                  \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)
              */
              /*!

src/barchart/vertical/bar/qbarseries.cpp +2 -2

              /*!
                  \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
              }
              /*!
-                 Returns QChartSeries::SeriesTypeBar.
+                 Returns QAbstractSeries::SeriesTypeBar.
              */
              QAbstractSeries::SeriesType QBarSeries::type() const
              {

src/barchart/vertical/percent/qpercentbarseries.cpp +2 -2

              /*!
                  \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
              }
              /*!
-                 Returns QChartSeries::SeriesTypePercentBar.
+                 Returns QAbstractSeries::SeriesTypePercentBar.
              */
              QAbstractSeries::SeriesType QPercentBarSeries::type() const
              {

src/barchart/vertical/stacked/qstackedbarseries.cpp +2 -2

              /*!
                  \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
                      d->m_chart->removeSeries(this);
              }
              /*!
-                 Returns QChartSeries::SeriesTypeStackedBar.
+                 Returns QAbstractSeries::SeriesTypeStackedBar.
              */
              QAbstractSeries::SeriesType QStackedBarSeries::type() const
              {

src/legend/qarealegendmarker.cpp +1 -1

              /*!
                  \class QAreaLegendMarker
-                 \brief QAreaLegendMarker object
+                 \brief QAreaLegendMarker object.
                  \mainclass
                  QAreaLegendMarker is related to QAreaSeries. One QAreaSeries results in one marker.

src/legend/qbarlegendmarker.cpp +1 -1

              /*!
                  \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.

src/legend/qlegend.cpp +1 -1

              /*!
                  \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

src/legend/qlegendmarker.cpp +1 -1

              /*!
                  \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

src/legend/qpielegendmarker.cpp +1 -1

              /*!
                  \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.

src/legend/qxylegendmarker.cpp +1 -1

              /*!
                  \class QXYLegendMarker
-                 \brief QXYLegendMarker object
+                 \brief QXYLegendMarker object.
                  \mainclass
                  QXYLegendMarker is related to QXYSeries derived classes. Each marker is related to one series.

src/piechart/qhpiemodelmapper.cpp +7 -3

              /*!
                  \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)
              */
              /*!
              /*!
                  \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)
              */
              /*!
              /*!
                  \property QHPieModelMapper::firstColumn
                  \brief Defines which column of the model contains the first slice value.
                  Minimal and default value is: 0
              */
              /*!
              /*!
                  \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)
              */
              /*!

src/piechart/qpieseries.cpp +2 -2

              /*!
                  \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.
              }
              /*!
-                 Returns QChartSeries::SeriesTypePie.
+                 Returns QAbstractSeries::SeriesTypePie.
              */
              QAbstractSeries::SeriesType QPieSeries::type() const
              {

src/piechart/qvpiemodelmapper.cpp +7 -3

              /*!
                  \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)
              */
              /*!
              /*!
                  \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)
              */
              /*!
              /*!
                  \property QVPieModelMapper::firstRow
                  \brief Defines which row of the model contains the first slice value.
                  Minimal and default value is: 0
              */
              /*!
              /*!
                  \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)
              */
              /*!

src/qabstractseries.cpp +3 -2

              /*!
                  \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).
              */
              /*!
              }
              /*!
-                 \brief Sets the visibility of the series to true
+                 \brief Sets the visibility of the series to true.
                  \sa setVisible(), isVisible()
              */
              }
              /*!
-                 \brief Sets the visibility of the series to false
+                 \brief Sets the visibility of the series to false.
                  \sa setVisible(), isVisible()
              */

src/scatterchart/qscatterseries.cpp +2 -2

              */
              /*!
-                 \fn QChartSeriesType QScatterSeries::type() const
-                 Returns QChartSeries::SeriesTypeScatter.
+                 \fn QAbstractSeries::SeriesType QScatterSeries::type() const
+                 Returns QAbstractSeries::SeriesTypeScatter.
                  \sa QAbstractSeries, SeriesType
              */

src/xychart/qhxymodelmapper.cpp +8 -3

              /*!
                  \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)
              */
              /*!
                  \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)
              */
              /*!
              /*!
                  \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)
              */
              /*!
              /*!
                  \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
              */
              /*!
              /*!
                  \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)
              */
              /*!

src/xychart/qvxymodelmapper.cpp +8 -3

              /*!
                  \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)
              */
              /*!
                  \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)
              */
              /*!
              /*!
                  \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)
              */
              /*!
              /*!
                  \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
              */
              /*!
              /*!
                  \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)
              */
              /*!

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages