From f27ec02cee6e0390ec92e82e442cbe3cb12726a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomi=20Korpip=C3=A4=C3=A4?= Date: Thu, 27 Feb 2014 11:08:10 +0200 Subject: Doc fixes: - QValue3DAxis - QItemModelScatterDataProxy - QItemModelSurfaceDataProxy - QScatterDataProxy - QSurface3DSeries - QSurfaceDataProxy Change-Id: If94fef980c96d4e34a5034ba93f3ac676d479f05 Change-Id: If94fef980c96d4e34a5034ba93f3ac676d479f05 Reviewed-by: Miikka Heikkinen --- src/datavisualization/axis/qvalue3daxis.cpp | 2 +- .../data/qitemmodelscatterdataproxy.cpp | 14 ++++++------ .../data/qitemmodelsurfacedataproxy.cpp | 26 +++++++++++----------- src/datavisualization/data/qscatterdataproxy.cpp | 1 + src/datavisualization/data/qsurface3dseries.cpp | 4 ++-- src/datavisualization/data/qsurface3dseries.h | 2 +- src/datavisualization/data/qsurfacedataproxy.cpp | 2 ++ 7 files changed, 27 insertions(+), 24 deletions(-) diff --git a/src/datavisualization/axis/qvalue3daxis.cpp b/src/datavisualization/axis/qvalue3daxis.cpp index 52f1e599..0d53291d 100644 --- a/src/datavisualization/axis/qvalue3daxis.cpp +++ b/src/datavisualization/axis/qvalue3daxis.cpp @@ -147,7 +147,7 @@ int QValue3DAxis::subSegmentCount() const /*! * \property QValue3DAxis::labelFormat * - * Defines the label format to be used for the labels on this axis. Supported specifiers are: + * Defines the label \a format to be used for the labels on this axis. Supported specifiers are: * \c {d, i, o, x, X, f, F, e, E, g, G, c}. See QString::sprintf() for additional details. * * Usage example: diff --git a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp index a5287abc..c4924886 100644 --- a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp +++ b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp @@ -190,7 +190,7 @@ const QAbstractItemModel *QItemModelScatterDataProxy::itemModel() const /*! * \property QItemModelScatterDataProxy::xPosRole * - * Defines the X position role for the mapping. + * Defines the X position \a role for the mapping. */ void QItemModelScatterDataProxy::setXPosRole(const QString &role) { @@ -208,7 +208,7 @@ QString QItemModelScatterDataProxy::xPosRole() const /*! * \property QItemModelScatterDataProxy::yPosRole * - * Defines the Y position role for the mapping. + * Defines the Y position \a role for the mapping. */ void QItemModelScatterDataProxy::setYPosRole(const QString &role) { @@ -226,7 +226,7 @@ QString QItemModelScatterDataProxy::yPosRole() const /*! * \property QItemModelScatterDataProxy::zPosRole * - * Defines the Z position role for the mapping. + * Defines the Z position \a role for the mapping. */ void QItemModelScatterDataProxy::setZPosRole(const QString &role) { @@ -244,12 +244,12 @@ QString QItemModelScatterDataProxy::zPosRole() const /*! * \property QItemModelScatterDataProxy::rotationRole * - * Defines the rotation role for the mapping. + * Defines the rotation \a role for the mapping. * * The model may supply the value for rotation as either variant that is directly convertible - * to QQuartenion, or as one of the string representations: \c{"scalar,x,y,z"} or \c{"@angle,x,y,z"}. The first - * will construct the quaternion directly with given values, and the second one will construct - * the quaternion using QQuaternion::fromAxisAndAngle() method. + * to QQuaternion, or as one of the string representations: \c{"scalar,x,y,z"} or \c{"@angle,x,y,z"}. + * The first will construct the quaternion directly with given values, and the second one will + * construct the quaternion using QQuaternion::fromAxisAndAngle() method. */ void QItemModelScatterDataProxy::setRotationRole(const QString &role) { diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp index f15a8923..07d15d23 100644 --- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp +++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp @@ -137,7 +137,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \qmlproperty list ItemModelSurfaceDataProxy::useModelCategories * When set to true, the mapping ignores row and column roles and categories, and uses - * the rows and columns from the model instead. Defaults to false. + * the rows and columns from the model instead. Defaults to \c{false}. */ /*! @@ -145,7 +145,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * When set to true, the mapping ignores any explicitly set row categories * and overwrites them with automatically generated ones whenever the * data from model is resolved. Proxy minimum and maximum row values are also - * autogenerated from data when this is set to true. Defaults to true. + * autogenerated from data when this is set to true. Defaults to \c{true}. */ /*! @@ -153,7 +153,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * When set to true, the mapping ignores any explicitly set column categories * and overwrites them with automatically generated ones whenever the * data from model is resolved. Proxy minimum and maximum column values are also - * autogenerated from data when this is set to true. Defaults to true. + * autogenerated from data when this is set to true. Defaults to \c{true}. */ /*! @@ -329,7 +329,7 @@ const QAbstractItemModel *QItemModelSurfaceDataProxy::itemModel() const /*! * \property QItemModelSurfaceDataProxy::rowRole * - * Defines the row role for the mapping. + * Defines the row \a role for the mapping. */ void QItemModelSurfaceDataProxy::setRowRole(const QString &role) { @@ -347,7 +347,7 @@ QString QItemModelSurfaceDataProxy::rowRole() const /*! * \property QItemModelSurfaceDataProxy::columnRole * - * Defines the column role for the mapping. + * Defines the column \a role for the mapping. */ void QItemModelSurfaceDataProxy::setColumnRole(const QString &role) { @@ -365,7 +365,7 @@ QString QItemModelSurfaceDataProxy::columnRole() const /*! * \property QItemModelSurfaceDataProxy::xPosRole * - * Defines the X position role for the mapping. + * Defines the X position \a role for the mapping. */ void QItemModelSurfaceDataProxy::setXPosRole(const QString &role) { @@ -383,7 +383,7 @@ QString QItemModelSurfaceDataProxy::xPosRole() const /*! * \property QItemModelSurfaceDataProxy::yPosRole * - * Defines the Y position role for the mapping. + * Defines the Y position \a role for the mapping. */ void QItemModelSurfaceDataProxy::setYPosRole(const QString &role) { @@ -401,7 +401,7 @@ QString QItemModelSurfaceDataProxy::yPosRole() const /*! * \property QItemModelSurfaceDataProxy::zPosRole * - * Defines the Z position role for the mapping. + * Defines the Z position \a role for the mapping. */ void QItemModelSurfaceDataProxy::setZPosRole(const QString &role) { @@ -419,7 +419,7 @@ QString QItemModelSurfaceDataProxy::zPosRole() const /*! * \property QItemModelSurfaceDataProxy::rowCategories * - * Defines the row categories for the mapping. + * Defines the row \a categories for the mapping. */ void QItemModelSurfaceDataProxy::setRowCategories(const QStringList &categories) { @@ -437,7 +437,7 @@ QStringList QItemModelSurfaceDataProxy::rowCategories() const /*! * \property QItemModelSurfaceDataProxy::columnCategories * - * Defines the column categories for the mapping. + * Defines the column \a categories for the mapping. */ void QItemModelSurfaceDataProxy::setColumnCategories(const QStringList &categories) { @@ -456,7 +456,7 @@ QStringList QItemModelSurfaceDataProxy::columnCategories() const * \property QItemModelSurfaceDataProxy::useModelCategories * * When set to true, the mapping ignores row and column roles and categories, and uses - * the rows and columns from the model instead. Defaults to false. + * the rows and columns from the model instead. Defaults to \c{false}. */ void QItemModelSurfaceDataProxy::setUseModelCategories(bool enable) { @@ -476,7 +476,7 @@ bool QItemModelSurfaceDataProxy::useModelCategories() const * * When set to true, the mapping ignores any explicitly set row categories * and overwrites them with automatically generated ones whenever the - * data from model is resolved. Defaults to true. + * data from model is resolved. Defaults to \c{true}. */ void QItemModelSurfaceDataProxy::setAutoRowCategories(bool enable) { @@ -496,7 +496,7 @@ bool QItemModelSurfaceDataProxy::autoRowCategories() const * * When set to true, the mapping ignores any explicitly set column categories * and overwrites them with automatically generated ones whenever the - * data from model is resolved. Defaults to true. + * data from model is resolved. Defaults to \c{true}. */ void QItemModelSurfaceDataProxy::setAutoColumnCategories(bool enable) { diff --git a/src/datavisualization/data/qscatterdataproxy.cpp b/src/datavisualization/data/qscatterdataproxy.cpp index dbbb4384..84bb57e7 100644 --- a/src/datavisualization/data/qscatterdataproxy.cpp +++ b/src/datavisualization/data/qscatterdataproxy.cpp @@ -37,6 +37,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \typedef QtDataVisualization::QScatterDataArray + * \relates QScatterDataProxy * * A vector of \l {QScatterDataItem}s. */ diff --git a/src/datavisualization/data/qsurface3dseries.cpp b/src/datavisualization/data/qsurface3dseries.cpp index b7e15014..9518b0c4 100644 --- a/src/datavisualization/data/qsurface3dseries.cpp +++ b/src/datavisualization/data/qsurface3dseries.cpp @@ -283,9 +283,9 @@ bool QSurface3DSeries::isFlatShadingSupported() const /*! * \property QSurface3DSeries::drawMode * - * Sets the drawing \a mode to one of QSurface3DSeries::DrawFlag. + * Sets the drawing \a mode to one of DrawFlag. */ -void QSurface3DSeries::setDrawMode(QSurface3DSeries::DrawFlags mode) +void QSurface3DSeries::setDrawMode(DrawFlags mode) { if (dptr()->m_drawMode != mode) { dptr()->setDrawMode(mode); diff --git a/src/datavisualization/data/qsurface3dseries.h b/src/datavisualization/data/qsurface3dseries.h index 8347104e..64df7202 100644 --- a/src/datavisualization/data/qsurface3dseries.h +++ b/src/datavisualization/data/qsurface3dseries.h @@ -58,7 +58,7 @@ public: void setFlatShadingEnabled(bool enabled); bool isFlatShadingEnabled() const; - void setDrawMode(QSurface3DSeries::DrawFlags mode); + void setDrawMode(DrawFlags mode); QSurface3DSeries::DrawFlags drawMode() const; bool isFlatShadingSupported() const; diff --git a/src/datavisualization/data/qsurfacedataproxy.cpp b/src/datavisualization/data/qsurfacedataproxy.cpp index 34cea326..2e66bb5b 100644 --- a/src/datavisualization/data/qsurfacedataproxy.cpp +++ b/src/datavisualization/data/qsurfacedataproxy.cpp @@ -58,12 +58,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \typedef QtDataVisualization::QSurfaceDataRow + * \relates QSurfaceDataProxy * * A vector of \l {QSurfaceDataItem}s. */ /*! * \typedef QtDataVisualization::QSurfaceDataArray + * \relates QSurfaceDataProxy * * A list of pointers to \l {QSurfaceDataRow}s. */ -- cgit v1.2.3