HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r2494:232715f311f8

Documentation updates...

Miikka Heikkinen -

r2494:232715f311f8

parent child

Context file:

r2494:232715f311f8

Expand all files

src/areachart/qareaseries.cpp +2 -2

             /*!
                 \property QAreaSeries::lowerSeries
                 The lower one of the two line series used to define are series boundaries. Note if
-                QAreaSeries was counstucted wihtout a\ lowerSeries this is null.
+                QAreaSeries was constructed without a\ lowerSeries this is null.
             */
             /*!
                 \qmlproperty LineSeries AreaSeries::lowerSeries
                 The lower one of the two line series used to define are series boundaries. Note if
-                AreaSeries was counstucted wihtout a\ lowerSeries this is null.
+                AreaSeries was constructed without a\ lowerSeries this is null.
             */
             /*!

src/axis/barcategoryaxis/qbarcategoryaxis.cpp +1 -1

             }
             /*!
-                Replaces \a oldCategory with \a newCategory. If \a oldCategory does not exits on the axis nothing is done.
+                Replaces \a oldCategory with \a newCategory. If \a oldCategory does not exist on the axis nothing is done.
                 A \a newCategory has to be valid QStrings and can not be duplicated. In case of replacing minimum or maximum category,
                 minimum and maximum of axis is updated accordingly.
             */

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

                 \mainclass
                 The labels can be configured by setting an appropriate DateTime format.
-                QDateTimeAxis works correctly with dates from 4714 BCE to 287396 CE
+                QDateTimeAxis works correctly with dates from 4714 BCE to 287396 CE.
-                There are also other limitiation related to QDateTime . Please refer to QDateTime documentation.
+                There are also other limitiation related to QDateTime. Please refer to QDateTime documentation.
                 QDateTimeAxis can be setup to show axis line with tick marks, grid lines and shades.
                 Note: QDateTimeAxis is disabled on ARM architecture.
                 \image api_datatime_axis.png
-                QDateTimeAxis can be used with QLineSeries, QSplineSeries or QScatterSeries.
+                QDateTimeAxis can be used with any QXYSeries.
                 To add a data point to the series QDateTime::toMSecsSinceEpoch() is used.
                 \code
                 QLineSeries *series = new QLineSeries;

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

             */
             /*!
-                \qmlclass LogValuesAxis QLogValueAxis
+                \qmlclass LogValueAxis QLogValueAxis
                 \brief The LogValueAxis element is used for manipulating chart's axes
                 \inherits AbstractAxis
               Value has to be greater than 0.
             */
             /*!
-              \qmlproperty real LogValuesAxis::min
+              \qmlproperty real LogValueAxis::min
               Defines the minimum value on the axis.
               When setting this property the max is adjusted if necessary, to ensure that the range remains valid.
               Value has to be greater than 0.
               Value has to be greater than 0.
             */
             /*!
-              \qmlproperty real LogValuesAxis::max
+              \qmlproperty real LogValueAxis::max
               Defines the maximum value on the axis.
               When setting this property the min is adjusted if necessary, to ensure that the range remains valid.
               Value has to be greater than 0.
               Value has to be greater than 0 and not equal 1
             */
             /*!
-              \qmlproperty real LogValuesAxis::base
+              \qmlproperty real LogValueAxis::base
               Defines the maximum value on the axis.
               Defines the base of the logarithm.
               Value has to be greater than 0 and not equal 1
               See QString::sprintf() for additional details.
             */
             /*!
-              \qmlproperty real LogValuesAxis::labelFormat
+              \qmlproperty real LogValueAxis::labelFormat
               Defines the label format of the axis.
               Supported specifiers are: d, i, o, x, X, f, F, e, E, g, G, c
               See QString::sprintf() for additional details.
               Axis emits signal when \a min of axis has changed.
             */
             /*!
-              \qmlsignal LogValuesAxis::onMinChanged(qreal min)
+              \qmlsignal LogValueAxis::onMinChanged(qreal min)
               Axis emits signal when \a min of axis has changed.
             */
               Axis emits signal when \a max of axis has changed.
             */
             /*!
-              \qmlsignal LogValuesAxis::onMaxChanged(qreal max)
+              \qmlsignal LogValueAxis::onMaxChanged(qreal max)
               Axis emits signal when \a max of axis has changed.
             */
               Axis emits signal when \a base of logarithm of the axis has changed.
             */
             /*!
-              \qmlsignal LogValuesAxis::baseChanged(qreal base)
+              \qmlsignal LogValueAxis::baseChanged(qreal base)
               Axis emits signal when \a base of logarithm of the axis has changed.
             */

src/axis/qabstractaxis.cpp +13 -21

