HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r924:fc9ac5c5cb54

Some more doc fixes and additions

Marek Rosa -

r924:fc9ac5c5cb54

parent child

Context file:

r924:fc9ac5c5cb54

Collapse all files

src/linechart/qlineseries.cpp 0 -6

             */
             /*!
-               \fn QPen QLineSeries::linePen() const
-               \brief  Returns the pen used to draw line connecting points.
-                \sa setPen()
-            */
-            /*!
                 Constructs empty series object which is a child of \a parent.
                 When series object is added to QChartView or QChart instance ownerships is transfered.
             */

src/piechart/qpieseries.cpp +10 -2

             */
             /*!
+                \property qreal QPieSeries::horizontalPosition
+                \brief Pie horizontal postion property
+                By default horizontal postion is 0
+            */
+            /*!
                 Constructs a series object which is a child of \a parent.
             */
             QPieSeries::QPieSeries(QObject *parent) :
             }
             /*!
-                Sets the horizontal center position of the pie to \relativePosition. If \relativePosition is
+                Sets the horizontal center position of the pie to \a relativePosition. If \a relativePosition is
                 set to  0.0 the pie is drawn on the left side of the chart and if it's set to 1.0 the pie is
                 drawn on right side of the chart. The default value 0.5 puts the pie in the middle.
             }
             /*!
-                Sets the vertical center position of the pie to \relativePosition. If \relativePosition is
+                Sets the vertical center position of the pie to \a relativePosition. If \a relativePosition is
                 set to  0.0 the pie is drawn on the top of the chart and if it's set to 1.0 the pie is drawn
                 on bottom of the chart. The default value 0.5 puts the pie in the middle.

src/piechart/qpieslice.cpp +1 0

                 \fn void QPieSlice::clicked(Qt::MouseButtons buttons)
                 This signal is emitted when user has clicked the slice.
+                Parameter \a buttons hold the information about the clicked mouse buttons.
                 \sa QPieSeries::clicked()
             */

src/qchart.cpp +34 -2

                 d_ptr->m_presenter->m_backgroundItem->update();
             }
+            /*!
+                Gets the brush that is used for painting the background of the chart area.
+             */
             QBrush QChart::backgroundBrush() const
             {
                 //TODO: refactor me
                 d_ptr->m_presenter->m_backgroundItem->update();
             }
+            /*!
+                Gets the pen that is used for painting the background of the chart area.
+             */
             QPen QChart::backgroundPen() const
             {
                 //TODO: refactor me
             }
             /*!
-             Sets the \a font that is used for rendering the description text that is rendered above the chart.
+             Sets the \a font that is used for drawing the chart description text that is rendered above the chart.
              */
             void QChart::setTitleFont(const QFont& font)
             {
                 d_ptr->m_presenter->updateLayout();
             }
+            /*!
+                Gets the font that is used for drawing the chart description text that is rendered above the chart.
+             */
             QFont QChart::titleFont() const
             {
                 if (d_ptr->m_presenter->m_titleItem)
             }
             /*!
-             Returns the pointer to the y axis object of the chart
+             Returns the pointer to the y axis object of the \a series
+             If no \a series is provided then default Y axis of the chart is returned.
              */
             QChartAxis* QChart::axisY(QSeries* series) const
             {
                 return d_ptr->m_legend;
             }
+            /*!
+                Returns the rect that contains information about margins (distance between chart widget edge and axes).
+                Individual margins can be obtained by calling left, top, right, bottom on the returned rect.
+             */
             QRectF QChart::margins() const
             {
                 return d_ptr->m_presenter->margins();
                 return d_ptr->m_presenter->animationOptions();
             }
+            /*!
+                Scrolls the visible area of the chart to the left by the distance between two x axis ticks
+             */
             void QChart::scrollLeft()
             {
                 d_ptr->m_presenter->scroll(-d_ptr->m_presenter->chartGeometry().width()/(axisX()->ticksCount()-1),0);
             }
+            /*!
+                Scrolls the visible area of the chart to the right by the distance between two x axis ticks
+             */
             void QChart::scrollRight()
             {
                 d_ptr->m_presenter->scroll(d_ptr->m_presenter->chartGeometry().width()/(axisX()->ticksCount()-1),0);
             }
+            /*!
+                Scrolls the visible area of the chart up by the distance between two y axis ticks
+             */
             void QChart::scrollUp()
             {
                 d_ptr->m_presenter->scroll(0,d_ptr->m_presenter->chartGeometry().width()/(axisY()->ticksCount()-1));
             }
+            /*!
+                Scrolls the visible area of the chart down by the distance between two y axis ticks
+             */
             void QChart::scrollDown()
             {
                 d_ptr->m_presenter->scroll(0,-d_ptr->m_presenter->chartGeometry().width()/(axisY()->ticksCount()-1));
             }
+            /*!
+                Sets the chart background visibility state to \a visible
+             */
             void QChart::setBackgroundVisible(bool visible)
             {
                 //TODO: refactor me
                 d_ptr->m_presenter->m_backgroundItem->setVisible(visible);
             }
+            /*!
+                Returns the chart's background visibility state
+             */
             bool QChart::isBackgroundVisible() const
             {
                 //TODO: refactor me

src/qseries.cpp +5 0

             */
             /*!
+                \fn QAbstractItemModel* QSeries::model() const
+                \brief Returns the pointer to the model that is used as the series data source
+            */
+            /*!
                 \property QString QSeries::name
                 \brief name of the series property
             */

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