HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r277:704deaf5754b

Added some more documentation to QChart and QChartView

Marek Rosa -

r277:704deaf5754b

parent child

Context file:

r277:704deaf5754b

Collapse all files

src/qchart.cpp +39 -5

             #include <QGraphicsSceneResizeEvent>
             #include <QDebug>
+            QTCOMMERCIALCHART_BEGIN_NAMESPACE
+            /*!
+                \enum QChart::ChartTheme
+                This enum describes the theme used by the chart.
+                \value ChartThemeDefault
+                \value ChartThemeVanilla
+                \value ChartThemeIcy
+                \value ChartThemeGrayscale
+                \value ChartThemeScientific
+            */
             /*!
                 \class QChart
                 \brief QtCommercial chart API.
                 \sa QChartView
             */
-            QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 Constructs a chart object which is a child of parent.
             */
             }
             /*!
-                Adds the series and optional y axis onto the chart and takes the ownership of the objects.
+                Adds the \a series and optional y axis onto the chart and takes the ownership of the objects.
                 If auto scaling is enabled, re-scales the axes the series is bound to (both the x axis and
                 the y axis).
             */
             }
             /*!
-                Sets the title description text that is rendered above the chart.
+                Sets the chart \a title. The description text that is rendered above the chart.
             */
             void QChart::setChartTitle(const QString& title)
             {
             }
             /*!
-                Sets the font that is used for rendering the description text that is rendered above the chart.
+                Sets the \a font that is used for rendering the description text that is rendered above the chart.
             */
             void QChart::setChartTitleFont(const QFont& font)
             {
                 }
             }
+            /*!
+                Returns the chart margin, which is the distance between the widget edge and the part of the chart where the actual data can be displayed.
+                \sa setMargin()
+            */
             int QChart::margin() const
             {
                 return m_presenter->margin();
             }
+            /*!
+                Sets the chart \a margin, which is the distance between the widget edge and the part of the chart where the actual data can be displayed.
+                \sa margin()
+            */
             void QChart::setMargin(int margin)
             {
                 m_presenter->setMargin(margin);
             }
+            /*!
+                Sets the \a theme used by the chart for rendering data graphical representation
+                \sa ChartTheme, chartTheme()
+            */
             void QChart::setChartTheme(QChart::ChartTheme theme)
             {
                 m_presenter->setChartTheme(theme);
             }
+            /*!
+                Returns the theme enum used by the chart.
+                \sa ChartTheme, setChartTheme()
+            */
             QChart::ChartTheme QChart::chartTheme() const
             {
                 return m_presenter->chartTheme();
                 m_dataset->clearDomains();
             }
+            /*!
+                Returns the pointer to the x axis object of the chart
+            */
             QChartAxis* QChart::axisX() const
             {
                 return m_dataset->axisX();
             }
+            /*!
+                Returns the pointer to the y axis object of the chart
+            */
             QChartAxis* QChart::axisY() const
             {
                 return m_dataset->axisY();

src/qchartview.cpp +22 -3

                 setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
             }
+            /*!
+                Destroys the object and it's children, like QChartSeries and QChartAxis object added to it.
+            */
             QChartView::~QChartView()
             {
             }
             }
             /*!
-                Returns the chart margin, which is the distance between the widget edge and the axis lines or the chart.
+                Returns the chart margin, which is the distance between the widget edge and the part of the chart where the actual data can be displayed.
             */
             int QChartView::margin() const
             {
             }
             /*!
-                Sets the title description text that is rendered above the chart.
+                Sets the chart \a tile. A description text that is rendered above the chart.
             */
             void QChartView::setChartTitle(const QString& title)
             {
             }
             /*!
-                Sets the font that is used for rendering the description text that is rendered above the chart.
+                Sets the \a font that is used for rendering the description text that is rendered above the chart.
             */
             void QChartView::setChartTitleFont(const QFont& font)
             {
                 m_chart->setChartTitleFont(font);
             }
+            /*!
+                Sets the \a brush that is used for painting the background of the chart area of the QChartView widget.
+            */
             void QChartView::setChartBackgroundBrush(const QBrush& brush)
             {
                 m_chart->setChartBackgroundBrush(brush);
             }
+            /*!
+                Sets the \a pen that is used for painting the background of the chart area of the QChartView widget.
+            */
             void QChartView::setChartBackgroundPen(const QPen& pen)
             {
                 m_chart->setChartBackgroundPen(pen);
                 }
             }
+            /*!
+                Sets the \a theme used by the chart for rendering the graphical representation of the data
+                \sa QChart::ChartTheme, chartTheme()
+            */
             void QChartView::setChartTheme(QChart::ChartTheme theme)
             {
                 m_chart->setChartTheme(theme);
             }
+            /*!
+                Returns the theme enum used by the chart.
+                \sa setChartTheme()
+            */
             QChart::ChartTheme QChartView::chartTheme() const
             {
                 return m_chart->chartTheme();

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