From c39f24a3850532f675b2728477d08f37993a9c36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomi=20Korpip=C3=A4=C3=A4?= Date: Tue, 10 Jun 2014 11:48:30 +0300 Subject: QML doc fixes Change-Id: I2760f559916a1a52a6217f0e5fd26a32d78996ff Reviewed-by: Miikka Heikkinen --- src/datavisualization/data/qbar3dseries.cpp | 4 +-- src/datavisualization/data/qcustom3ditem.cpp | 2 +- .../data/qitemmodelbardataproxy.cpp | 7 ++--- .../data/qitemmodelscatterdataproxy.cpp | 6 ++--- .../data/qitemmodelsurfacedataproxy.cpp | 13 +++++----- ...tdatavisualization-qml-abstractdeclarative.qdoc | 9 ++++++- src/datavisualization/engine/q3dcamera.cpp | 6 ++--- src/datavisualization/theme/q3dtheme.cpp | 30 +++++++++++----------- 8 files changed, 42 insertions(+), 35 deletions(-) (limited to 'src/datavisualization') 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) { diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index ba3173b0..2cc3eece 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -53,7 +53,7 @@ /*! \qmlproperty Scene3D AbstractGraph3D::scene - Read only Q3DScene that can be used to access e.g. camera object. + Read only property that can be used to access for example Camera3D via the Scene3D held here. */ /*! @@ -145,6 +145,13 @@ * \sa measureFps */ +/*! + * \qmlproperty list AbstractGraph3D::customItemList + * \since QtDataVisualization 1.1 + * + * Add a list of \l{Custom3DItem}s to the graph. Graph takes ownership of the added items. + */ + /*! * \qmlmethod void AbstractGraph3D::clearSelection() * Clears selection from all attached series. diff --git a/src/datavisualization/engine/q3dcamera.cpp b/src/datavisualization/engine/q3dcamera.cpp index 9866a34e..06fd570c 100644 --- a/src/datavisualization/engine/q3dcamera.cpp +++ b/src/datavisualization/engine/q3dcamera.cpp @@ -89,14 +89,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * \qmlproperty float Camera3D::xRotation * * This property contains the X-rotation angle of the camera around the target point in degrees - * starting from the current base position set by the setBaseOrientation method. + * starting from the current base position. */ /*! * \qmlproperty float Camera3D::yRotation * * This property contains the Y-rotation angle of the camera around the target point in degrees - * starting from the current base position set by the setBaseOrientation method. + * starting from the current base position. */ /*! @@ -105,8 +105,6 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * This property contains the currently active camera preset, which is one of * \l{Q3DCamera::CameraPreset}{Camera3D.CameraPreset}. If no preset is active the value * is \l{Q3DCamera::CameraPresetNone}{Camera3D.CameraPresetNone}. - * \note The base camera orientation set by setBaseOrientation will affect the presets as all - * calculations are based on those values. */ /*! diff --git a/src/datavisualization/theme/q3dtheme.cpp b/src/datavisualization/theme/q3dtheme.cpp index eaed3c41..97ff8f81 100644 --- a/src/datavisualization/theme/q3dtheme.cpp +++ b/src/datavisualization/theme/q3dtheme.cpp @@ -240,7 +240,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION */ /*! - * \qmlproperty Color Theme3D::baseColors + * \qmlproperty list Theme3D::baseColors * * List of base colors to be used for all the objects in the graph, series by series. If there * are more series than colors, color list wraps and starts again with the first color in the list. @@ -248,57 +248,57 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION */ /*! - * \qmlproperty Color Theme3D::backgroundColor + * \qmlproperty color Theme3D::backgroundColor * * Color for the graph background. */ /*! - * \qmlproperty Color Theme3D::windowColor + * \qmlproperty color Theme3D::windowColor * * Color for the application window. */ /*! - * \qmlproperty Color Theme3D::labelTextColor + * \qmlproperty color Theme3D::labelTextColor * * Color for the font used for labels. */ /*! - * \qmlproperty Color Theme3D::labelBackgroundColor + * \qmlproperty color Theme3D::labelBackgroundColor * * Color for the label backgrounds. Has no effect if labelBackgroundEnabled is \c false. */ /*! - * \qmlproperty Color Theme3D::gridLineColor + * \qmlproperty color Theme3D::gridLineColor * * Color for the grid lines. */ /*! - * \qmlproperty Color Theme3D::singleHighlightColor + * \qmlproperty color Theme3D::singleHighlightColor * * Highlight color for a highlighted object. Used if \l{AbstractGraph3D::selectionMode}{selectionMode} * has \c AbstractGraph3D.SelectionItem flag set. */ /*! - * \qmlproperty Color Theme3D::multiHighlightColor + * \qmlproperty color Theme3D::multiHighlightColor * * Highlight color for highlighted objects. Used if \l{AbstractGraph3D::selectionMode}{selectionMode} * has \c AbstractGraph3D.SelectionRow or \c AbstractGraph3D.SelectionColumn flag set. */ /*! - * \qmlproperty Color Theme3D::lightColor + * \qmlproperty color Theme3D::lightColor * * Color for the specular light defined in Scene3D. */ /*! - * \qmlproperty ColorGradient Theme3D::baseGradients + * \qmlproperty list Theme3D::baseGradients * * List of base gradients to be used for all the objects in the graph, series by series. If there * are more series than gradients, gradient list wraps and starts again with the first gradient in @@ -321,19 +321,19 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION */ /*! - * \qmlproperty float Theme3D::lightStrength + * \qmlproperty real Theme3D::lightStrength * * Specular light strength for the whole graph. Value must be between 0.0 and 1.0. */ /*! - * \qmlproperty float Theme3D::ambientLightStrength + * \qmlproperty real Theme3D::ambientLightStrength * * Ambient light strength for the whole graph. Value must be between 0.0 and 1.0. */ /*! - * \qmlproperty float Theme3D::highlightLightStrength + * \qmlproperty real Theme3D::highlightLightStrength * * Specular light strength for highlighted objects. Value must be between 0.0 and 1.0. */ @@ -345,9 +345,9 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION */ /*! - * \qmlproperty Font Theme3D::font + * \qmlproperty font Theme3D::font * - * Set \a font to be used for labels. + * Set font to be used for labels. */ /*! -- cgit v1.2.3