@@ -30,30 +30,22 QTCOMMERCIALCHART_BEGIN_NAMESPACE
30	\brief The QAbstractAxis class is used for manipulating chart's axis.	30	\brief The QAbstractAxis class is used for manipulating chart's axis.
31	\mainclass	31	\mainclass
32		32
33	There is only one x Axis visible at the time, however there can be multiple y axes.	33	Each series can be bound to one or more horizontal and vertical axes, but mixing axis types
34	Each chart series can be bound to exactly one Y axis and the shared common X axis.	34	that would result in different domains is not supported, such as specifying
35	Axis can be setup to show axis line with tick marks, grid lines and shades.	35	QValueAxis and QLogValueAxis on the same orientation.
		36
		37	Properties and visibility of various axis elements such as axis line, title, labels, grid lines,
		38	and shades can be individually controlled.
36	*/	39	*/
37		40
38	/*!	41	/*!
39	\qmlclass AbstractAxis QAbstractAxis	42	\qmlclass AbstractAxis QAbstractAxis
40	\brief The Axis element is used for manipulating chart's axes	43	\brief The AbstractAxis is a base element used for specialized axis elements
41		44
42	There is only one x Axis visible at the time, however there can be multiple y axes on a ChartView.	45	Each series can be bound to only one horizontal and vertical axis.
43	Each chart series can be bound to exactly one Y axis and the shared common X axis.	46
44	Axis can be setup to show axis line with tick marks, grid lines and shades.	47	Properties and visibility of various axis elements such as axis line, title, labels, grid lines,
45		48	and shades can be individually controlled.
46	To access Axes you can use ChartView API. For example:
47	\code
48	ChartView {
49	axisX.min: 0
50	axisX.max: 3
51	axisX.ticksCount: 4
52	axisY.min: 0
53	axisY.max: 4
54	// Add a few series...
55	}
56	\endcode
57	*/	49	*/
58		50
59	/*!	51	/*!
@@ -249,7 +241,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
249	*/	241	*/
250	/*!	242	/*!
251	\qmlproperty Qt.Orientation AbstractAxis::orientation	243	\qmlproperty Qt.Orientation AbstractAxis::orientation
252	The orientation of the axis. Fixed to either Qt.Horizontal or Qt.Vertical when the axis is set to a ~~Chart/S~~eries.	244	The orientation of the axis. Fixed to either Qt.Horizontal or Qt.Vertical when the axis is set to a series.
253	*/	245	*/
254		246
255	/*!	247	/*!

src/axis/valueaxis/qvalueaxis.cpp +5 -5

                 ValueAxis can be setup to show axis line with tick marks, grid lines and shades.
                 Values of axis are drawn to position of ticks
-                To access Axes you can use ChartView API. For example:
+                Example about using ValueAxis:
                 \code
                     ChartView {
                         ValueAxis {
             /*!
               \qmlproperty real ValueAxis::tickCount
                Defines the number of ticks on the axis. This indicates how many grid lines are draw on the chart.
-              The default value is 5, and it can not be below 2.
+               The default value is 5, and it can not be below 2.
             */
             /*!
             /*!
               \fn void QValueAxis::tickCountChanged(int tickCount)
-              Axis emits signal when \a tickCount number on axis have changed.
+              Axis emits signal when \a tickCount of axis has changed.
             */
             /*!
               \qmlsignal ValueAxis::tickCountChanged(int tickCount)
-              Axis emits signal when \a tickCount number on axis have changed.
+              Axis emits signal when \a tickCount of axis has changed.
             */
             /*!
             */
             /*!
               \qmlsignal ValueAxis::labelFormatChanged(const QString &format)
-               Axis emits signal when \a format of axis labels has changed.
+              Axis emits signal when \a format of axis labels has changed.
             */
             /*!

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

             }
             /*!
-                Destructor
+                Destructor.
                 Removes series from chart.
             */
             QHorizontalBarSeries::~QHorizontalBarSeries()

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

             }
             /*!
-                Destructor
+                Destructor.
                 Removes series from chart.
             */
             QHorizontalPercentBarSeries::~QHorizontalPercentBarSeries()

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

             }
             /*!
-                Destructor
+                Destructor.
                 Removes series from chart.
             */
             QHorizontalStackedBarSeries::~QHorizontalStackedBarSeries()

src/barchart/qbarset.cpp +6 -6

                 \fn void QBarSet::valuesAdded(int index, int count)
                 This signal is emitted when new values have been added to the set.
                 Parameter \a index indicates the position of the first inserted value.
