diff --git a/doc/qchart-html-template.qdocconf b/doc/qchart-html-template.qdocconf index 3a853da..e413dcb 100644 --- a/doc/qchart-html-template.qdocconf +++ b/doc/qchart-html-template.qdocconf @@ -13,6 +13,7 @@ HTML.postheader = \ "
  • About
  • \n" \ "
  • Getting started
  • \n" \ "
  • API Classes
  • \n" \ + "
  • QML API
  • \n" \ "
  • Examples
  • \n" \ "
  • Demos
  • \n" \ " \n" diff --git a/doc/qcharts.qdocconf b/doc/qcharts.qdocconf index 7d05155..a65f7a0 100644 --- a/doc/qcharts.qdocconf +++ b/doc/qcharts.qdocconf @@ -7,9 +7,11 @@ description = Library for creating charts sourcedirs = ../src \ ../examples \ - ./src + ./src \ + ../plugins/declarative headerdirs = ../src \ - ../examples + ../examples \ + ../plugins/declarative exampledirs = ../ \ ../src \ ../examples @@ -43,4 +45,4 @@ Cpp.ignoredirectives = Q_DECLARE_HANDLE \ Q_ENUMS \ Q_FLAGS \ Q_INTERFACES \ - __attribute__ \ No newline at end of file + __attribute__ diff --git a/doc/src/qml.qdoc b/doc/src/qml.qdoc new file mode 100644 index 0000000..15c4505 --- /dev/null +++ b/doc/src/qml.qdoc @@ -0,0 +1,14 @@ +/*! + \page qml.html + \title QtCommercial Charts QML API + \keyword Charts QML API + + Charts QML API is an intuitive and simple way to use QtCommercial Charts in your QML applications. + + \raw HTML + + \endraw +*/ diff --git a/plugins/declarative/declarativechart.cpp b/plugins/declarative/declarativechart.cpp index 2619677..b6d49cc 100644 --- a/plugins/declarative/declarativechart.cpp +++ b/plugins/declarative/declarativechart.cpp @@ -29,6 +29,19 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE +/*! + \qmlclass ChartView DeclarativeChart + + ChartView element is the parent that is responsible for showing different chart series types. + + \section1 Example Usage + + \beginfloatleft + \image demos_qmlchart1.png + \endfloat + \clearfloat +*/ + DeclarativeChart::DeclarativeChart(QDeclarativeItem *parent) : QDeclarativeItem(parent), m_chart(new QChart(this)) diff --git a/plugins/declarative/declarativepieseries.cpp b/plugins/declarative/declarativepieseries.cpp index 6d47259..2e74241 100644 --- a/plugins/declarative/declarativepieseries.cpp +++ b/plugins/declarative/declarativepieseries.cpp @@ -27,6 +27,53 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE +/*! + \qmlclass PieSeries DeclarativePieSeries + + \section1 Example Usage + + \beginfloatleft + \image demos_qmlchart1.png + \endfloat + \clearfloat + + The following QML shows how to create a simple pie chart. + + \snippet ../demos/qmlchart/qml/qmlchart/View1.qml 1 +*/ + +/*! + \qmlproperty real PieSeries::horizontalPosition + \brief Defines the horizontal position of the pie. + + The value is a relative value to the chart rectangle where: + + \list + \o 0.0 is the absolute left. + \o 1.0 is the absolute right. + \endlist + + Default value is 0.5 (center). + + \sa verticalPosition +*/ + +/*! + \qmlproperty real PieSeries::verticalPosition + \brief Defines the vertical position of the pie. + + The value is a relative value to the chart rectangle where: + + \list + \o 0.0 is the absolute top. + \o 1.0 is the absolute bottom. + \endlist + + Default value is 0.5 (center). + + \sa horizontalPosition +*/ + DeclarativePieSeries::DeclarativePieSeries(QObject *parent) : QPieSeries(parent) {