HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1638:039a92a11dcb

Various docs fixes

Marek Rosa -

r1638:039a92a11dcb

parent child

Context file:

r1638:039a92a11dcb

Collapse all files

src/axis/qbarcategoriesaxis.cpp +6 0

             {
             }
+            /*!
+                Destroys the object
+            */
             QBarCategoriesAxis::~QBarCategoriesAxis()
             {
             }
+            /*!
+                \internal
+            */
             QBarCategoriesAxis::QBarCategoriesAxis(QBarCategoriesAxisPrivate &d,QObject *parent):QAbstractAxis(d,parent)
             {

src/axis/qintervalaxis.cpp +6 0

             {
             }
+            /*!
+                Destroys the object
+            */
             QIntervalAxis::~QIntervalAxis()
             {
             }
+            /*!
+                \internal
+            */
             QIntervalAxis::QIntervalAxis(QIntervalAxisPrivate &d,QObject *parent):QValuesAxis(d,parent)
             {

src/axis/qvaluesaxis.cpp +6 0

             }
+            /*!
+                \internal
+            */
             QValuesAxis::QValuesAxis(QValuesAxisPrivate &d,QObject *parent) : QAbstractAxis(d,parent)
             {
             }
+            /*!
+                Destroys the object
+            */
             QValuesAxis::~QValuesAxis()
             {

src/barchart/qabstractbarseries.h +1 -1

             public:
                 virtual ~QAbstractBarSeries();
-                virtual QAbstractSeries::SeriesType type() const = 0;
+            //    virtual QAbstractSeries::SeriesType type() const = 0;
                 void setBarWidth(qreal width);
                 qreal barWidth() const;

src/qabstractseries.cpp +10 0

                 //TODO:
             }
+            /*!
+                \brief Sets the visibility of the series to true
+                \sa setVisible(), isVisible()
+            */
             void QAbstractSeries::show()
             {
                 setVisible(true);
             }
+            /*!
+                \brief Sets the visibility of the series to false
+                \sa setVisible(), isVisible()
+            */
             void QAbstractSeries::hide()
             {
                 setVisible(false);

src/qchart.cpp +22 -2

             /*!
              Returns the pointer to the x axis object of the chart asociated with the specified \a series
+             If no series is provided then pointer to currently visible axis is provided
              */
             QAbstractAxis* QChart::axisX(QAbstractSeries* series) const
             {
             /*!
              Returns the pointer to the y axis object of the chart asociated with the specified \a series
+             If no series is provided then pointer to currently visible axis is provided
              */
             QAbstractAxis* QChart::axisY(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 the axes for the chart based on the series that has already been added to the chart.
-             If QXYSeries derived series has been added to the chart then QValuesAxes are created as X and Y axes for the series.
-             If QBarSeries or series types derived from it has been added then QBarCategoriesAxis is created as X axis and QValueAxis as Y axis.
+            \table
+                 \header
+                     \o Series type
+                     \o X-axis
+                     \o Y-axis
+                 \row
+                     \o QXYSeries
+                     \o QValuesAxis
+                     \o QValuesAxis
+                 \row
+                     \o QBarSeries
+                     \o QBarCategoriesAxis
+                     \o QValuesAxis
+                 \row
+                     \o QPieSeries
+                     \o None
+                     \o None
+                 \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 sevaral series added of different types then each series gets its own axes pair.

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