diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-04-20 10:26:56 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2018-04-20 10:17:18 +0000 |
| commit | dcda92d3094f35c50c3665059df1b237bf4904b8 (patch) | |
| tree | 67d674255dc29cc237f49f6b0d1940679e71d077 | |
| parent | bb09fa7b64b288a68edc61c52ea8467f96eb3924 (diff) | |
Doc: Fix documentation warnings related to Clang QDoc parser
Since Qt 5.11, QDoc uses Clang to parse C++ documentation. Clang
requires a module header, as well as proper include paths, to
build a precompiled header and process the sources.
To do this, add a custom module header that pulls in all Qt 3D modules
- this way, we can continue using a single documentation project to
covers all of Qt 3D.
Fix all documentation warnings are caused by missing namespaces, QML
module/type names and typos, as well as a number of linking problems
and other minor issues.
After this change, the remaining documentation issues consist of
'No documentation for ...' warnings.
Task-number: QTBUG-67790
Change-Id: I38b91163c475a00cc1893e793240470c5409eb57
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
45 files changed, 419 insertions, 323 deletions
diff --git a/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc b/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc index eeb59f07b..0f8a95dab 100644 --- a/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc +++ b/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc @@ -27,7 +27,7 @@ /*! \example advancedcustommaterial - \title Qt 3D: Advanced custom material QML Example + \title Qt 3D: Advanced Custom Material QML Example \ingroup qt3d-examples-qml \brief Demonstrates creating advanced materials in Qt3D diff --git a/examples/qt3d/pbr-materials/doc/src/materials.qdoc b/examples/qt3d/pbr-materials/doc/src/materials.qdoc index c96bb0843..7a0e5d9a4 100644 --- a/examples/qt3d/pbr-materials/doc/src/materials.qdoc +++ b/examples/qt3d/pbr-materials/doc/src/materials.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example materials + \example pbr-materials \title Qt 3D: PBR Materials QML Example \ingroup qt3d-examples-qml \brief A QML application that demonstrates using PBR materials. diff --git a/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc b/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc index 678a8f2d7..d10927d39 100644 --- a/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc +++ b/examples/qt3d/simplecustommaterial/doc/src/simplecustommaterial.qdoc @@ -27,9 +27,9 @@ /*! \example simplecustommaterial - \title Qt 3D: Simple custom material QML Example + \title Qt 3D: Simple Custom Material QML Example \ingroup qt3d-examples-qml - \brief Demonstrates creating a custom material in Qt3D + \brief Demonstrates creating a custom material in Qt 3D. \image simple-custom-material.jpg @@ -37,7 +37,7 @@ \include examples-run.qdocinc - \section1 Specifying the scene + \section1 Specifying the Scene The example uses \l Scene3D to render a scene which will use the custom material. The scene contains a plane model, which uses the custom material. @@ -46,7 +46,7 @@ \skipto Entity \printto - \section1 Specifying the material + \section1 Specifying the Material The material is specified in \l{simplecustommaterial/SimpleMaterial.qml}{SimpleMaterial.qml} using \l Material type. First the material specifies parameters, diff --git a/src/animation/backend/bezierevaluator.cpp b/src/animation/backend/bezierevaluator.cpp index 2752904fc..a56dc7007 100644 --- a/src/animation/backend/bezierevaluator.cpp +++ b/src/animation/backend/bezierevaluator.cpp @@ -101,6 +101,8 @@ float BezierEvaluator::valueForTime(float time) const } /*! + \internal + Calculates the value of the Bezier parameter, u, for the requested time which is the x coordinate of the Keyframes. diff --git a/src/animation/backend/clipblendnode.cpp b/src/animation/backend/clipblendnode.cpp index 94a956837..81fc61910 100644 --- a/src/animation/backend/clipblendnode.cpp +++ b/src/animation/backend/clipblendnode.cpp @@ -93,7 +93,7 @@ ClipResults ClipBlendNode::clipResults(Qt3DCore::QNodeId animatorId) const return ClipResults(); } -/*! +/* \fn QVector<Qt3DCore::QNodeId> ClipBlendNode::currentDependencyIds() const \internal @@ -115,7 +115,7 @@ ClipResults ClipBlendNode::clipResults(Qt3DCore::QNodeId animatorId) const evaluated in one pass, and the tree in a subsequent pass. */ -/*! +/* \fn QVector<Qt3DCore::QNodeId> ClipBlendNode::allDependencyIds() const \internal @@ -126,7 +126,7 @@ ClipResults ClipBlendNode::clipResults(Qt3DCore::QNodeId animatorId) const parameter. Not just those bounding the current blend value. */ -/*! +/* \internal Fetches the ClipResults from the nodes listed in the dependencyIds diff --git a/src/animation/frontend/qabstractclipanimator.cpp b/src/animation/frontend/qabstractclipanimator.cpp index f531127c7..ba5d9456b 100644 --- a/src/animation/frontend/qabstractclipanimator.cpp +++ b/src/animation/frontend/qabstractclipanimator.cpp @@ -218,7 +218,7 @@ QClock *QAbstractClipAnimator::clock() const } /*! - \property int QAbstractClipAnimator::normalizedTime + \property Qt3DAnimation::QAbstractClipAnimator::normalizedTime This property holds the clips normalized time. */ diff --git a/src/animation/frontend/qchannelmappingcreatedchange.cpp b/src/animation/frontend/qchannelmappingcreatedchange.cpp index 6da1eb23e..6812278ac 100644 --- a/src/animation/frontend/qchannelmappingcreatedchange.cpp +++ b/src/animation/frontend/qchannelmappingcreatedchange.cpp @@ -49,9 +49,9 @@ QChannelMappingCreatedChangeBasePrivate::QChannelMappingCreatedChangeBasePrivate } /*! - \class QChannelmappingCreatedChangeBase + \class Qt3DAnimation::QChannelMappingCreatedChangeBase \inmodule Qt3DCore - \brief Base class for handling creation changes for QAbstractSkeleton sub-classes + \brief Base class for handling creation changes for QAbstractSkeleton sub-classes. */ QChannelMappingCreatedChangeBase::QChannelMappingCreatedChangeBase(const QAbstractChannelMapping *mapping) : Qt3DCore::QNodeCreatedChangeBase(*new QChannelMappingCreatedChangeBasePrivate(mapping), mapping) diff --git a/src/animation/frontend/qclipblendnodecreatedchange.cpp b/src/animation/frontend/qclipblendnodecreatedchange.cpp index 0dc417b1c..5192e6a01 100644 --- a/src/animation/frontend/qclipblendnodecreatedchange.cpp +++ b/src/animation/frontend/qclipblendnodecreatedchange.cpp @@ -49,7 +49,7 @@ QClipBlendNodeCreatedChangeBasePrivate::QClipBlendNodeCreatedChangeBasePrivate(c } /*! - \class QClipBlendNodeCreateChangeBase + \class Qt3DAnimation::QClipBlendNodeCreatedChangeBase \inherits Qt3DCore::QNodeCreatedChangeBase \inmodule Qt3DAnimation \brief Base class for changes in QClipBlendNode @@ -63,9 +63,9 @@ QClipBlendNodeCreatedChangeBase::~QClipBlendNodeCreatedChangeBase() { } /*! - typedef Qt3DAnimation::QClipBlendNodeCreatedChangeBasePtr + \typedef Qt3DAnimation::QClipBlendNodeCreatedChangeBasePtr - A shared pointer for QClipBlendNodeCreatedChangeBase + A shared pointer for QClipBlendNodeCreatedChangeBase. */ } // Qt3DAnimation diff --git a/src/animation/frontend/qkeyframe.cpp b/src/animation/frontend/qkeyframe.cpp index 1d63af3ab..2b2dc24bd 100644 --- a/src/animation/frontend/qkeyframe.cpp +++ b/src/animation/frontend/qkeyframe.cpp @@ -44,9 +44,9 @@ QT_BEGIN_NAMESPACE namespace Qt3DAnimation { /*! - \class QKeyframe + \class Qt3DAnimation::QKeyFrame \inmodule Qt3DAnimation - \brief A base class for handling keyframes + \brief A base class for handling keyframes. */ } // namespace Qt3DAnimation diff --git a/src/animation/frontend/qlerpclipblend.cpp b/src/animation/frontend/qlerpclipblend.cpp index 3b26adbaa..12f4d7aec 100644 --- a/src/animation/frontend/qlerpclipblend.cpp +++ b/src/animation/frontend/qlerpclipblend.cpp @@ -69,12 +69,12 @@ namespace Qt3DAnimation { \inherits Qt3DAnimation::QAbstractClipBlendNode \brief Performs a linear interpolation of two animation clips based on a - normalized factor + normalized factor. \since 5.9 QLerpClipBlend can be useful to create advanced animation effects based on - individual animation clips. For instance, given a player character,, lerp + individual animation clips. For instance, given a player character, lerp blending could be used to combine a walking animation clip with an injured animation clip based on a blend factor that increases the more the player gets injured. This would then allow with blend factor == 0 to have a non @@ -224,32 +224,6 @@ void QLerpClipBlend::setEndClip(Qt3DAnimation::QAbstractClipBlendNode *endClip) emit endClipChanged(endClip); } -/*! - \qmlproperty list<AnimationClip> LerpBlend::clips - - Holds the list of AnimationClip nodes against which the blending is performed. - - \note Only the two first AnimationClip are used, subsequent ones are ignored -*/ - - -/*! - \fn void QLerpClipBlend::addClip(QAbstractAnimationClip *clip); - Adds a \a clip to the blending node's clips list. - - \note Only the two first AnimationClip are used, subsequent ones are ignored - */ - -/*! - \fn void QLerpClipBlend::removeClip(QAbstractAnimationClip *clip); - Removes a \a clip from the blending node's clips list. - */ - -/*! - \fn QVector<QAbstractAnimationClip *> QLerpClipBlend::clips() const; - Returns the list of QAnimationClip against which the blending is performed. - */ - } // Qt3DAnimation QT_END_NAMESPACE diff --git a/src/core/aspects/qaspectmanager.cpp b/src/core/aspects/qaspectmanager.cpp index 375a4ed83..0b00e6ef3 100644 --- a/src/core/aspects/qaspectmanager.cpp +++ b/src/core/aspects/qaspectmanager.cpp @@ -68,6 +68,10 @@ QT_BEGIN_NAMESPACE namespace Qt3DCore { +/*! + \class Qt3DCore::QAspectManager + \internal +*/ QAspectManager::QAspectManager(QObject *parent) : QObject(parent) , m_root(nullptr) @@ -198,7 +202,7 @@ void QAspectManager::setRootEntity(Qt3DCore::QEntity *root, const QVector<Qt3DCo } /*! - * \fn void Qt3DCore::QAspectManager::registerAspect(Qt3DCore::QAbstractAspect *aspect) + * \internal * * Registers a new \a aspect. */ diff --git a/src/core/changes/qnodecommand.cpp b/src/core/changes/qnodecommand.cpp index 8222ada4d..2be939624 100644 --- a/src/core/changes/qnodecommand.cpp +++ b/src/core/changes/qnodecommand.cpp @@ -83,7 +83,14 @@ QNodeCommand::CommandId QNodeCommandPrivate::createId() */ /*! - * Constructs a new QNodeCommand with \a node. + * \typedef QNodeCommand::CommandId + * + * Type of the command id, defined either as quint64 or quint32 + * depending on the platform support. + */ + +/*! + * Constructs a new QNodeCommand with \a id. */ QNodeCommand::QNodeCommand(QNodeId id) : QSceneChange(*new QNodeCommandPrivate(), CommandRequested, id) diff --git a/src/core/changes/qscenechange.cpp b/src/core/changes/qscenechange.cpp index 03fe7e5d7..87bf06ea0 100644 --- a/src/core/changes/qscenechange.cpp +++ b/src/core/changes/qscenechange.cpp @@ -56,6 +56,7 @@ namespace Qt3DCore { * \value PropertyUpdated A QNode property has been updated. * \value PropertyValueAdded A QNode has been added to the scene. * \value PropertyValueRemoved A QNode has been removed from the scene. + * \value CommandRequested A QNodeCommand has been sent between a node and its backend. * \value ComponentAdded A QComponent has been added to a QEntity. * \value ComponentRemoved A QComponent has been removed from a QEntity. * \value CallbackTriggered A QNode triggered a callback. @@ -78,7 +79,7 @@ QSceneChangePrivate::~QSceneChangePrivate() * \class Qt3DCore::QSceneChange * \inheaderfile Qt3DCore/QSceneChange * \inmodule Qt3DCore - * \brief The base class for changes that can be sent and received by Qt3D's change notification system + * \brief The base class for changes that can be sent and received by Qt3D's change notification system. */ /*! @@ -127,7 +128,7 @@ QSceneChange::~QSceneChange() } /*! - * \return scene change type. + * Returns the scene change type. */ ChangeFlag QSceneChange::type() const Q_DECL_NOTHROW { @@ -136,7 +137,7 @@ ChangeFlag QSceneChange::type() const Q_DECL_NOTHROW } /*! - Set the Delivery flags of the change to \a flags + Sets the delivery flags of the change to \a flags. */ void QSceneChange::setDeliveryFlags(DeliveryFlags flags) Q_DECL_NOTHROW { @@ -145,7 +146,7 @@ void QSceneChange::setDeliveryFlags(DeliveryFlags flags) Q_DECL_NOTHROW } /*! - \return the set delivery flags + Returns the set delivery flags. */ QSceneChange::DeliveryFlags QSceneChange::deliveryFlags() const Q_DECL_NOTHROW { diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp index ecdc83b2c..b370102d4 100644 --- a/src/core/nodes/qnode.cpp +++ b/src/core/nodes/qnode.cpp @@ -984,9 +984,9 @@ QNodeCommand::CommandId QNode::sendCommand(const QString &name, } /*! - * \brief Send a command back to the backend node + * \brief Send a \a command back to the backend node. * - * Assumes the command is to be to sent back in reply to itself to the backend node + * Assumes the command is to be to sent back in reply to itself to the backend node. * * \sa QNodeCommand, QNode::sendCommand */ diff --git a/src/core/nodes/qnodeid.cpp b/src/core/nodes/qnodeid.cpp index 7e392137e..3e11733e6 100644 --- a/src/core/nodes/qnodeid.cpp +++ b/src/core/nodes/qnodeid.cpp @@ -89,7 +89,7 @@ namespace Qt3DCore { /*! * \fn Qt3DCore::QNodeId::operator bool() const - * \TODO + * Returns \TODO */ /*! diff --git a/src/doc/Qt3DDoc b/src/doc/Qt3DDoc new file mode 100644 index 000000000..dbdea1700 --- /dev/null +++ b/src/doc/Qt3DDoc @@ -0,0 +1,23 @@ +#include <Qt3DCore/Qt3DCore> +#include <Qt3DLogic/Qt3DLogic> +#include <Qt3DRender/Qt3DRender> +#include <Qt3DInput/Qt3DInput> +#include <Qt3DQuick/Qt3DQuick> +#include <Qt3DQuickRender/Qt3DQuickRender> +#include <Qt3DQuickInput/Qt3DQuickInput> +#include <Qt3DQuickAnimation/Qt3DQuickAnimation> +#include <Qt3DAnimation/Qt3DAnimation> +#include <Qt3DQuickExtras/Qt3DQuickExtras> +#include <Qt3DQuickScene2D/Qt3DQuickScene2D> +#include <Qt3DExtras/Qt3DExtras> + +// partial list of private headers +#include "../core/aspects/qaspectmanager_p.h" +#include "../core/transforms/matrix4x4_p.h" +#include "../core/transforms/vector3d_p.h" +#include "../render/raycasting/qray3d_p.h" +#include "../input/frontend/qabstractphysicaldeviceproxy_p.h" +#include "../input/frontend/qinputdeviceintegration_p.h" +#include "../animation/frontend/qchannelmappingcreatedchange_p.h" +#include "../animation/frontend/qclipblendnodecreatedchange_p.h" +#include "../animation/backend/clipblendnode_p.h" diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf index 7da047ced..90f1f2012 100644 --- a/src/doc/qt3d.qdocconf +++ b/src/doc/qt3d.qdocconf @@ -4,13 +4,17 @@ project = Qt3D description = Qt 3D Reference Documentation version = $QT_VERSION -examplesinstallpath = qt3d +moduleheader = Qt3DDoc +includepaths = -I . \ + -I $QT_INSTALL_HEADERS \ + -I $QT_INSTALL_HEADERS/Qt3DCore \ + -I $QT_INSTALL_HEADERS/Qt3DCore/$QT_VERSION \ + -I $QT_INSTALL_HEADERS/Qt3DAnimation \ + -I $QT_INSTALL_HEADERS/Qt3DAnimation/$QT_VERSION \ + -I $QT_INSTALL_HEADERS/Qt3DInput \ + -I $QT_INSTALL_HEADERS/Qt3DInput/$QT_VERSION -indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \ - $QT_INSTALL_DOCS/qtgui/qtgui.index \ - $QT_INSTALL_DOCS/qtqml/qtqml.index \ - $QT_INSTALL_DOCS/qtquick/qtquick.index \ - $QT_INSTALL_DOCS/qmake/qmake.index +examplesinstallpath = qt3d qhp.projects = Qt3D @@ -24,11 +28,11 @@ qhp.Qt3D.filterAttributes = qt3d $QT_VERSION qtrefdoc qhp.Qt3D.customFilters.Qt.name = Qt3D $QT_VERSION qhp.Qt3D.customFilters.Qt.filterAttributes = qt3d $QT_VERSION -qhp.Qt3D.subprojects = classes qmltypes +qhp.Qt3D.subprojects = classes qmltypes examples qhp.Qt3D.subprojects.classes.title = C++ Classes qhp.Qt3D.subprojects.classes.indexTitle = Qt 3D C++ Classes -qhp.Qt3D.subprojects.classes.selectors = class fake:headerfile +qhp.Qt3D.subprojects.classes.selectors = class doc:headerfile qhp.Qt3D.subprojects.classes.sortPages = true qhp.Qt3D.subprojects.qmltypes.title = QML Types @@ -36,6 +40,11 @@ qhp.Qt3D.subprojects.qmltypes.indexTitle = Qt 3D QML Types qhp.Qt3D.subprojects.qmltypes.selectors = qmlclass qhp.Qt3D.subprojects.qmltypes.sortPages = true +qhp.Qt3D.subprojects.examples.title = Examples +qhp.Qt3D.subprojects.examples.indexTitle = Qt 3D Examples +qhp.Qt3D.subprojects.examples.selectors = doc:example +qhp.Qt3D.subprojects.examples.sortPages = true + tagfile = qt3d.tags depends += qtcore qtgui qtqml qtquick qtdoc @@ -54,6 +63,14 @@ headerdirs += . \ # Exclude private header files from the documentation build excludefiles += "*_p.h" +# Add some private headers explicitly to avoid documentation warnings +headers = ../core/transforms/matrix4x4_p.h \ + ../core/transforms/vector3d_p.h \ + ../render/raycasting/qray3d_p.h \ + ../animation/frontend/qchannelmappingcreatedchange_p.h \ + ../input/frontend/qabstractphysicaldeviceproxy_p.h \ + ../input/frontend/qinputdeviceintegration_p.h + sourcedirs += . \ ../render \ ../core \ diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc index 0e889e652..eaeaf789e 100644 --- a/src/doc/src/qt3d-index.qdoc +++ b/src/doc/src/qt3d-index.qdoc @@ -68,7 +68,7 @@ For a C++ application that performs 2D or 3D rendering, collision detection, and also handle user input, add the following line to its - \l qmake \c .pro file: + qmake \c .pro file: \badcode QT += 3dcore 3drender 3dinput 3dlogic 3dextras 3danimation diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc index 103d84ff4..cb08a60c0 100644 --- a/src/doc/src/qt3d-module.qdoc +++ b/src/doc/src/qt3d-module.qdoc @@ -38,19 +38,6 @@ ****************************************************************************/ /*! - \module Qt3DCore - \title Qt 3D Core C++ Classes - \brief The Qt 3D module contains functionality to support near-realtime simulation systems. - - \ingroup modules - \ingroup qt3d-modules - \qtvariable 3dcore - - The Qt 3D module provides the foundations and core types used for near-realtime - simulations built on the Qt 3D framework. -*/ - -/*! \page qt3d-cpp.html \title Qt 3D C++ Classes \brief The Qt 3D module contains functionality to support near-realtime simulation systems. @@ -87,38 +74,28 @@ */ /*! - \namespace Qt3DCore - \inmodule Qt3DCore - \ingroup qt3d-namespaces - - \brief Contains classes that are the foundation for Qt 3D simulation - framework, as well as classes that provide the ability to render using the - Qt 3D framework. -*/ - -/*! - \qmlmodule Qt3D.Core 2.0 + \page qt3d-qml.html \title Qt 3D QML Types \brief QML Types for the Qt 3D module. \since 5.7 - \ingroup qmlmodules - \ingroup qt3d-qmlmodules - To import and use the module's QML types, use the following statement: + The Qt 3D core QML types are imported with \badcode import Qt3D.Core 2.0 \endcode - For collision detection, renderer, and input-related QML types, use the - following import statements: + Other modules import functionality for collision detection, rendering, input, + and animation. The complete list of Qt 3D import statements: \badcode + import Qt3D.Core 2.0 import Qt3D.Render 2.0 import Qt3D.Input 2.0 import Qt3D.Logic 2.0 import Qt3D.Extras 2.0 import Qt3D.Animation 2.9 + import Qt3D.Scene2D 2.9 \endcode \section1 QML Types diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc index e1f3d8629..2b261ebbc 100644 --- a/src/doc/src/qt3d-overview.qdoc +++ b/src/doc/src/qt3d-overview.qdoc @@ -88,8 +88,12 @@ variables in a GLSL shader program that is itself specified in the referenced effect property. - For examples of using materials, see the \l {Qt 3D: Materials C++ Example} - and \l {Qt 3D: Materials QML Example}. + For examples of using materials, see the following examples: + \list + \li \l {Qt 3D: Simple Custom Material QML Example} + \li \l {Qt 3D: Advanced Custom Material QML Example} + \li \l {Qt 3D: PBR Materials QML Example} + \endlist \section2 Shaders diff --git a/src/extras/defaults/qabstractcameracontroller.cpp b/src/extras/defaults/qabstractcameracontroller.cpp index aaef1d2d7..527ee7e8d 100644 --- a/src/extras/defaults/qabstractcameracontroller.cpp +++ b/src/extras/defaults/qabstractcameracontroller.cpp @@ -257,7 +257,7 @@ void QAbstractCameraControllerPrivate::applyInputAccelerations() */ /*! - \fn void QAbstractCameraController::moveCamera(const InputState &state, float dt) = 0 + \fn void Qt3DExtras::QAbstractCameraController::moveCamera(const InputState &state, float dt) = 0 This method is called whenever a frame action is triggered. Derived classes must override this method to implement the camera movement @@ -305,7 +305,7 @@ QAbstractCameraController::~QAbstractCameraController() } /*! - \property QAbstractCameraController::camera + \property Qt3DExtras::QAbstractCameraController::camera Holds the currently controlled camera. */ @@ -316,12 +316,12 @@ Qt3DRender::QCamera *QAbstractCameraController::camera() const } /*! - \property QAbstractCameraController::linearSpeed + \property Qt3DExtras::QAbstractCameraController::linearSpeed Holds the current linear speed of the camera controller. Linear speed determines the movement speed of the camera. - The default is 10.0. + The default is \c {10.0}. */ float QAbstractCameraController::linearSpeed() const { @@ -330,12 +330,12 @@ float QAbstractCameraController::linearSpeed() const } /*! - \property QAbstractCameraController::lookSpeed + \property Qt3DExtras::QAbstractCameraController::lookSpeed Holds the current look speed of the camera controller. The look speed determines the turn rate of the camera pan and tilt. - The default is 180.0. + The default is \c {180.0}. */ float QAbstractCameraController::lookSpeed() const { @@ -344,7 +344,7 @@ float QAbstractCameraController::lookSpeed() const } /*! - \property QAbstractCameraController::acceleration + \property Qt3DExtras::QAbstractCameraController::acceleration Holds the current acceleration of the camera controller. */ @@ -355,7 +355,7 @@ float QAbstractCameraController::acceleration() const } /*! - \property QAbstractCameraController::deceleration + \property Qt3DExtras::QAbstractCameraController::deceleration Holds the current deceleration of the camera controller. */ diff --git a/src/extras/geometries/qplanegeometry.cpp b/src/extras/geometries/qplanegeometry.cpp index 0176accdd..7c77f5028 100644 --- a/src/extras/geometries/qplanegeometry.cpp +++ b/src/extras/geometries/qplanegeometry.cpp @@ -284,13 +284,14 @@ public: * \brief The QPlaneGeometry class allows creation of a plane in 3D space. * \since 5.7 * \ingroup geometries - * \inherits Qt3DRender::QGeometry * * The QPlaneGeometry class is most commonly used internally by the QPlaneMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses. */ /*! + * \fn Qt3DExtras::QPlaneGeometry::QPlaneGeometry(QNode *parent) + * * Constructs a new QPlaneGeometry with \a parent. */ QPlaneGeometry::QPlaneGeometry(QPlaneGeometry::QNode *parent) diff --git a/src/input/frontend/qabstractphysicaldevice.cpp b/src/input/frontend/qabstractphysicaldevice.cpp index dc54228d4..120ec43a2 100644 --- a/src/input/frontend/qabstractphysicaldevice.cpp +++ b/src/input/frontend/qabstractphysicaldevice.cpp @@ -196,7 +196,7 @@ void QAbstractPhysicalDevice::removeAxisSetting(QAxisSetting *axisSetting) } /*! - \return the axisSettings associated with this device. + Returns the axisSettings associated with this device. */ QVector<QAxisSetting *> QAbstractPhysicalDevice::axisSettings() const { @@ -204,7 +204,7 @@ QVector<QAxisSetting *> QAbstractPhysicalDevice::axisSettings() const return d->m_axisSettings; } -/*! +/* Used to notify observers that an axis value has been changed. */ void QAbstractPhysicalDevicePrivate::postAxisEvent(int axis, qreal value) @@ -216,7 +216,7 @@ void QAbstractPhysicalDevicePrivate::postAxisEvent(int axis, qreal value) notifyObservers(change); } -/*! +/* Used to notify observers that an button value has been changed. */ void QAbstractPhysicalDevicePrivate::postButtonEvent(int button, qreal value) diff --git a/src/input/frontend/qactioninput.cpp b/src/input/frontend/qactioninput.cpp index b8db101d8..9f32f57cc 100644 --- a/src/input/frontend/qactioninput.cpp +++ b/src/input/frontend/qactioninput.cpp @@ -118,7 +118,7 @@ QVector<int> QActionInput::buttons() const The current source device of the QActionInput. */ /*! - \fn QActionInput::sourceDeviceChanged(QAbstractPhysicalDevice *sourceDevice) + \fn Qt3DInput::QActionInput::sourceDeviceChanged(QAbstractPhysicalDevice *sourceDevice) This signal is emitted when the source device associated with the action input is changed to \a sourceDevice. */ @@ -166,7 +166,7 @@ QAbstractPhysicalDevice *QActionInput::sourceDevice() const } /*! - \fn QActionInput::buttonsChanged(const QVector<int> &buttons) + \fn Qt3DInput::QActionInput::buttonsChanged(const QVector<int> &buttons) This signal is emitted when the buttons associated with the action input is changed. The buttons changed are \a buttons diff --git a/src/input/frontend/qaxissetting.cpp b/src/input/frontend/qaxissetting.cpp index 8f1a8d797..4a8f37785 100644 --- a/src/input/frontend/qaxissetting.cpp +++ b/src/input/frontend/qaxissetting.cpp @@ -128,7 +128,7 @@ bool QAxisSetting::isSmoothEnabled() const /*! - \fn QAxisSetting::deadZoneRadiusChanged(float deadZoneRadius) + \fn Qt3DInput::QAxisSetting::deadZoneRadiusChanged(float deadZoneRadius) This signal is emitted when the Dead Zone radius associated with the axis setting is changed to \a deadZoneRadius. */ @@ -161,7 +161,7 @@ void QAxisSetting::setDeadZoneRadius(float deadZoneRadius) } /*! - \fn QAxisSetting::axesChanged(const QVector<int> &axes) + \fn Qt3DInput::QAxisSetting::axesChanged(const QVector<int> &axes) This signal is emitted when the axes associated with the axis setting is changed to \a axes. */ @@ -194,7 +194,7 @@ void QAxisSetting::setAxes(const QVector<int> &axes) } /*! - \fn QAxisSetting::smoothChanged(bool smooth) + \fn Qt3DInput::QAxisSetting::smoothChanged(bool smooth) This signal is emitted when the smoothing state is changed to \a smooth. */ diff --git a/src/input/frontend/qinputaspect.cpp b/src/input/frontend/qinputaspect.cpp index b37e32d43..1bc57579f 100644 --- a/src/input/frontend/qinputaspect.cpp +++ b/src/input/frontend/qinputaspect.cpp @@ -172,7 +172,7 @@ QInputAspect::~QInputAspect() { } -/*! +/* Create each of the detected input device integrations through the Integration Factory */ void QInputAspectPrivate::loadInputDevicePlugins() @@ -193,10 +193,10 @@ void QInputAspectPrivate::loadInputDevicePlugins() /*! Create a physical device identified by \a name using the input device integrations present - returns a nullptr if it is not found. - \note caller is responsible for ownership + returns a \c nullptr if it is not found. + + \note Caller is responsible for ownership. */ -// Note: caller is responsible for ownership QAbstractPhysicalDevice *QInputAspect::createPhysicalDevice(const QString &name) { Q_D(QInputAspect); @@ -204,7 +204,7 @@ QAbstractPhysicalDevice *QInputAspect::createPhysicalDevice(const QString &name) } /*! - \return a list of all available physical devices. + Returns a list of all available physical devices. */ QStringList QInputAspect::availablePhysicalDevices() const { diff --git a/src/input/frontend/qinputdeviceintegration.cpp b/src/input/frontend/qinputdeviceintegration.cpp index 5140776bf..2fd3f45ed 100644 --- a/src/input/frontend/qinputdeviceintegration.cpp +++ b/src/input/frontend/qinputdeviceintegration.cpp @@ -61,7 +61,7 @@ QInputDeviceIntegrationPrivate::QInputDeviceIntegrationPrivate() */ /*! - Create a new QInputDeviceIntegration with parent /a parent + Creates a new QInputDeviceIntegration with \a parent. */ QInputDeviceIntegration::QInputDeviceIntegration(QObject *parent) : QObject(*new QInputDeviceIntegrationPrivate, parent) @@ -75,7 +75,8 @@ QInputDeviceIntegration::QInputDeviceIntegration(QInputDeviceIntegrationPrivate } /*! - Register a corresponding backend class for this front end implementation + Registers a corresponding backend class for this front end implementation + with \a metaObject and \a functor. */ void QInputDeviceIntegration::registerBackendType(const QMetaObject &metaObject, const Qt3DCore::QBackendNodeMapperPtr &functor) { @@ -84,7 +85,7 @@ void QInputDeviceIntegration::registerBackendType(const QMetaObject &metaObject, } /*! - Called by the InputAspect object after the Integration has been created + Called by the InputAspect object after the integration has been created with \a aspect. */ void QInputDeviceIntegration::initialize(QInputAspect *aspect) { @@ -106,7 +107,7 @@ QInputAspect *QInputDeviceIntegration::inputAspect() const } // namespace Qt3DInput /*! - \fn QInputDeviceIntegration::createPhysicalDevice(const QString &name) + \fn Qt3DInput::QInputDeviceIntegration::createPhysicalDevice(const QString &name) Create the Physical device identified by \a name. @@ -114,15 +115,15 @@ QInputAspect *QInputDeviceIntegration::inputAspect() const */ /*! - \fn QInputDeviceIntegration::physicalDevices() const + \fn Qt3DInput::QInputDeviceIntegration::physicalDevices() const - \return the list of node ids for physical devices associated with this QInputDeviceIntegration. + Returns the list of node ids for physical devices associated with this QInputDeviceIntegration. */ /*! - \fn QInputDeviceIntegration::physicalDevice(Qt3DCore::QNodeId id) const + \fn Qt3DInput::QInputDeviceIntegration::physicalDevice(Qt3DCore::QNodeId id) const - \return the QAbstractPhysicalDevice identified by the given id if it is related to this QInputDeviceIntegration. + Returns the QAbstractPhysicalDevice identified by the given \a id if it is related to this QInputDeviceIntegration. */ QT_END_NAMESPACE diff --git a/src/input/frontend/qkeyboardhandler.cpp b/src/input/frontend/qkeyboardhandler.cpp index c13939c04..2741288ef 100644 --- a/src/input/frontend/qkeyboardhandler.cpp +++ b/src/input/frontend/qkeyboardhandler.cpp @@ -192,7 +192,7 @@ void QKeyboardHandler::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) */ /*! - \property QKeyboardHandler::sourceDevice + \property Qt3DInput::QKeyboardHandler::sourceDevice Holds the keyboard device of the QKeyboardHandler. Without a valid device, the QKeyboardHandler won't receive any event. @@ -232,7 +232,7 @@ QKeyboardDevice *QKeyboardHandler::sourceDevice() const */ /*! - \property QKeyboardHandler::focus + \property Qt3DInput::QKeyboardHandler::focus Holds \c true if the QKeyboardHandlers has focus. */ @@ -269,410 +269,484 @@ Qt3DCore::QNodeCreatedChangeBasePtr QKeyboardHandler::createNodeCreationChange() /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit0Pressed(KeyEvent event) - This signal is emitted when the 0 key is pressed with the event details being contained within \a event + + This signal is emitted when the 0 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit1Pressed(KeyEvent event) - This signal is emitted when the 1 key is pressed with the event details being contained within \a event + + This signal is emitted when the 1 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit2Pressed(KeyEvent event) - This signal is emitted when the 2 key is pressed with the event details being contained within \a event + + This signal is emitted when the 2 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit3Pressed(KeyEvent event) - This signal is emitted when the 3 key is pressed with the event details being contained within \a event + + This signal is emitted when the 3 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit4Pressed(KeyEvent event) - This signal is emitted when the 4 key is pressed with the event details being contained within \a event + + This signal is emitted when the 4 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit5Pressed(KeyEvent event) - This signal is emitted when the 5 key is pressed with the event details being contained within \a event + + This signal is emitted when the 5 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit6Pressed(KeyEvent event) - This signal is emitted when the 6 key is pressed with the event details being contained within \a event + + This signal is emitted when the 6 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit7Pressed(KeyEvent event) - This signal is emitted when the 7 key is pressed with the event details being contained within \a event + + This signal is emitted when the 7 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit8Pressed(KeyEvent event) - This signal is emitted when the 8 key is pressed with the event details being contained within \a event + + This signal is emitted when the 8 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::digit9Pressed(KeyEvent event) - This signal is emitted when the 9 key is pressed with the event details being contained within \a event + + This signal is emitted when the 9 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::leftPressed(KeyEvent event) - This signal is emitted when the left key is pressed with the event details being contained within \a event + + This signal is emitted when the left key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::rightPressed(KeyEvent event) + This signal is emitted when the right key is pressed with the event details being contained within \a event */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::upPressed(KeyEvent event) - This signal is emitted when the up key is pressed with the event details being contained within \a event + + This signal is emitted when the up key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::downPressed(KeyEvent event) - This signal is emitted when the down key is pressed with the event details being contained within \a event + + This signal is emitted when the down key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::tabPressed(KeyEvent event) - This signal is emitted when the tab key is pressed with the event details being contained within \a event + + This signal is emitted when the tab key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::backtabPressed(KeyEvent event) - This signal is emitted when the backtab key is pressed with the event details being contained within \a event + + This signal is emitted when the backtab key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::asteriskPressed(KeyEvent event) - This signal is emitted when the * key is pressed with the event details being contained within \a event + + This signal is emitted when the * key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::numberSignPressed(KeyEvent event) - This signal is emitted when the number sign key is pressed with the event details being contained within \a event + This signal is emitted when the number sign key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::escapePressed(KeyEvent event) - This signal is emitted when the escape key is pressed with the event details being contained within \a event + This signal is emitted when the escape key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::returnPressed(KeyEvent event) - This signal is emitted when the return key is pressed with the event details being contained within \a event + + This signal is emitted when the return key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::enterPressed(KeyEvent event) - This signal is emitted when the enter key is pressed with the event details being contained within \a event + This signal is emitted when the enter key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::deletePressed(KeyEvent event) - This signal is emitted when the delete key is pressed with the event details being contained within \a event + + This signal is emitted when the delete key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::spacePressed(KeyEvent event) - This signal is emitted when the space key is pressed with the event details being contained within \a event + + This signal is emitted when the space key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::backPressed(KeyEvent event) - This signal is emitted when the back key is pressed with the event details being contained within \a event + + This signal is emitted when the back key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::cancelPressed(KeyEvent event) - This signal is emitted when the cancel key is pressed with the event details being contained within \a event + + This signal is emitted when the cancel key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::selectPressed(KeyEvent event) - This signal is emitted when the select key is pressed with the event details being contained within \a event + + This signal is emitted when the select key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::yesPressed(KeyEvent event) - This signal is emitted when the yes key is pressed with the event details being contained within \a event + + This signal is emitted when the yes key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::noPressed(KeyEvent event) - This signal is emitted when the yes key is pressed with the event details being contained within \a event + + This signal is emitted when the yes key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::context1Pressed(KeyEvent event) - This signal is emitted when the context 1 key is pressed with the event details being contained within \a event + + This signal is emitted when the context 1 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::context2Pressed(KeyEvent event) - This signal is emitted when the context 2 key is pressed with the event details being contained within \a event + + This signal is emitted when the context 2 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::context3Pressed(KeyEvent event) - This signal is emitted when the context 2 key is pressed with the event details being contained within \a event + + This signal is emitted when the context 2 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::context4Pressed(KeyEvent event) - This signal is emitted when the context 4 key is pressed with the event details being contained within \a event + + This signal is emitted when the context 4 key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::callPressed(KeyEvent event) - This signal is emitted when the call key is pressed with the event details being contained within \a event + + This signal is emitted when the call key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::hangupPressed(KeyEvent event) - This signal is emitted when the hangup key is pressed with the event details being contained within \a event + + This signal is emitted when the hangup key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::flipPressed(KeyEvent event) - This signal is emitted when the flip key is pressed with the event details being contained within \a event + + This signal is emitted when the flip key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::menuPressed(KeyEvent event) - This signal is emitted when the menu key is pressed with the event details being contained within \a event + + This signal is emitted when the menu key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::volumeUpPressed(KeyEvent event) - This signal is emitted when the volume up key is pressed with the event details being contained within \a event + + This signal is emitted when the volume up key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::volumeDownPressed(KeyEvent event) - This signal is emitted when the volume down key is pressed with the event details being contained within \a event + + This signal is emitted when the volume down key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::pressed(KeyEvent event) - This signal is emitted when a key is pressed with the event details being contained within \a event + + This signal is emitted when a key is pressed with the event details being contained within \a event. */ /*! \qmlsignal Qt3D.Input::KeyboardHandler::released(KeyEvent event) - This signal is emitted when a key is released with the event details being contained within \a event + + This signal is emitted when a key is released with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit0Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 0 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit0Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 0 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit1Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 1 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit1Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 1 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit2Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 2 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit2Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 2 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit3Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 3 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit3Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 3 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit4Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 4 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit4Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 4 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit5Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 5 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit5Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 5 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit6Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 6 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit6Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 6 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit7Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 7 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit7Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 7 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit8Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the 8 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::digit8Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the 8 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::digit9Pressed(Qt3DInput::QKeyEvent *event) + \fn Qt3DInput::QKeyboardHandler::digit9Pressed(Qt3DInput::QKeyEvent *event) + This signal is emitted when the 9 key is pressed with the event details being contained within \a event */ /*! - \fn QKeyboardHandler::leftPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the left key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::leftPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the left key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::rightPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the right key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::rightPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the right key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::upPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the up key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::upPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the up key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::downPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the down key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::downPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the down key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::tabPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the tab key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::tabPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the tab key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::backtabPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the backtab key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::backtabPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the backtab key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::asteriskPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the * key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::asteriskPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the * key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::numberSignPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the number sign key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::numberSignPressed(Qt3DInput::QKeyEvent *event) + This signal is emitted when the number sign key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::escapePressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the escape key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::escapePressed(Qt3DInput::QKeyEvent *event) + This signal is emitted when the escape key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::returnPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the return key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::returnPressed(Qt3DInput::QKeyEvent *event) + This signal is emitted when the return key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::enterPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the enter key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::enterPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the enter key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::deletePressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the delete key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::deletePressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the delete key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::spacePressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the space key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::spacePressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the space key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::backPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the back key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::backPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the back key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::cancelPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the cancel key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::cancelPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the cancel key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::selectPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the select key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::selectPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the select key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::yesPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the yes key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::yesPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the yes key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::noPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the yes key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::noPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the yes key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::context1Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the context 1 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::context1Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the context 1 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::context2Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the context 2 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::context2Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the context 2 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::context3Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the context 2 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::context3Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the context 2 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::context4Pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the context 4 key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::context4Pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the context 4 key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::callPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the call key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::callPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the call key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::hangupPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the hangup key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::hangupPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the hangup key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::flipPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the flip key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::flipPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the flip key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::menuPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the menu key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::menuPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the menu key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::volumeUpPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the volume up key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::volumeUpPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the volume up key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::volumeDownPressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when the volume down key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::volumeDownPressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when the volume down key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::pressed(Qt3DInput::QKeyEvent *event) - This signal is emitted when a key is pressed with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::pressed(Qt3DInput::QKeyEvent *event) + + This signal is emitted when a key is pressed with the event details being contained within \a event. */ /*! - \fn QKeyboardHandler::released(Qt3DInput::QKeyEvent *event) - This signal is emitted when a key is released with the event details being contained within \a event + \fn Qt3DInput::QKeyboardHandler::released(Qt3DInput::QKeyEvent *event) + + This signal is emitted when a key is released with the event details being contained within \a event. */ } // namespace Qt3DInput diff --git a/src/input/frontend/qkeyevent.cpp b/src/input/frontend/qkeyevent.cpp index 2d9226c4e..a70a2970b 100644 --- a/src/input/frontend/qkeyevent.cpp +++ b/src/input/frontend/qkeyevent.cpp @@ -167,7 +167,7 @@ QKeyEvent::~QKeyEvent() */ /*! - \property QKeyEvent::key + \property Qt3DInput::QKeyEvent::key \readonly This property holds the code of the key that was pressed or released. @@ -178,7 +178,7 @@ QKeyEvent::~QKeyEvent() */ /*! - \property QKeyEvent::text + \property Qt3DInput::QKeyEvent::text \readonly This property holds the Unicode text that the key generated. The text @@ -188,7 +188,7 @@ QKeyEvent::~QKeyEvent() */ /*! - \property QKeyEvent::modifiers + \property Qt3DInput::QKeyEvent::modifiers \readonly This property holds the keyboard modifier flags that existed immediately @@ -198,14 +198,14 @@ QKeyEvent::~QKeyEvent() */ /*! - \property QKeyEvent::isAutoRepeat + \property Qt3DInput::QKeyEvent::isAutoRepeat \readonly Holds whether this event comes from an auto-repeating key. */ /*! - \property QKeyEvent::count + \property Qt3DInput::QKeyEvent::count \readonly Holds the number of keys involved in this event. If \l text is not empty, @@ -213,7 +213,7 @@ QKeyEvent::~QKeyEvent() */ /*! - \property QKeyEvent::nativeScanCode + \property Qt3DInput::QKeyEvent::nativeScanCode \readonly This property contains the native scan code of the key that was pressed. @@ -222,7 +222,7 @@ QKeyEvent::~QKeyEvent() */ /*! - \property QKeyEvent::accepted + \property Qt3DInput::QKeyEvent::accepted Setting \e accepted to \c true prevents the key event from being propagated to the item's parent. @@ -232,17 +232,17 @@ QKeyEvent::~QKeyEvent() */ /*! - \fn bool QKeyEvent::matches(QKeySequence::StandardKey key_) const + \fn bool Qt3DInput::QKeyEvent::matches(QKeySequence::StandardKey key_) const - \return \c true if the key event matches the given standard key \a key_; otherwise + Returns \c true if the key event matches the given standard key \a key_; otherwise returns \c false. \sa QKeySequence::StandardKey */ /*! - \fn QEvent::Type QKeyEvent::type() const - \return the type of event + \fn QEvent::Type Qt3DInput::QKeyEvent::type() const + Returns the type of the event. */ diff --git a/src/input/frontend/qmousehandler.cpp b/src/input/frontend/qmousehandler.cpp index 895cbc49a..5d75f82d4 100644 --- a/src/input/frontend/qmousehandler.cpp +++ b/src/input/frontend/qmousehandler.cpp @@ -202,57 +202,57 @@ void QMouseHandlerPrivate::mouseEvent(const QMouseEventPtr &event) */ /*! - \fn QMouseHandler::clicked(Qt3DInput::QMouseEvent *mouse) + \fn Qt3DInput::QMouseHandler::clicked(Qt3DInput::QMouseEvent *mouse) This signal is emitted when a mouse button is clicked with the event details being contained within \a mouse */ /*! - \fn QMouseHandler::doubleClicked(Qt3DInput::QMouseEvent *mouse) + \fn Qt3DInput::QMouseHandler::doubleClicked(Qt3DInput::QMouseEvent *mouse) This signal is emitted when a mouse button is double clicked with the event details being contained within \a mouse */ /*! - \fn QMouseHandler::entered() + \fn Qt3DInput::QMouseHandler::entered() */ /*! - \fn QMouseHandler::exited() + \fn Qt3DInput::QMouseHandler::exited() */ /*! - \fn QMouseHandler::pressed(Qt3DInput::QMouseEvent *mouse) + \fn Qt3DInput::QMouseHandler::pressed(Qt3DInput::QMouseEvent *mouse) This signal is emitted when a mouse button is pressed with the event details being contained within \a mouse */ /*! - \fn QMouseHandler::released(Qt3DInput::QMouseEvent *mouse) + \fn Qt3DInput::QMouseHandler::released(Qt3DInput::QMouseEvent *mouse) This signal is emitted when a mouse button is released with the event details being contained within \a mouse */ /*! - \fn QMouseHandler::pressAndHold(Qt3DInput::QMouseEvent *mouse) + \fn Qt3DInput::QMouseHandler::pressAndHold(Qt3DInput::QMouseEvent *mouse) This signal is emitted when a mouse button is pressed and held down with the event details being contained within \a mouse */ /*! - \fn QMouseHandler::positionChanged(Qt3DInput::QMouseEvent *mouse) + \fn Qt3DInput::QMouseHandler::positionChanged(Qt3DInput::QMouseEvent *mouse) This signal is emitted when the mouse position changes with the event details being contained within \a mouse */ /*! - \fn QMouseHandler::wheel(Qt3DInput::QWheelEvent *wheel) + \fn Qt3DInput::QMouseHandler::wheel(Qt3DInput::QWheelEvent *wheel) This signal is emitted when the mouse wheel is used with the event details being contained within \a wheel @@ -300,7 +300,7 @@ void QMouseHandler::setSourceDevice(QMouseDevice *mouseDevice) } /*! - * \property QMouseHandler::sourceDevice + * \property Qt3DInput::QMouseHandler::sourceDevice * * Holds the current mouse source device of the QMouseHandler instance. */ @@ -311,7 +311,7 @@ QMouseDevice *QMouseHandler::sourceDevice() const } /*! - * \property QMouseHandler::containsMouse + * \property Qt3DInput::QMouseHandler::containsMouse * * Holds \c true if the QMouseHandler currently contains the mouse. * diff --git a/src/logic/qframeaction.cpp b/src/logic/qframeaction.cpp index f6ae70516..37a00fc18 100644 --- a/src/logic/qframeaction.cpp +++ b/src/logic/qframeaction.cpp @@ -125,7 +125,7 @@ void QFrameAction::onTriggered(float dt) */ /*! - \fn QFrameAction::triggered(float dt) + \fn Qt3DLogic::QFrameAction::triggered(float dt) This signal is emitted each frame with \a dt being the time since the last triggering. */ } // namespace Qt3DLogic diff --git a/src/plugins/geometryloaders/fbx/fbxgeometryloader.cpp b/src/plugins/geometryloaders/fbx/fbxgeometryloader.cpp index 10870dde8..355096448 100644 --- a/src/plugins/geometryloaders/fbx/fbxgeometryloader.cpp +++ b/src/plugins/geometryloaders/fbx/fbxgeometryloader.cpp @@ -235,7 +235,7 @@ FbxGeometryLoader::~FbxGeometryLoader() } /*! - Give the list of attributes that can be used to render + Gives the list of attributes that can be used to render a 3D form. Returns a pointer to the geometry object. */ @@ -245,7 +245,8 @@ QGeometry *Qt3DRender::FbxGeometryLoader::geometry() const } /*! - Load the specified \a subMesh using device \a ioDev. + Loads the specified \a subMesh using a device \a ioDev. Returns \c true + on success, \c false otherwise. */ bool Qt3DRender::FbxGeometryLoader::load(QIODevice *ioDev, const QString &subMesh) { diff --git a/src/plugins/sceneparsers/assimp/assimpimporter.cpp b/src/plugins/sceneparsers/assimp/assimpimporter.cpp index ad53916fd..fdfc095c6 100644 --- a/src/plugins/sceneparsers/assimp/assimpimporter.cpp +++ b/src/plugins/sceneparsers/assimp/assimpimporter.cpp @@ -128,7 +128,7 @@ const QString TANGENT_ATTRIBUTE_NAME = QAttribute::defaultTangentAttributeName() const QString TEXTCOORD_ATTRIBUTE_NAME = QAttribute::defaultTextureCoordinateAttributeName(); const QString COLOR_ATTRIBUTE_NAME = QAttribute::defaultColorAttributeName(); -/*! +/* * Returns a QMatrix4x4 from \a matrix; */ QMatrix4x4 aiMatrix4x4ToQMatrix4x4(const aiMatrix4x4 &matrix) Q_DECL_NOTHROW @@ -139,7 +139,7 @@ QMatrix4x4 aiMatrix4x4ToQMatrix4x4(const aiMatrix4x4 &matrix) Q_DECL_NOTHROW matrix.d1, matrix.d2, matrix.d3, matrix.d4); } -/*! +/* * Returns a QString from \a str; */ inline QString aiStringToQString(const aiString &str) @@ -168,7 +168,7 @@ QString texturePath(const aiString &path) return p; } -/*! +/* * Returns the Qt3DRender::QParameter with named \a name if contained by the material * \a material. If the material doesn't contain the named parameter, a new * Qt3DRender::QParameter is created and inserted into the material. diff --git a/src/plugins/sceneparsers/gltf/gltfio.cpp b/src/plugins/sceneparsers/gltf/gltfio.cpp index c7c7a00dd..bfe99ab3f 100644 --- a/src/plugins/sceneparsers/gltf/gltfio.cpp +++ b/src/plugins/sceneparsers/gltf/gltfio.cpp @@ -189,7 +189,7 @@ bool GLTFIO::setJSON(const QJsonDocument &json ) return true; } -/*! +/* * Sets the \a path used by the parser to load the scene file. * If the file is valid, parsing is automatically triggered. */ @@ -217,7 +217,7 @@ void GLTFIO::setSource(const QUrl &source) setBasePath(finfo.dir().absolutePath()); } -/*! +/* * Returns true if the extension of \a path is supported by the * GLTF parser. */ diff --git a/src/plugins/sceneparsers/gltf/gltfparser.cpp b/src/plugins/sceneparsers/gltf/gltfparser.cpp index 8d5696b82..881e7f1b2 100644 --- a/src/plugins/sceneparsers/gltf/gltfparser.cpp +++ b/src/plugins/sceneparsers/gltf/gltfparser.cpp @@ -189,7 +189,7 @@ bool GLTFParser::setJSON(const QJsonDocument &json ) return true; } -/*! +/* * Sets the \a path used by the parser to load the scene file. * If the file is valid, parsing is automatically triggered. */ @@ -215,7 +215,7 @@ void GLTFParser::setSource(const QUrl &source) setBasePath(QFileInfo(path).dir().absolutePath()); } -/*! +/* * Returns true if the extension of \a path is supported by the * GLTF parser. */ diff --git a/src/render/framegraph/qblitframebuffer.cpp b/src/render/framegraph/qblitframebuffer.cpp index d5484b719..b0a29eab8 100644 --- a/src/render/framegraph/qblitframebuffer.cpp +++ b/src/render/framegraph/qblitframebuffer.cpp @@ -324,7 +324,7 @@ void QBlitFramebuffer::setSourceRect(const QRectF &inputRect) } /*! - Sets the destination rectangle to \a inputRect. The coordinates are assumed + Sets the destination rectangle to \a outputRect. The coordinates are assumed to follow the normal Qt coordinate system, meaning Y runs from top to bottom. */ diff --git a/src/render/frontend/qabstractfunctor.cpp b/src/render/frontend/qabstractfunctor.cpp index 9f4727865..4be1da595 100644 --- a/src/render/frontend/qabstractfunctor.cpp +++ b/src/render/frontend/qabstractfunctor.cpp @@ -72,7 +72,8 @@ namespace Qt3DRender { This method is used to cast functor \a other to type T if the other is of type T (or of subclass); otherwise returns 0. This method works similarly - to \l QObject::qobject_cast, except with functors derived from QAbstractFunctor. + to \l [QtCore] {qobject_cast(const QObject *object)}{qobject_cast()}, + except with functors derived from QAbstractFunctor. \warning If T was not declared with \l QT3D_FUNCTOR macro, then the results are undefined. */ diff --git a/src/render/frontend/qcamera.cpp b/src/render/frontend/qcamera.cpp index 73ec2c71f..274b555f6 100644 --- a/src/render/frontend/qcamera.cpp +++ b/src/render/frontend/qcamera.cpp @@ -735,11 +735,11 @@ void QCamera::viewSphere(const QVector3D ¢er, float radius) } /*! - * Rotates and moves the camera so that it's viewCenter is the center of the entity's bounding volume - * and the entire entity fits in the view port. + * Rotates and moves the camera so that it's viewCenter is the center of the + * \a {entity}'s bounding volume and the entire entity fits in the view port. * * \note Only works if the lens is in perspective projection mode. - * \sa Qt3D.Render::Camera::projectionType + * \sa {Qt3D.Render::Camera::projectionType}{Camera.projectionType} */ void QCamera::viewEntity(Qt3DCore::QEntity *entity) { diff --git a/src/render/frontend/qpickingsettings.cpp b/src/render/frontend/qpickingsettings.cpp index 5a49cd182..66d3fc912 100644 --- a/src/render/frontend/qpickingsettings.cpp +++ b/src/render/frontend/qpickingsettings.cpp @@ -61,7 +61,7 @@ namespace Qt3DRender { In both cases, a ray will be cast through the scene to find geometry intersecting the ray. - \sa QObjectPicker, QPickEvent, QPickTriangleEvent, QRayCaster, QScreenRayCaster. + \sa QObjectPicker, QPickEvent, QPickTriangleEvent, QRayCaster, QScreenRayCaster */ /*! @@ -151,7 +151,7 @@ float QPickingSettings::worldSpaceTolerance() const * any edge of the entity's mesh component. * \value PointPicking An entity is considered picked if the picking ray intersects with * any point of the entity's mesh component. - * \value PrimitePicking An entity is considered picked if the picking ray intersects with + * \value PrimitivePicking An entity is considered picked if the picking ray intersects with * any point, edge or triangle of the entity's mesh component. */ @@ -285,7 +285,7 @@ void QPickingSettings::setFaceOrientationPickingMode(QPickingSettings::FaceOrien Holds the threshold, in model space coordinates, used to evaluate line and point picking. */ /*! - * Set the threshold used for line and point picking + * Sets the threshold used for line and point picking to \a worldSpaceTolerance. */ void QPickingSettings::setWorldSpaceTolerance(float worldSpaceTolerance) { diff --git a/src/render/materialsystem/qgraphicsapifilter.cpp b/src/render/materialsystem/qgraphicsapifilter.cpp index a94018360..65ad77d28 100644 --- a/src/render/materialsystem/qgraphicsapifilter.cpp +++ b/src/render/materialsystem/qgraphicsapifilter.cpp @@ -141,6 +141,8 @@ QGraphicsApiFilter::~QGraphicsApiFilter() \value OpenGLES QSurfaceFormat::OpenGLES \value OpenGL QSurfaceFormat::OpenGL + \value Vulkan Vulkan + \value DirectX DirectX */ diff --git a/src/render/picking/qabstractraycaster.cpp b/src/render/picking/qabstractraycaster.cpp index 804a7e7fb..4d7a77765 100644 --- a/src/render/picking/qabstractraycaster.cpp +++ b/src/render/picking/qabstractraycaster.cpp @@ -111,9 +111,9 @@ void QAbstractRayCasterPrivate::dispatchHits(const QAbstractRayCaster::Hits &hit Furthermore, Qt3DRender::QLayer components can be used to control how entities, or entity sub-graphs, react to ray casting. - Note: components derived from QAbstractRayCaster should not be shared amount multiple entities. + \note Components derived from QAbstractRayCaster should not be shared amount multiple entities. - \sa Qt3DRender::QRayCaster, Qt3DRender::QScreenRayCaster, Qt3DRender::QObjectPicker, Qt3DRender::QPickSettings + \sa Qt3DRender::QRayCaster, Qt3DRender::QScreenRayCaster, Qt3DRender::QObjectPicker, Qt3DRender::QPickingSettings */ /*! \qmltype AbstractRayCaster @@ -144,7 +144,7 @@ void QAbstractRayCasterPrivate::dispatchHits(const QAbstractRayCaster::Hits &hit Note: components derived from AbstractRayCaster should not be shared amount multiple entities. - \sa Qt3D.Render::RayCaster, Qt3D.Render::ScreenRayCaster, Qt3D.Render::ObjectPicker, Qt3D.Render::PickSettings + \sa Qt3D.Render::RayCaster, Qt3D.Render::ScreenRayCaster, Qt3D.Render::ObjectPicker, Qt3D.Render::PickingSettings */ /*! diff --git a/src/render/picking/qraycaster.cpp b/src/render/picking/qraycaster.cpp index cbc536d46..cfe5bce1b 100644 --- a/src/render/picking/qraycaster.cpp +++ b/src/render/picking/qraycaster.cpp @@ -82,34 +82,36 @@ namespace Qt3DRender { */ /*! - \property QVector3D origin + \property Qt3DRender::QRayCaster::origin - Holds the origin of the 3d ray in local coordinates. + Holds the origin of the 3D ray in local coordinates. */ /*! - \qmlproperty Vector3D origin + \qmlproperty vector3d Qt3D.Render::RayCaster::origin - Holds the origin of the 3d ray in local coordinates. + Holds the origin of the 3D ray in local coordinates. */ /*! - \property QVector3D direction + \property Qt3DRender::QRayCaster::direction - Holds the direction of the 3d ray. This should be a unit vector. + Holds the direction of the 3D ray. This should be a unit vector. */ + /*! - \qmlproperty Vector3D direction + \qmlproperty vector3D Qt3D.Render::RayCaster::direction - Holds the direction of the 3d ray. This should be a unit vector. + Holds the direction of the 3D ray. This should be a unit vector. */ /*! - \property float length + \property Qt3DRender::QRayCaster::length - Holds the length of the 3d ray. + Holds the length of the 3D ray. */ + /*! - \qmlproperty real direction + \qmlproperty real Qt3D.Render::RayCaster::length Holds the length of the 3d ray. */ @@ -169,7 +171,7 @@ float QRayCaster::length() const } /*! - * \brief Set the length of the ray to \a length + * \brief Sets the length of the ray to \a length. * * If the value is less than or equal to zero, the ray is concidered to be infinite. */ @@ -183,7 +185,7 @@ void QRayCaster::setLength(float length) } /*! - * Convenience method to enable the component and trigger tests using the current ray + * Convenience method to enable the component and trigger tests using the current ray. */ void QRayCaster::trigger() { @@ -191,7 +193,8 @@ void QRayCaster::trigger() } /*! - * Convenience method to set the ray details and enable the component to trigger tests + * Convenience method to set the ray details \a origin, \a direction, and \a length, + * and enable the component to trigger tests. */ void QRayCaster::trigger(const QVector3D &origin, const QVector3D &direction, float length) { diff --git a/src/render/picking/qscreenraycaster.cpp b/src/render/picking/qscreenraycaster.cpp index 5850353f3..99c3015f5 100644 --- a/src/render/picking/qscreenraycaster.cpp +++ b/src/render/picking/qscreenraycaster.cpp @@ -56,7 +56,7 @@ namespace Qt3DRender { \inherits QAbstractRayCaster QScreenRayCaster can be used to perform ray casting tests by specifying coordinates in - screen space, which will be used to construct an actual 3d ray between the near and + screen space, which will be used to construct an actual 3D ray between the near and far planes. \sa QRayCaster @@ -69,29 +69,28 @@ namespace Qt3DRender { \instantiates Qt3DRender::QScreenRayCaster ScreenRayCaster can be used to perform ray casting tests by specifying coordinates in - screen space, which will be used to construct an actual 3d ray between the near and + screen space, which will be used to construct an actual 3D ray between the near and far planes. \sa RayCaster */ /*! - \property QPoint position + \property Qt3DRender::QScreenRayCaster::position - Holds the screen space position used to compute the actual 3d ray for intersection tests. + Holds the screen space position used to compute the actual 3D ray for intersection tests. Note: the coordinates will be used for every available render surface as long as they are in the valid range. */ /*! - \qmlproperty Point2D position + \qmlproperty point Qt3D.Render::ScreenRayCaster::position - Holds the length of the 3d ray. + Holds the length of the 3D ray. - Note: the coordinates will be used for every available render surface as long as they are + \note The coordinates will be used for every available render surface as long as they are in the valid range. */ - QScreenRayCaster::QScreenRayCaster(Qt3DCore::QNode *parent) : QAbstractRayCaster(parent) { @@ -126,7 +125,7 @@ void QScreenRayCaster::setPosition(const QPoint &position) } /*! - Convenience method to enable the component and trigger tests using the current coordinate value + Convenience method to enable the component and trigger tests using the current coordinate value. */ void QScreenRayCaster::trigger() { @@ -134,7 +133,7 @@ void QScreenRayCaster::trigger() } /*! - Convenience method to set the coordinate value and enable the component to trigger tests + Convenience method to set the coordinate value \a position and enable the component to trigger tests. */ void QScreenRayCaster::trigger(const QPoint &position) { diff --git a/src/render/raycasting/qray3d.cpp b/src/render/raycasting/qray3d.cpp index 6d8469aa1..d8ad25b50 100644 --- a/src/render/raycasting/qray3d.cpp +++ b/src/render/raycasting/qray3d.cpp @@ -47,6 +47,11 @@ namespace Qt3DRender { namespace RayCasting { /*! + \namespace Qt3DRender::RayCasting + \internal +*/ + +/*! \internal \class Qt3DRender::RayCasting::QRay3D \inmodule Qt3DRender @@ -83,7 +88,7 @@ QRay3D::QRay3D() } /*! - \fn Qt3DRender::RayCasting::QRay3D::QRay3D(const QVector3D &origin, const QVector3D &direction, float distance) + \fn Qt3DRender::RayCasting::QRay3D::QRay3D(const Vector3D &origin, const Vector3D &direction, float distance) Construct a ray given its defining \a origin, \a direction and \a distance. The \a direction does not need to be normalized. @@ -117,7 +122,7 @@ Vector3D QRay3D::origin() const } /*! - \fn void Qt3DRender::RayCasting::QRay3D::setOrigin(const QVector3D &value) + \fn void Qt3DRender::RayCasting::QRay3D::setOrigin(const Vector3D &value) Sets the origin point of this ray to \a value. @@ -141,7 +146,7 @@ Vector3D QRay3D::direction() const } /*! - \fn void Qt3DRender::RayCasting::QRay3D::setDirection(const QVector3D &direction) + \fn void Qt3DRender::RayCasting::QRay3D::setDirection(const Vector3D &direction) Sets the direction vector of this ray to \a direction. @@ -194,7 +199,7 @@ bool QRay3D::operator!=(const QRay3D &other) const } /*! - Returns true if \a point lies on this ray; false otherwise. + Returns \c true if \a point lies on this ray; \c false otherwise. */ bool QRay3D::contains(const Vector3D &point) const { @@ -208,7 +213,7 @@ bool QRay3D::contains(const Vector3D &point) const } /*! - Returns true if \a ray lies on this ray; false otherwise. If true, + Returns \c true if \a ray lies on this ray; \c false otherwise. If true, this implies that the two rays are actually the same, but with different origin() points or an inverted direction(). */ @@ -285,7 +290,7 @@ float QRay3D::distance(const Vector3D &point) const } /*! - \fn Qt3DRender::RayCasting::QRay3D &Qt3DRender::RayCasting::QRay3D::transform(const QMatrix4x4 &matrix) + \fn Qt3DRender::RayCasting::QRay3D &Qt3DRender::RayCasting::QRay3D::transform(const Matrix4x4 &matrix) Transforms this ray using \a matrix, replacing origin() and direction() with the transformed versions. @@ -294,7 +299,7 @@ float QRay3D::distance(const Vector3D &point) const */ /*! - \fn Qt3DRender::RayCasting::QRay3D Qt3DRender::RayCasting::QRay3D::transformed(const QMatrix4x4 &matrix) const + \fn Qt3DRender::RayCasting::QRay3D Qt3DRender::RayCasting::QRay3D::transformed(const Matrix4x4 &matrix) const Returns a new ray that is formed by transforming origin() and direction() using \a matrix. @@ -344,7 +349,7 @@ QDebug operator<<(QDebug dbg, const QRay3D &ray) #ifndef QT_NO_DATASTREAM /*! - \relates Qt3DRender::QRay3D + \relates Qt3DRender::RayCasting::QRay3D Writes the given \a ray to the given \a stream and returns a reference to the stream. @@ -359,7 +364,7 @@ QDataStream &operator<<(QDataStream &stream, const QRay3D &ray) } /*! - \relates Qt3DRender::QRay3D + \relates Qt3DRender::RayCasting::QRay3D Reads a 3D ray from the given \a stream into the given \a ray and returns a reference to the stream. diff --git a/src/render/renderstates/qrenderstatecreatedchange.cpp b/src/render/renderstates/qrenderstatecreatedchange.cpp index 666543c39..02989a29e 100644 --- a/src/render/renderstates/qrenderstatecreatedchange.cpp +++ b/src/render/renderstates/qrenderstatecreatedchange.cpp @@ -64,7 +64,7 @@ public: Render::StateMask m_type; }; -/*! +/* * The constructor creates a new QRenderStateCreatedChangeBase::QRenderStateCreatedChangeBase * instance with the specified \a renderState. */ @@ -73,8 +73,8 @@ QRenderStateCreatedChangeBase::QRenderStateCreatedChangeBase(const QRenderState { } -/*! - * \return the current render state type +/* + * Returns the current render state type. */ Render::StateMask QRenderStateCreatedChangeBase::renderStateType() const { |