Improve the documentation of Chart Themes Example

Added more detailed documentation and code snippets to Chart Themes
Example.

Change-Id: I206b65038b369d0eaa5fb128b872328ec43de7a2
Task-number: QTBUG-60662
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

1 files changed, 24 insertions, 2 deletions

diff --git a/examples/charts/chartthemes/themewidget.cpp b/examples/charts/chartthemes/themewidget.cpp
index 47a6ea63..ed49ce9b 100644
--- a/examples/charts/chartthemes/themewidget.cpp
+++ b/examples/charts/chartthemes/themewidget.cpp
@@ -82,8 +82,10 @@ ThemeWidget::ThemeWidget(QWidget *parent) :
     m_ui->gridLayout->addWidget(chartView, 1, 1);
     m_charts << chartView;
 
+    //![5]
     chartView = new QChartView(createLineChart());
     m_ui->gridLayout->addWidget(chartView, 1, 2);
+    //![5]
     m_charts << chartView;
 
     chartView = new QChartView(createBarChart(m_valueCount));
@@ -229,9 +231,12 @@ QChart *ThemeWidget::createBarChart(int valueCount) const
 
 QChart *ThemeWidget::createLineChart() const
 {
+    //![1]
     QChart *chart = new QChart();
     chart->setTitle("Line chart");
+    //![1]
 
+    //![2]
     QString name("Series ");
     int nameIndex = 0;
     for (const DataList &list : m_dataTable) {
@@ -242,12 +247,17 @@ QChart *ThemeWidget::createLineChart() const
         nameIndex++;
         chart->addSeries(series);
     }
+    //![2]
 
+    //![3]
     chart->createDefaultAxes();
     chart->axisX()->setRange(0, m_valueMax);
     chart->axisY()->setRange(0, m_valueCount);
+    //![3]
+    //![4]
     // Add space to label to add space between labels and axis
     static_cast<QValueAxis *>(chart->axisY())->setLabelFormat("%.1f  ");
+    //![4]
 
     return chart;
 }
@@ -324,19 +334,25 @@ QChart *ThemeWidget::createScatterChart() const
 
 void ThemeWidget::updateUI()
 {
+    //![6]
     QChart::ChartTheme theme = static_cast<QChart::ChartTheme>(
                 m_ui->themeComboBox->itemData(m_ui->themeComboBox->currentIndex()).toInt());
-
+    //![6]
     const auto charts = m_charts;
     if (!m_charts.isEmpty() && m_charts.at(0)->chart()->theme() != theme) {
-        for (QChartView *chartView : charts)
+        for (QChartView *chartView : charts) {
+            //![7]
             chartView->chart()->setTheme(theme);
+            //![7]
+        }
 
         // Set palette colors based on selected theme
+        //![8]
         QPalette pal = window()->palette();
         if (theme == QChart::ChartThemeLight) {
             pal.setColor(QPalette::Window, QRgb(0xf0f0f0));
             pal.setColor(QPalette::WindowText, QRgb(0x404044));
+        //![8]
         } else if (theme == QChart::ChartThemeDark) {
             pal.setColor(QPalette::Window, QRgb(0x121218));
             pal.setColor(QPalette::WindowText, QRgb(0xd6d6d6));
@@ -363,19 +379,24 @@ void ThemeWidget::updateUI()
     }
 
     // Update antialiasing
+    //![11]
     bool checked = m_ui->antialiasCheckBox->isChecked();
     for (QChartView *chart : charts)
         chart->setRenderHint(QPainter::Antialiasing, checked);
+    //![11]
 
     // Update animation options
+    //![9]
     QChart::AnimationOptions options(
                 m_ui->animatedComboBox->itemData(m_ui->animatedComboBox->currentIndex()).toInt());
     if (!m_charts.isEmpty() && m_charts.at(0)->chart()->animationOptions() != options) {
         for (QChartView *chartView : charts)
             chartView->chart()->setAnimationOptions(options);
     }
+    //![9]
 
     // Update legend alignment
+    //![10]
     Qt::Alignment alignment(
                 m_ui->legendComboBox->itemData(m_ui->legendComboBox->currentIndex()).toInt());
 
@@ -388,5 +409,6 @@ void ThemeWidget::updateUI()
             chartView->chart()->legend()->show();
         }
     }
+    //![10]
 }