-                Parameter \a count is the number of iserted values.
+                Parameter \a count is the number of inserted values.
                 \sa append(), insert()
             */
             /*!
                 \qmlsignal BarSet::onValuesAdded(int index, int count)
                 This signal is emitted when new values have been added to the set.
                 Parameter \a index indicates the position of the first inserted value.
-                Parameter \a count is the number of iserted values.
+                Parameter \a count is the number of inserted values.
             */
             /*!
             */
             /*!
-                Constructs QBarSet with a label of \a label and with parent of \a parent
+                Constructs QBarSet with a label of \a label and with parent of \a parent.
             */
             QBarSet::QBarSet(const QString label, QObject *parent)
                 : QObject(parent),
             }
             /*!
-                Destroys the barset
+                Destroys the barset.
             */
             QBarSet::~QBarSet()
             {
             /*!
                 Inserts new \a value on the \a index position.
-                The value that is currently at this postion is moved to postion index + 1
+                The value that is currently at this postion is moved to position index + 1
                 \sa remove()
             */
             void QBarSet::insert(const int index, const qreal value)
             }
             /*!
-                Sets a new value \a value to set, indexed by \a index
+                Sets a new value \a value to set, indexed by \a index.
             */
             void QBarSet::replace(const int index, const qreal value)
             {

src/barchart/qhbarmodelmapper.cpp +1 -1

                 Horizontal model mapper is used to create a connection between QAbstractBarSeries and QAbstractItemModel derived model object.
                 Model mapper maintains equal size of all the BarSets.
                 Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
-                Note: used model has to support adding/removing rows/columns and modifying the data of the cells.
+                \note Used model has to support adding/removing rows/columns and modifying the data of the cells.
             */
             /*!
                 \qmlclass HBarModelMapper QHBarModelMapper

src/barchart/qvbarmodelmapper.cpp +1 -1

                 Vertical model mapper is used to create a connection between QAbstractBarSeries and QAbstractItemModel derived model object.
                 Model mapper maintains equal size of all the BarSets.
                 Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series.
-                Note: used model has to support adding/removing rows/columns and modifying the data of the cells.
+                \note Used model has to support adding/removing rows/columns and modifying the data of the cells.
             */
             /*!
                 \qmlclass VBarModelMapper

src/legend/qlegend.cpp +1 -1

                 \brief Legend object
                 \mainclass
-                QLegend is a graphical object, whics displays legend of the chart. Legend state is updated by QChart, when
+                QLegend is a graphical object for displaying the legend of the chart. Legend state is updated by QChart, when
                 series have been changed. By default, legend is drawn by QChart, but user can set a new parent to legend and
                 handle the drawing manually.
                 User isn't supposed to create or delete legend objects, but can reference it via QChart class.

src/piechart/qhpiemodelmapper.cpp +1 -1

                 Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series.
                 Horizontal model mapper is used to create a connection between QPieSeries and QAbstractItemModel derived model object that keeps the consecutive pie slices data in rows.
                 It is possible to use both QAbstractItemModel and QPieSeries model API. QHPieModelMapper makes sure that Pie and the model are kept in sync.
-                Note: used model has to support adding/removing rows/columns and modifying the data of the cells.
+                \note Used model has to support adding/removing rows/columns and modifying the data of the cells.
             */
             /*!
                 \qmlclass HPieModelMapper QHPieModelMapper

src/piechart/qpieseries.cpp +2 -2

                 The slices can have any values as the QPieSeries will calculate its relative value to the sum of all slices.
                 The actual slice size is determined by that relative value.
-                Pie size and position on the chart is controlled by using relative values which range from 0.0 to 1.0
+                Pie size and position on the chart is controlled by using relative values which range from 0.0 to 1.0.
                 These relate to the actual chart rectangle.
                 By default the pie is defined as a full pie but it can also be a partial pie.
             /*!
                 Takes a single \a slice from the series. Does not destroy the slice object.
-                NOTE: The series remains as the slice's parent object. You must set the
+                \note The series remains as the slice's parent object. You must set the
                 parent object to take full ownership.
                 Returns true if take was successful.

src/piechart/qvpiemodelmapper.cpp +1 -1

                 Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series.
                 Vertical model mapper is used to create a connection between QPieSeries and QAbstractItemModel derived model object that keeps the consecutive pie slices data in columns.
                 It is possible to use both QAbstractItemModel and QPieSeries model API. QVPieModelMapper makes sure that Pie and the model are kept in sync.
-                Note: used model has to support adding/removing rows/columns and modifying the data of the cells.
+                \note Used model has to support adding/removing rows/columns and modifying the data of the cells.
             */
             /*!
                 \qmlclass VPieModelMapper QVPieModelMapper

src/qabstractseries.cpp +2 -8

             /*!
                 \internal
-                \brief Constructs ChartSeries object with \a parent.
+                \brief Constructs QAbstractSeries object with \a parent.
             */
             QAbstractSeries::QAbstractSeries(QAbstractSeriesPrivate &d, QObject *parent) :
                 QObject(parent),
             QAbstractSeries::~QAbstractSeries()
             {
                 if (d_ptr->m_chart)
-                    qFatal("Still binded series detected !");
+                    qFatal("Series still bound to a chart when destroyed!");
             }
             void QAbstractSeries::setName(const QString &name)
                 return d_ptr->m_name;
             }
-            /*!
-                Sets the visibility of series to \a visible
-            */
             void QAbstractSeries::setVisible(bool visible)
             {
                 if (visible != d_ptr->m_visible) {
                 }
             }
