diff options
author | Titta Heikkala <titta.heikkala@theqtcompany.com> | 2014-10-27 13:13:18 +0200 |
---|---|---|
committer | Titta Heikkala <titta.heikkala@theqtcompany.com> | 2014-10-28 12:01:42 +0200 |
commit | d7bc4e870cddd45899d5e8cea4e4eca59a3261aa (patch) | |
tree | 7d7d4b345591b3ba5313191ad5873062bbc389fc | |
parent | 17ddbeb778159d96113a51079b603665a0f1058d (diff) |
Add missing QML types to the documentation
The QML types documented in chartsqml2 project are added to the
documentation.
Change-Id: I3780566aad820e73d2ff17be1f9fe7dda9aa3a69
Task-number: QTRD-3228
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@theqtcompany.com>
-rw-r--r-- | src/charts/doc/qtcharts.qdocconf | 8 | ||||
-rw-r--r-- | src/chartsqml2/declarativeboxplotseries.cpp | 4 | ||||
-rw-r--r-- | src/chartsqml2/declarativechart.cpp | 2 | ||||
-rw-r--r-- | src/chartsqml2/declarativemargins.cpp | 2 | ||||
-rw-r--r-- | src/chartsqml2/declarativepolarchart.cpp | 2 | ||||
-rw-r--r-- | src/chartsqml2/declarativexypoint.cpp | 2 |
6 files changed, 18 insertions, 2 deletions
diff --git a/src/charts/doc/qtcharts.qdocconf b/src/charts/doc/qtcharts.qdocconf index 929653e0..ae1bab62 100644 --- a/src/charts/doc/qtcharts.qdocconf +++ b/src/charts/doc/qtcharts.qdocconf @@ -8,13 +8,17 @@ project = Qt Charts description = Qt Charts Reference Documentation version = 2.0.0 -sourcedirs += .. -headerdirs += .. +sourcedirs += .. \ + ../../chartsqml2 +headerdirs += .. \ + ../../chartsqml2 exampledirs += ../../../examples/charts \ snippets imagedirs += images examplesinstallpath = charts +sources.fileextensions = "*.cpp *.qdoc" + indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \ $QT_INSTALL_DOCS/qtgui/qtgui.index \ $QT_INSTALL_DOCS/qtqml/qtqml.index \ diff --git a/src/chartsqml2/declarativeboxplotseries.cpp b/src/chartsqml2/declarativeboxplotseries.cpp index 885012a3..f3bd598b 100644 --- a/src/chartsqml2/declarativeboxplotseries.cpp +++ b/src/chartsqml2/declarativeboxplotseries.cpp @@ -30,6 +30,8 @@ QT_CHARTS_BEGIN_NAMESPACE \instantiates QBoxSet \inqmlmodule QtCharts + \brief Building block for box-and-whiskers chart. + BoxSet represents one box-and-whiskers item. It takes five values to create a graphical representation of range and three medians. There are two ways to give the values. The first one is with constructor or with append method. In these the values have to be given in the following @@ -103,6 +105,8 @@ QT_CHARTS_BEGIN_NAMESPACE \inherits AbstractSeries + \brief Series for creating box-and-whiskers chart. + BoxPlotSeries represents a series of data shown as box-and-whiskers bars. The purpose of this class is to act as a container for single box-and-whiskers items. Each item is drawn to own slot. If chart includes multiple instances of BoxPlotSeries then box-and-whiskers items with the diff --git a/src/chartsqml2/declarativechart.cpp b/src/chartsqml2/declarativechart.cpp index 58d25295..dd69adc5 100644 --- a/src/chartsqml2/declarativechart.cpp +++ b/src/chartsqml2/declarativechart.cpp @@ -55,6 +55,8 @@ QT_CHARTS_BEGIN_NAMESPACE \instantiates DeclarativeChart \inqmlmodule QtCharts + \brief Chart element. + ChartView element is the parent that is responsible for showing different chart series types. The following QML shows how to create a simple chart with one pie series: diff --git a/src/chartsqml2/declarativemargins.cpp b/src/chartsqml2/declarativemargins.cpp index 78f1d6df..6da2c6eb 100644 --- a/src/chartsqml2/declarativemargins.cpp +++ b/src/chartsqml2/declarativemargins.cpp @@ -28,6 +28,8 @@ QT_CHARTS_BEGIN_NAMESPACE \qmltype Margins \inqmlmodule QtCharts + \brief Type is used to define margins. + Uncreatable type that is used to define top, bottom, left and right margins. */ diff --git a/src/chartsqml2/declarativepolarchart.cpp b/src/chartsqml2/declarativepolarchart.cpp index 5d68d492..06c5cc23 100644 --- a/src/chartsqml2/declarativepolarchart.cpp +++ b/src/chartsqml2/declarativepolarchart.cpp @@ -28,6 +28,8 @@ QT_CHARTS_BEGIN_NAMESPACE \instantiates DeclarativePolarChart \inqmlmodule QtCharts + \brief Polar chart element. + PolarChartView element is the parent that is responsible for showing different chart series types in a polar chart. diff --git a/src/chartsqml2/declarativexypoint.cpp b/src/chartsqml2/declarativexypoint.cpp index 3dd78d49..0e50b6a7 100644 --- a/src/chartsqml2/declarativexypoint.cpp +++ b/src/chartsqml2/declarativexypoint.cpp @@ -27,6 +27,8 @@ QT_CHARTS_BEGIN_NAMESPACE \qmltype XYPoint \inqmlmodule QtCharts + \brief Type is used to initialize XY-series coordinate data. + XYPoint is a convenience element for initializing XY-series with static coordinate data. To manipulate an XY-series dynamically, use it's data manipulation functions instead. \sa LineSeries, AreaSeries, ScatterSeries, SplineSeries |