From 489025182745282d4e44d0f8bf2c292a72a35b50 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Fri, 24 Feb 2017 10:40:07 +0100 Subject: Doc: Fix \brief and \return commands (Q3dScatter) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I45c048acffc57b56205b694dd4fcb4b89917b5a3 Reviewed-by: Tomi Korpipää --- .../doc/src/qtdatavisualization-qml-scatter3d.qdoc | 32 ++++++++------- src/datavisualization/engine/q3dscatter.cpp | 47 ++++++++++++++-------- 2 files changed, 49 insertions(+), 30 deletions(-) (limited to 'src/datavisualization') diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc index 10487420..50e8df83 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc @@ -52,34 +52,37 @@ /*! \qmlproperty ValueAxis3D Scatter3D::axisX - The active X axis. + The active x-axis. - If an axis is not given, a temporary default axis with no labels and automatically adjusting - range is created. - This temporary axis is destroyed if another axis is explicitly set to same orientation. + If an axis is not given, a temporary default axis with no labels and an + automatically adjusting range is created. + This temporary axis is destroyed if another axis is explicitly set to the same + orientation. */ /*! \qmlproperty ValueAxis3D Scatter3D::axisY - The active Y axis. + The active y-axis. - If an axis is not given, a temporary default axis with no labels and automatically adjusting - range is created. - This temporary axis is destroyed if another axis is explicitly set to same orientation. + If an axis is not given, a temporary default axis with no labels and an + automatically adjusting range is created. + This temporary axis is destroyed if another axis is explicitly set to the same + orientation. */ /*! \qmlproperty ValueAxis3D Scatter3D::axisZ - The active Z axis. + The active z-axis. - If an axis is not given, a temporary default axis with no labels and automatically adjusting - range is created. - This temporary axis is destroyed if another axis is explicitly set to same orientation. + If an axis is not given, a temporary default axis with no labels and an + automatically adjusting range is created. + This temporary axis is destroyed if another axis is explicitly set to the same + orientation. */ /*! * \qmlproperty Scatter3DSeries Scatter3D::selectedSeries - * The selected series or \c null. + * The selected series or null. */ /*! @@ -87,7 +90,8 @@ * \default * This property holds the series of the graph. * By default, this property contains an empty list. - * To set the series, either use the addSeries() function or define them as children of the graph. + * To set the series, either use the addSeries() method or define them as + * children of the graph. */ /*! diff --git a/src/datavisualization/engine/q3dscatter.cpp b/src/datavisualization/engine/q3dscatter.cpp index 26325b33..b16b2513 100644 --- a/src/datavisualization/engine/q3dscatter.cpp +++ b/src/datavisualization/engine/q3dscatter.cpp @@ -125,7 +125,7 @@ void Q3DScatter::removeSeries(QScatter3DSeries *series) } /*! - * \return list of series added to this graph. + * Returns the list of series added to this graph. */ QList Q3DScatter::seriesList() const { @@ -145,12 +145,17 @@ const Q3DScatterPrivate *Q3DScatter::dptrc() const /*! * \property Q3DScatter::axisX * - * The active X-axis. Implicitly calls addAxis() to transfer ownership - * of the \a axis to this graph. + * \brief The active x-axis. + */ + +/*! + * Sets \a axis as the active x-axis. Implicitly calls addAxis() to transfer the + * ownership of the axis to this graph. * - * If the \a axis is null, a temporary default axis with no labels and automatically adjusting + * If \a axis is null, a temporary default axis with no labels and an automatically adjusting * range is created. - * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation. + * This temporary axis is destroyed if another axis is set explicitly to the + * same orientation. * * \sa addAxis(), releaseAxis() */ @@ -167,12 +172,17 @@ QValue3DAxis *Q3DScatter::axisX() const /*! * \property Q3DScatter::axisY * - * The active Y-axis. Implicitly calls addAxis() to transfer ownership - * of the \a axis to this graph. + * \brief The active y-axis. + */ + +/*! + * Sets \a axis as the active y-axis. Implicitly calls addAxis() to transfer the + * ownership of the axis to this graph. * - * If the \a axis is null, a temporary default axis with no labels and automatically adjusting + * If \a axis is null, a temporary default axis with no labels and an automatically adjusting * range is created. - * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation. + * This temporary axis is destroyed if another axis is set explicitly to the + * same orientation. * * \sa addAxis(), releaseAxis() */ @@ -189,12 +199,17 @@ QValue3DAxis *Q3DScatter::axisY() const /*! * \property Q3DScatter::axisZ * - * The active Z-axis. Implicitly calls addAxis() to transfer ownership - * of the \a axis to this graph. + * \brief The active z-axis. + */ + +/*! + * Sets \a axis as the active z-axis. Implicitly calls addAxis() to transfer the + * ownership of the axis to this graph. * - * If the \a axis is null, a temporary default axis with no labels and automatically adjusting + * If \a axis is null, a temporary default axis with no labels and an automatically adjusting * range is created. - * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation. + * This temporary axis is destroyed if another axis is set explicitly to the + * same orientation. * * \sa addAxis(), releaseAxis() */ @@ -204,7 +219,7 @@ void Q3DScatter::setAxisZ(QValue3DAxis *axis) } /*! - * \return used Z-axis. + * Returns the used z-axis. */ QValue3DAxis *Q3DScatter::axisZ() const { @@ -214,7 +229,7 @@ QValue3DAxis *Q3DScatter::axisZ() const /*! * \property Q3DScatter::selectedSeries * - * The selected series or \c null. + * \brief The selected series or null. */ QScatter3DSeries *Q3DScatter::selectedSeries() const { @@ -247,7 +262,7 @@ void Q3DScatter::releaseAxis(QValue3DAxis *axis) } /*! - * \return list of all added axes. + * Returns the list of all added axes. * * \sa addAxis() */ -- cgit v1.2.3