-            /*!
-                Returns the visibility of series
-            */
             bool QAbstractSeries::isVisible() const
             {
                 return d_ptr->m_visible;

src/qchart.cpp +88 -102

              \brief QtCommercial chart API.
              QChart is a QGraphicsWidget that you can show in a QGraphicsScene. It manages the graphical
-             representation of different types of series and other chart related objects like
+             representation of different types of series and other chart related objects like legend and
-             QAxis and QLegend. If you simply want to show a chart in a layout, you can use the
+             axes. If you simply want to show a chart in a layout, you can use the
              convenience class QChartView instead of QChart.
-             \sa QChartView
+             \sa QChartView, QPolarChart
              */
             /*!
             /*!
              \property QChart::backgroundVisible
-             Whether the chart background is visible or not.
+             Specifies whether the chart background is visible or not.
              \sa setBackgroundBrush(), setBackgroundPen()
              */
             /*!
              \property QChart::minimumMargins
              Minimum margins between the plot area (axes) and the edge of the chart widget.
+             This property is deprecated; use margins property instead.
+             \sa margins
              */
             /*!
              \property QChart::margins
-             Minimum between the plot area (axes) and the edge of the chart widget.
+             Margins between the plot area (axes) and the edge of the chart widget.
              */
             /*!
              \property QChart::theme
              Theme is a built-in collection of UI style related settings applied for all visual elements of a chart, like colors,
-             pens, brushes and fonts of series, axes, title and legend. \l {Chart themes demo} shows an example with a few
+             pens, brushes, and fonts of series, axes, title, and legend. \l {Chart themes demo} shows an example with a few
              different themes.
-             Note: changing the theme will overwrite all customizations previously applied to the series.
+             \note Changing the theme will overwrite all customizations previously applied to the series.
              */
             /*!
             /*!
              \property QChart::chartType
              Chart type indicates if the chart is a cartesian chart or a polar chart.
-             This property is set internally and is read only.
+             This property is set internally and it is read only.
              \sa QPolarChart
              */
             }
             /*!
-             Destroys the object and it's children, like series and axis objects added to it.
+             Destroys the chart object and its children, like series and axis objects added to it.
              */
             QChart::~QChart()
             {
             }
             /*!
-             Adds the \a series onto the chart and takes the ownership of the object.
+             Adds the \a series onto the chart and takes the ownership of it.
-             If auto scaling is enabled, re-scales the axes the series is bound to (both the x axis and
-             the y axis).
+             \note A newly added series is attached to no axes by default, including any axes that were created for the chart
+             using createDefaultAxes() before the series was added to the chart. If no axes are attached to
+             the newly added series before the chart is shown, the series will get drawn as if it had axes with ranges
+             that exactly fit the series to the plot area of the chart. This can be confusing if the same chart also displays other
+             series that have properly attached axes, so always make sure you either call createDefaultAxes() after
+             a series has been added or explicitly attach axes for the series.
-             \sa removeSeries(), removeAllSeries()
+             \sa removeSeries(), removeAllSeries(), createDefaultAxes(), QAbstractSeries::attachAxis()
              */
             void QChart::addSeries(QAbstractSeries *series)
             {
             }
             /*!
-             Removes the \a series specified in a perameter from the QChartView.
+             Removes the \a series from the chart.
-             It releses its ownership of the specified QChartSeries object.
+             The chart releases its ownership of the specified \a series object.
-             It does not delete the pointed QChartSeries data object
              \sa addSeries(), removeAllSeries()
              */
             void QChart::removeSeries(QAbstractSeries *series)
             }
             /*!
-             Removes all the QChartSeries that have been added to the QChartView
+             Removes and deletes all series objects that have been added to the chart.
-             It also deletes the pointed QChartSeries data objects
              \sa addSeries(), removeSeries()
              */
             void QChart::removeAllSeries()
             }
             /*!
-                Gets the brush that is used for painting the background of the chart area.
+             Gets the brush that is used for painting the background of the chart area.
              */
             QBrush QChart::backgroundBrush() const
             {
             }
             /*!
-                Gets the pen that is used for painting the background of the chart area.
+             Gets the pen that is used for painting the background of the chart area.
              */
             QPen QChart::backgroundPen() const
             {
                 return d_ptr->m_presenter->backgroundPen();
             }
-            /*!
-             Sets the chart \a title. The description text that is drawn above the chart.
-             */
             void QChart::setTitle(const QString &title)
             {
                 d_ptr->m_presenter->setTitle(title);
             }
