diff options
author | Tomi Korpipää <tomi.korpipaa@digia.com> | 2014-06-10 11:48:30 +0300 |
---|---|---|
committer | Tomi Korpipää <tomi.korpipaa@digia.com> | 2014-06-10 11:50:19 +0300 |
commit | c39f24a3850532f675b2728477d08f37993a9c36 (patch) | |
tree | c9d400e8dfcefb1919a91ace008e35ad8aea2034 /src/datavisualization/data | |
parent | f15bcc41a2be8aa2267f4abf23e99bac72b594b4 (diff) |
QML doc fixes
Change-Id: I2760f559916a1a52a6217f0e5fd26a32d78996ff
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
Diffstat (limited to 'src/datavisualization/data')
5 files changed, 17 insertions, 15 deletions
diff --git a/src/datavisualization/data/qbar3dseries.cpp b/src/datavisualization/data/qbar3dseries.cpp index 3440a3db..19c3bf79 100644 --- a/src/datavisualization/data/qbar3dseries.cpp +++ b/src/datavisualization/data/qbar3dseries.cpp @@ -119,7 +119,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * * A convenience property for defining the series rotation \a angle in degrees. * - * \note: When reading this property, it is calculated from Abstract3DSeries::meshRotation value + * \note When reading this property, it is calculated from Abstract3DSeries::meshRotation value * using floating point precision and always returns a value from zero to 360 degrees. * * \sa Abstract3DSeries::meshRotation @@ -222,7 +222,7 @@ static inline float quaternionAngle(const QQuaternion &rotation) * Setting this property is equivalent to the following call: * \code setMeshRotation(QQuaternion::fromAxisAndAngle(0.0f, 1.0f, 0.0f, angle)) \endcode * - * \note: When reading this property, it is calculated from QAbstract3DSeries::meshRotation value + * \note When reading this property, it is calculated from QAbstract3DSeries::meshRotation value * using floating point precision and always returns a value from zero to 360 degrees. * * \sa QAbstract3DSeries::meshRotation diff --git a/src/datavisualization/data/qcustom3ditem.cpp b/src/datavisualization/data/qcustom3ditem.cpp index f5d8470f..efee3b15 100644 --- a/src/datavisualization/data/qcustom3ditem.cpp +++ b/src/datavisualization/data/qcustom3ditem.cpp @@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * Holds the texture file name for the item. If left unset, a solid gray texture will be * used. * - * \note To conserve memory the Image loaded from the file is cleared after a texture is created. + * \note To conserve memory the QImage loaded from the file is cleared after a texture is created. */ /*! \qmlproperty vector3d Custom3DItem::position diff --git a/src/datavisualization/data/qitemmodelbardataproxy.cpp b/src/datavisualization/data/qitemmodelbardataproxy.cpp index 3d4a980a..10ebcea8 100644 --- a/src/datavisualization/data/qitemmodelbardataproxy.cpp +++ b/src/datavisualization/data/qitemmodelbardataproxy.cpp @@ -241,13 +241,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \qmlproperty ItemModelBarDataProxy.MultiMatchBehavior ItemModelBarDataProxy::multiMatchBehavior * This property defines how multiple matches for each row/column combination are handled. - * Defaults to ItemModelBarDataProxy.MMBLast. The chosen behavior affects both bar value - * and rotation. + * Defaults to \l{QItemModelBarDataProxy::MMBLast}{ItemModelBarDataProxy.MMBLast}. The chosen + * behavior affects both bar value and rotation. * * For example, you might have an item model with timestamped data taken at irregular intervals * and you want to visualize total value of data items on each day with a bar graph. * This can be done by specifying row and column categories so that each bar represents a day, - * and setting multiMatchBehavior to ItemModelBarDataProxy.MMBCumulative. + * and setting multiMatchBehavior to + * \l{QItemModelBarDataProxy::MMBCumulative}{ItemModelBarDataProxy.MMBCumulative}. */ /*! diff --git a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp index 4e6464ea..4fd3e574 100644 --- a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp +++ b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp @@ -106,9 +106,9 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * * Defines the item model role to map into item rotation. * The model may supply the value for rotation as either variant that is directly convertible - * to QQuaternion, or as one of the string representations: \c{"scalar,x,y,z"} or - * \c{"@angle,x,y,z"}. The first format will construct the quaternion directly with given values, - * and the second one will construct the quaternion using QQuaternion::fromAxisAndAngle() method. + * to \l quaternion, or as one of the string representations: \c{"scalar,x,y,z"} or + * \c{"@angle,x,y,z"}. The first format will construct the \l quaternion directly with given values, + * and the second one will construct the \l quaternion using QQuaternion::fromAxisAndAngle() method. */ /*! diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp index 5117d386..d5216560 100644 --- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp +++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp @@ -128,7 +128,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \qmlproperty string ItemModelSurfaceDataProxy::xPosRole * Defines the item model role to map into X position. If this role is not defined, columnRole is - * used to determine the X-coordinate value of resolved QSurfaceDataItems. + * used to determine the X-coordinate value of resolved \l{QSurfaceDataItem}s. */ /*! @@ -139,7 +139,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \qmlproperty string ItemModelSurfaceDataProxy::zPosRole * Defines the item model role to map into Z position. If this role is not defined, rowRole is - * used to determine the Z-coordinate value of resolved QSurfaceDataItems. + * used to determine the Z-coordinate value of resolved \l{QSurfaceDataItem}s. */ /*! @@ -285,12 +285,13 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION /*! * \qmlproperty ItemModelSurfaceDataProxy.MultiMatchBehavior ItemModelSurfaceDataProxy::multiMatchBehavior * This property defines how multiple matches for each row/column combination are handled. - * Defaults to ItemModelSurfaceDataProxy.MMBLast. + * Defaults to \l{QItemModelSurfaceDataProxy::MMBLast}{ItemModelSurfaceDataProxy.MMBLast}. * * For example, you might have an item model with timestamped data taken at irregular intervals * and you want to visualize an average position of data items on each hour with a surface graph. * This can be done by specifying row and column categories so that each surface point represents - * an hour, and setting multiMatchBehavior to ItemModelSurfaceDataProxy.MMBAverage. + * an hour, and setting multiMatchBehavior to + * \l{QItemModelSurfaceDataProxy::MMBAverage}{ItemModelSurfaceDataProxy.MMBAverage}. */ /*! @@ -528,7 +529,7 @@ QString QItemModelSurfaceDataProxy::columnRole() const * \property QItemModelSurfaceDataProxy::xPosRole * * Defines the item model role to map into X position. If this role is not defined, columnRole is - * used to determine the X-coordinate value of resolved QSurfaceDataItems. + * used to determine the X-coordinate value of resolved \l{QSurfaceDataItem}s. */ void QItemModelSurfaceDataProxy::setXPosRole(const QString &role) { @@ -565,7 +566,7 @@ QString QItemModelSurfaceDataProxy::yPosRole() const * \property QItemModelSurfaceDataProxy::zPosRole * * Defines the item model role to map into Z position. If this role is not defined, rowRole is - * used to determine the Z-coordinate value of resolved QSurfaceDataItems. + * used to determine the Z-coordinate value of resolved \l{QSurfaceDataItem}s. */ void QItemModelSurfaceDataProxy::setZPosRole(const QString &role) { |