-            /*!
-             Returns the chart title. The description text that is drawn above the chart.
-             */
             QString QChart::title() const
             {
                 return d_ptr->m_presenter->title();
             }
             /*!
-             Sets the \a font that is used for drawing the chart description text that is rendered above the chart.
+             Sets the \a font that is used for drawing the chart title.
              */
             void QChart::setTitleFont(const QFont &font)
             {
             }
             /*!
-                Gets the font that is used for drawing the chart description text that is rendered above the chart.
+             Gets the font that is used for drawing the chart title.
              */
             QFont QChart::titleFont() const
             {
             }
             /*!
-             Sets the \a brush used for rendering the title text.
+             Sets the \a brush used for drawing the title text.
              */
             void QChart::setTitleBrush(const QBrush &brush)
             {
             }
             /*!
-             Returns the brush used for rendering the title text.
+             Returns the brush used for drawing the title text.
              */
             QBrush QChart::titleBrush() const
             {
             }
             /*!
-             Zooms in the view by a factor of 2
+             Zooms in the view by a factor of two.
              */
             void QChart::zoomIn()
             {
             }
             /*!
-             Restores the view zoom level to the previous one.
+             Zooms out the view by a factor of two.
              */
             void QChart::zoomOut()
             {
             }
             /*!
-             Zooms in the view by a \a factor.
+             Zooms in the view by a custom \a factor.
              A factor over 1.0 zooms the view in and factor between 0.0 and 1.0 zooms out.
              */
             }
             /*!
-             Returns the pointer to the x axis object of the chart associated with the specified \a series.
+             Returns a pointer to the horizontal axis attached to the specified \a series.
-             If no series is provided then pointer to currently visible axis is provided.
+             If no \a series is specified, the first horizontal axis added to the chart is returned.
+             \sa addAxis(), QAbstractSeries::attachAxis()
              */
             QAbstractAxis *QChart::axisX(QAbstractSeries *series) const
             {
             }
             /*!
-             Returns the pointer to the y axis object of the chart associated with the specified \a series.
+             Returns a pointer to the vertical axis attached to the specified \a series.
-             If no series is provided then pointer to currently visible axis is provided.
+             If no \a series is specified, the first vertical axis added to the chart is returned.
+             \sa addAxis(), QAbstractSeries::attachAxis()
              */
             QAbstractAxis *QChart::axisY(QAbstractSeries *series) const
             {
             }
             /*!
-             Returns the axes added for the \a series with \a orientation. If no series is provided, then all axes with the
+             Returns the axes attached to the \a series with \a orientation. If no \a series is provided,
-             specified orientation are returned.
+             then all axes added to the chart with the specified orientation are returned.
              \sa addAxis(), createDefaultAxes()
              */
             QList<QAbstractAxis *> QChart::axes(Qt::Orientations orientation, QAbstractSeries *series) const
             }
             /*!
-             NOTICE: This function has to be called after series has been added to the chart if no customized axes are set to the chart. Otherwise axisX(), axisY() calls return NULL.
+             Creates axes for the chart based on the series that have already been added to the chart. Any axes previously added to
+             the chart will be deleted.
-             Creates the axes for the chart based on the series that has already been added to the chart.
+             \note This function has to be called after all series have been added to the chart. The axes created by this function
+             will NOT get automatically attached to any series added to the chart after this function has been called.
+             A series with no axes attached will by default scale to utilize the entire plot area of the chart, which can be confusing
+             if there are other series with properly attached axes also present.
-            \table
+             \table
                  \header
                      \o Series type
                      \o X-axis
                      \o QPieSeries
                      \o None
                      \o None
-                 \endtable
+             \endtable
-             If there are several QXYSeries derived series added to the chart and no other series type has been added then only one pair of axes is created.
+             If there are several QXYSeries derived series added to the chart and no series of other types have been added, then only one pair of axes is created.
-             If there are sevaral series added of different types then each series gets its own axes pair.
+             If there are several series of different types added to the chart, then each series gets its own axes pair.
-             NOTICE: if there is more than one x and y axes created then no axis is drawn by default and one needs to choose explicitly which axis should be shown.
+             The axes specific to the series can be later obtained from the chart by providing the series as the parameter for axes() function call.
-             Axis specifix to the series can be later obtained from the chart by providing the series as the parameter of axisX(), axisY() function calls.
              QPieSeries does not create any axes.
-             \sa axisX(), axisY(), setAxisX(), setAxisY()
+             \sa axisX(), axisY(), axes(), setAxisX(), setAxisY(), QAbstractSeries::attachAxis()
              */
             void QChart::createDefaultAxes()
             {
             }
             /*!
-             Returns the legend object of the chart. Ownership stays in chart.
+             Returns the legend object of the chart. Ownership stays with the chart.
              */
             QLegend *QChart::legend() const
             {
                 return d_ptr->m_legend;
             }
-            /*!
-              Sets the minimum \a margins between the plot area (axes) and the edge of the chart widget.
-              Deprecated. Use setMargins().
-            */
             void QChart::setMinimumMargins(const QMargins &margins)
             {
                 qWarning() << "QChart::setMinimumMargins is deprecated. Use QChart::setMargins instead.";
                 d_ptr->m_presenter->layout()->setMargins(margins);
             }
-            /*!
-                Returns the rect that contains information about margins (distance between chart widget edge and axes).
-                Individual margins can be obtained by calling left, top, right, bottom on the returned rect.
-                Deprecated. Use margins().
-             */
             QMargins QChart::minimumMargins() const
             {
                 qWarning() << "QChart::minimumMargins is deprecated. Use QChart::margins instead.";
                 return d_ptr->m_presenter->layout()->margins();
             }
-            /*!
-              Sets the minimum \a margins between the plot area (axes) and the edge of the chart widget.
-            */
             void QChart::setMargins(const QMargins &margins)
             {
                 d_ptr->m_presenter->layout()->setMargins(margins);
             }
-            /*!
-                Returns the rect that contains information about margins (distance between chart widget edge and axes).
-                Individual margins can be obtained by calling left, top, right, bottom on the returned rect.
-             */
             QMargins QChart::margins() const
             {
                 return d_ptr->m_presenter->layout()->margins();
             }
             /*!
-                Returns the the rect within which the drawing of the chart is done.
+                Returns the the rectangle within which the drawing of the chart is done.
-                It does not include the area defines by margins.
+                It does not include the area defined by margins.
              */
             QRectF QChart::plotArea() const
             {
                 return d_ptr->m_presenter->geometry();
             }
-            ///*!
-            //    TODO: Dummy.
-            //    Adjust the ranges of the axes so that all the data of the specified \a series is visible
-            // */
-            //void QChart::adjustViewToSeries(QAbstractSeries* series)
-            //{
-            //    //
-            //}
-            /*!
-             Sets animation \a options for the chart
-             */
             void QChart::setAnimationOptions(AnimationOptions options)
             {
                 d_ptr->m_presenter->setAnimationOptions(options);
             }
             /*!
-              Returns all the series that are added to the chart.
+              Returns all series that are added to the chart.
               \sa addSeries(), removeSeries(), removeAllSeries()
             */
             }
             /*!
-              Sets \a axis to the chart, which will control the presentation of the \a series
+              Adds the \a axis to the chart and attaches it to the \a series as a bottom-aligned horizontal axis.
+              The chart takes ownership of both the \a axis and the \a series.
+              Any horizontal axes previously attached to the \a series are deleted.
-               \sa axisX(), axisY(), setAxisY(), createDefaultAxes()
+              \sa axisX(), axisY(), setAxisY(), createDefaultAxes(), QAbstractSeries::attachAxis()
             */
-            void QChart::setAxisX(QAbstractAxis *axis , QAbstractSeries *series)
+            void QChart::setAxisX(QAbstractAxis *axis ,QAbstractSeries *series)
             {
-                QList<QAbstractAxis*> list = axes(Qt::Horizontal,series);
+                QList<QAbstractAxis*> list = axes(Qt::Horizontal, series);
-                foreach(QAbstractAxis* a, list){
+                foreach (QAbstractAxis* a, list) {
                     d_ptr->m_dataset->removeAxis(a);
                     delete a;
                 }
-                if(!d_ptr->m_dataset->axes().contains(axis))
+                if (!d_ptr->m_dataset->axes().contains(axis))
-                    d_ptr->m_dataset->addAxis(axis,Qt::AlignBottom);
+                    d_ptr->m_dataset->addAxis(axis, Qt::AlignBottom);
-                d_ptr->m_dataset->attachAxis(series,axis);
+                d_ptr->m_dataset->attachAxis(series, axis);
             }
             /*!
-              Sets \a axis to the chart, which will control the presentation of the \a series
+              Adds the \a axis to the chart and attaches it to the \a series as a left-aligned vertical axis.
+              The chart takes ownership of both the \a axis and the \a series.
+              Any vertical axes previously attached to the \a series are deleted.
-               \sa axisX(), axisY(), setAxisX(), createDefaultAxes()
+              \sa axisX(), axisY(), setAxisX(), createDefaultAxes(), QAbstractSeries::attachAxis()
             */
-            void QChart::setAxisY(QAbstractAxis *axis , QAbstractSeries *series)
+            void QChart::setAxisY(QAbstractAxis *axis ,QAbstractSeries *series)
             {
-                QList<QAbstractAxis*> list = axes(Qt::Vertical,series);
+                QList<QAbstractAxis*> list = axes(Qt::Vertical, series);
-                foreach(QAbstractAxis* a, list) {
+                foreach (QAbstractAxis* a, list) {
                     d_ptr->m_dataset->removeAxis(a);
                     delete a;
                 }
-                if(!d_ptr->m_dataset->axes().contains(axis))
+                if (!d_ptr->m_dataset->axes().contains(axis))
-                    d_ptr->m_dataset->addAxis(axis,Qt::AlignLeft);
+                    d_ptr->m_dataset->addAxis(axis, Qt::AlignLeft);
-                d_ptr->m_dataset->attachAxis(series,axis);
+                d_ptr->m_dataset->attachAxis(series, axis);
             }
             /*!
-              Adds \a axis to the chart with \a alignment. The chart takes the ownership of the axis.
+              Adds the \a axis to the chart with \a alignment. The chart takes the ownership of the axis.
               \sa removeAxis(), createDefaultAxes(), QAbstractSeries::attachAxis()
             */
             void QChart::addAxis(QAbstractAxis *axis, Qt::Alignment alignment)
             }
             /*!
-              Removes \a axis from the chart. The ownership is returned to the caller.
+              Removes the \a axis from the chart.
+              The chart releases its ownership of the specified \a axis object.
               \sa addAxis(), createDefaultAxes(), QAbstractSeries::detachAxis()
             */
             void QChart::removeAxis(QAbstractAxis *axis)
             }
             /*!
-              Returns the value in the \a series domain that corresponds to the charts widget point defines by \a position.
+              Returns the value in the \a series domain that corresponds to the \a position relative to chart widget.
             */
             QPointF QChart::mapToValue(const QPointF &position, QAbstractSeries *series)
             {
             }
             /*!
-              Returns the position on the charts widget that corresponds to the \a value in the \a series domain.
+              Returns the position on the chart widget that corresponds to the \a value in the \a series domain.
             */
             QPointF QChart::mapToPosition(const QPointF &value, QAbstractSeries *series)
             {
             QChartPrivate::~QChartPrivate()
             {
             }
             void QChartPrivate::init()

src/qchartview.cpp +20 -17

                 \brief Standalone charting widget.
                 QChartView is a standalone widget that can display charts. It does not require separate
-                QGraphicsScene to work. It manages the graphical representation of different types of
+                QGraphicsScene to work. If you want to display a chart in your existing QGraphicsScene,
-                series and other chart related objects like QAxis and QLegend. If you want to
+                you need to use the QChart (or QPolarChart) class instead.
-                display a chart in your existing QGraphicsScene, you can use the QChart class instead.
-                \sa QChart
+                \sa QChart, QPolarChart
             */
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             }
             /*!
-                Constructs a chartView object with parent \a parent to display a \a chart.
+                Constructs a chartview object with parent \a parent to display a \a chart.
+                Ownership of the \a chart is passed to chartview.
             */
             QChartView::QChartView(QChart *chart, QWidget *parent)
             /*!
-                Destroys the object and it's children, like series and axis objects added to it.
+                Destroys the chartview object and the associated chart.
             */
             QChartView::~QChartView()
             {
             }
             /*!
-                Returns the pointer to the associated chart
+                Returns the pointer to the associated chart.
             */
             QChart *QChartView::chart() const
             {
                 Sets the current chart to \a chart. Ownership of the new chart is passed to chartview
                 and ownership of the previous chart is released.
-                To avoid memory leaks users needs to make sure the previous chart is deleted.
+                To avoid memory leaks users need to make sure the previous chart is deleted.
             */
             void QChartView::setChart(QChart *chart)
             }
             /*!
-                Sets the RubberBandPlicy to \a rubberBand. Selected policy determines the way zooming is performed.
+                Sets the rubber band flags to \a rubberBand.
+                Selected flags determine the way zooming is performed.
+                \note Rubber band zooming is not supported for polar charts.
             */
             void QChartView::setRubberBand(const RubberBands &rubberBand)
             {
             }
             /*!
-                Returns the RubberBandPolicy that is currently being used by the widget.
+                Returns the rubber band flags that are currently being used by the widget.
             */
             QChartView::RubberBands QChartView::rubberBand() const
             {
             }
             /*!
-                If Left mouse button is pressed and the RubberBandPolicy is enabled the \a event is accepted and the rubber band is displayed on the screen allowing the user to select the zoom area.
+                If Left mouse button is pressed and the rubber band is enabled the \a event is accepted and the rubber band is displayed on the screen allowing the user to select the zoom area.
-                If different mouse button is pressed and/or the RubberBandPolicy is disabled then the \a event is passed to QGraphicsView::mousePressEvent() implementation.
+                If different mouse button is pressed and/or the rubber band is disabled then the \a event is passed to QGraphicsView::mousePressEvent() implementation.
             */
             void QChartView::mousePressEvent(QMouseEvent *event)
             {
             }
             /*!
-                If RubberBand rectange specification has been initiated in pressEvent then \a event data is used to update RubberBand geometry.
+                If the rubber band rectange has been displayed in pressEvent then \a event data is used to update the rubber band geometry.
-                In other case the defualt QGraphicsView::mouseMoveEvent implementation is called.
+                Otherwise the default QGraphicsView::mouseMoveEvent implementation is called.
             */
             void QChartView::mouseMoveEvent(QMouseEvent *event)
             {
             }
             /*!
-                If left mouse button is release and RubberBand is enabled then \a event is accepted and the view is zoomed in to rect specified by RubberBand
+                If left mouse button is released and the rubber band is enabled then \a event is accepted and
-                If it is the right mouse button \a event then RubberBand is dissmissed and zoom is canceled.
+                the view is zoomed into the rect specified by the rubber band.
+                If it is a right mouse button \a event then the rubber band is dismissed and the zoom is canceled.
             */
             void QChartView::mouseReleaseEvent(QMouseEvent *event)
             {
             QChartViewPrivate::~QChartViewPrivate()
             {
             }
             void QChartViewPrivate::setChart(QChart *chart)

src/qpolarchart.cpp +7 -4

             /*!
                 \enum QPolarChart::PolarOrientation
-               This type is used to signify the polar orientation of an axis.
+               This type is used to specify the polar orientation of an axis.
                 \value PolarOrientationRadial
                 \value PolarOrientationAngular
              \note If the angular distance between two consecutive points in a series is more than 180 degrees,
              any line connecting the two points becomes meaningless, so choose the axis ranges accordingly
-             when displaying line, spline, or area series.
+             when displaying line, spline, or area series. In such case series don't draw a direct line between
+             the two points, but instead draw a line to and from the center of the chart.
              \note Polar charts do not support multiple axes of same orientation.
              */
             /*!
-             Constructs a polar chart as a child of a \a parent.
+             Constructs a polar chart as a child of the \a parent.
              Parameter \a wFlags is passed to the QChart constructor.
              */
             QPolarChart::QPolarChart(QGraphicsItem *parent, Qt::WindowFlags wFlags)
             }
             /*!
-             Destroys the object and it's children, like series and axis objects added to it.
+             Destroys the polar chart object and its children, like series and axis objects added to it.
              */
             QPolarChart::~QPolarChart()
             {
             /*!
              Returns the axes added for the \a series with \a polarOrientation. If no series is provided, then any axis with the
              specified polar orientation is returned.
              \sa addAxis()
              */
             QList<QAbstractAxis *> QPolarChart::axes(PolarOrientations polarOrientation, QAbstractSeries *series) const
               \note Axes can be added to a polar chart also with QChart::addAxis() instead of this method.
               The specified alignment determines the polar orientation: horizontal alignments indicate angular
               axis and vertical alignments indicate radial axis.
               \sa QChart::removeAxis(), QChart::createDefaultAxes(), QAbstractSeries::attachAxis(), QChart::addAxis()
             */
             void QPolarChart::addAxis(QAbstractAxis *axis, PolarOrientation polarOrientation)

src/splinechart/qsplineseries.cpp +1 -1

             /*!
                 Constructs empty series object which is a child of \a parent.
-                When series object is added to QChartView or QChart instance then the ownerships is transferred.
+                When series object is added to a QChart instance then the ownerships is transferred.
               */
             QSplineSeries::QSplineSeries(QObject *parent)

src/xychart/qxyseries.cpp +12 -13

             /*!
                 \fn void QXYSeries::pointsReplaced()
-                Signal is emitted when all points have been replaced with another points.
+                Signal is emitted when all points have been replaced with other points.
                 \sa replace()
             */
             /*!
                 \internal
                 Constructs empty series object which is a child of \a parent.
-                When series object is added to QChartView or QChart instance ownerships is transferred.
+                When series object is added to QChart instance ownerships is transferred.
             */
             QXYSeries::QXYSeries(QXYSeriesPrivate &d, QObject *parent)
                 : QAbstractSeries(d, parent)
             }
             /*!
-                Destroys the object. Series added to QChartView or QChart instances are owned by those,
+                Destroys the object. Series added to QChart instances are owned by those,
-                and are deleted when mentioned object are destroyed.
+                and are destroyed when QChart instances are destroyed.
             */
             QXYSeries::~QXYSeries()
             {
             }
             /*!
-                Adds data point \a x \a y to the series. Points are connected with lines on the chart.
+                Adds data point (\a x, \a y) to the series.
              */
             void QXYSeries::append(qreal x, qreal y)
             {
             /*!
                This is an overloaded function.
-               Adds data \a point to the series. Points are connected with lines on the chart.
+               Adds data \a point to the series.
              */
             void QXYSeries::append(const QPointF &point)
             {
             /*!
                This is an overloaded function.
-               Adds list of data \a points to the series. Points are connected with lines on the chart.
+               Adds list of data \a points to the series.
              */
             void QXYSeries::append(const QList<QPointF> &points)
             {
             }
             /*!
-              Replaces data point \a oldX \a oldY with data point \a newX \a newY.
+              Replaces data point (\a oldX, \a oldY) with data point (\a newX, \a newY).
               \sa QXYSeries::pointReplaced()
             */
             void QXYSeries::replace(qreal oldX, qreal oldY, qreal newX, qreal newY)
             }
             /*!
-              Replaces the current points with \a points. This is faster than replacing data points one by one,
+              Replaces the current points with \a points.
+              \note This is much faster than replacing data points one by one,
               or first clearing all data, and then appending the new data. Emits QXYSeries::pointsReplaced()
               when the points have been replaced.
               \sa QXYSeries::pointsReplaced()
             }
             /*!
-              Removes current \a x and \a y value.
+              Removes the point (\a x, \a y) from the series.
             */
             void QXYSeries::remove(qreal x, qreal y)
             {
             }
             /*!
-              Removes current \a point x value.
+              Removes the \a point from the series.
-              Note: point y value is ignored.
             */
             void QXYSeries::remove(const QPointF &point)
             {

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