diff options
Diffstat (limited to 'src/core')
25 files changed, 32 insertions, 32 deletions
diff --git a/src/core/changes/qcomponentaddedchange.cpp b/src/core/changes/qcomponentaddedchange.cpp index 41f7a2340..50d7fd237 100644 --- a/src/core/changes/qcomponentaddedchange.cpp +++ b/src/core/changes/qcomponentaddedchange.cpp @@ -63,7 +63,7 @@ QComponentAddedChangePrivate::QComponentAddedChangePrivate(const QEntity *entity * \inheaderfile Qt3DCore/QComponentAddedChange * \inherits Qt3DCore::QSceneChange * \inmodule Qt3DCore - * \brief The QComponentAddedChange class is used to notify when a component is added to an entity + * \brief The QComponentAddedChange class is used to notify when a component is added to an entity. * */ diff --git a/src/core/changes/qcomponentremovedchange.cpp b/src/core/changes/qcomponentremovedchange.cpp index e2129169a..f338f11af 100644 --- a/src/core/changes/qcomponentremovedchange.cpp +++ b/src/core/changes/qcomponentremovedchange.cpp @@ -63,7 +63,7 @@ QComponentRemovedChangePrivate::QComponentRemovedChangePrivate(const QEntity *en * \inheaderfile Qt3DCore/QComponentRemovedChange * \inherits Qt3DCore::QSceneChange * \inmodule Qt3DCore - * \brief The QComponentRemovedChange class is used to notify when a component is removed from an entity + * \brief The QComponentRemovedChange class is used to notify when a component is removed from an entity. * */ diff --git a/src/core/changes/qdynamicpropertyupdatedchange.cpp b/src/core/changes/qdynamicpropertyupdatedchange.cpp index fd174097c..30e541a0d 100644 --- a/src/core/changes/qdynamicpropertyupdatedchange.cpp +++ b/src/core/changes/qdynamicpropertyupdatedchange.cpp @@ -58,7 +58,7 @@ QDynamicPropertyUpdatedChangePrivate::~QDynamicPropertyUpdatedChangePrivate() * \inheaderfile Qt3DCore/QDynamicPropertyUpdatedChange * \inherits Qt3DCore::QPropertyUpdatedChangeBase * \inmodule Qt3DCore - * \brief The QDynamicPropertyUpdatedChange class is used to notify when a dynamic property value is updated + * \brief The QDynamicPropertyUpdatedChange class is used to notify when a dynamic property value is updated. * */ diff --git a/src/core/changes/qnodecommand.cpp b/src/core/changes/qnodecommand.cpp index 2be939624..0836da6e7 100644 --- a/src/core/changes/qnodecommand.cpp +++ b/src/core/changes/qnodecommand.cpp @@ -66,7 +66,7 @@ QNodeCommand::CommandId QNodeCommandPrivate::createId() * \inherits Qt3DCore::QSceneChange * \inmodule Qt3DCore * \since 5.10 - * \brief The QNodeCommand class is the base class for all CommandRequested QSceneChange events + * \brief The QNodeCommand class is the base class for all CommandRequested QSceneChange events. * * The QNodeCommand class is the base class for all QSceneChange events that * have the changeType() CommandRequested. diff --git a/src/core/changes/qnodecreatedchange.cpp b/src/core/changes/qnodecreatedchange.cpp index 34ca939d7..a14e8b7fd 100644 --- a/src/core/changes/qnodecreatedchange.cpp +++ b/src/core/changes/qnodecreatedchange.cpp @@ -58,7 +58,7 @@ QNodeCreatedChangeBasePrivate::QNodeCreatedChangeBasePrivate(const QNode *node) * \inheaderfile Qt3DCore/QNodeCreatedChangeBase * \inherits Qt3DCore::QSceneChange * \inmodule Qt3DCore - * \brief The QNodeCreatedChangeBase class is the base class for all NodeCreated QSceneChange events + * \brief The QNodeCreatedChangeBase class is the base class for all NodeCreated QSceneChange events. * * The QNodeCreatedChangeBase class is the base class for all QSceneChange events that * have the changeType() NodeCreated. You should not need to instantiate this class. diff --git a/src/core/changes/qpropertynodeaddedchange.cpp b/src/core/changes/qpropertynodeaddedchange.cpp index 90343493a..865de2731 100644 --- a/src/core/changes/qpropertynodeaddedchange.cpp +++ b/src/core/changes/qpropertynodeaddedchange.cpp @@ -57,7 +57,7 @@ QPropertyNodeAddedChangePrivate::QPropertyNodeAddedChangePrivate() * \inheaderfile Qt3DCore/QPropertyNodeAddedChange * \inherits Qt3DCore::QStaticPropertyValueAddedChangeBase * \inmodule Qt3DCore - * \brief Used to notify when a node is added to a property + * \brief Used to notify when a node is added to a property. * */ diff --git a/src/core/changes/qpropertynoderemovedchange.cpp b/src/core/changes/qpropertynoderemovedchange.cpp index a0f342d0b..d19629c37 100644 --- a/src/core/changes/qpropertynoderemovedchange.cpp +++ b/src/core/changes/qpropertynoderemovedchange.cpp @@ -58,7 +58,7 @@ QPropertyNodeRemovedChangePrivate::QPropertyNodeRemovedChangePrivate() * \inheaderfile Qt3DCore/QPropertyNodeRemovedChange * \inherits Qt3DCore::QStaticPropertyValueRemovedChangeBase * \inmodule Qt3DCore - * \brief The QPropertyNodeRemovedChange class is used to notify when a node is removed from a property + * \brief The QPropertyNodeRemovedChange class is used to notify when a node is removed from a property. * */ diff --git a/src/core/changes/qpropertyupdatedchange.cpp b/src/core/changes/qpropertyupdatedchange.cpp index c6025efbc..6b9352dfa 100644 --- a/src/core/changes/qpropertyupdatedchange.cpp +++ b/src/core/changes/qpropertyupdatedchange.cpp @@ -58,7 +58,7 @@ QPropertyUpdatedChangePrivate::~QPropertyUpdatedChangePrivate() * \inheaderfile Qt3DCore/QPropertyUpdatedChange * \inherits Qt3DCore::QStaticPropertyUpdatedChangeBase * \inmodule Qt3DCore - * \brief The QPropertyUpdatedChange class is used to notify when a property value is updated + * \brief The QPropertyUpdatedChange class is used to notify when a property value is updated. * */ diff --git a/src/core/changes/qpropertyupdatedchangebase.cpp b/src/core/changes/qpropertyupdatedchangebase.cpp index 5d79b9049..3080fb647 100644 --- a/src/core/changes/qpropertyupdatedchangebase.cpp +++ b/src/core/changes/qpropertyupdatedchangebase.cpp @@ -63,7 +63,7 @@ QPropertyUpdatedChangeBasePrivate *QPropertyUpdatedChangeBasePrivate::get(QPrope * \class Qt3DCore::QPropertyUpdatedChangeBase * \inheaderfile Qt3DCore/QPropertyUpdatedChangeBase * \inmodule Qt3DCore - * \brief The QPropertyUpdatedChangeBase class is the base class for all PropertyUpdated QSceneChange events + * \brief The QPropertyUpdatedChangeBase class is the base class for all PropertyUpdated QSceneChange events. * * The QPropertyUpdatedChangeBase class is the base class for all QSceneChange events that * have the changeType() PropertyUpdated. You should not need to instantiate this class. diff --git a/src/core/changes/qpropertyvalueaddedchange.cpp b/src/core/changes/qpropertyvalueaddedchange.cpp index b7438fcbe..28d912632 100644 --- a/src/core/changes/qpropertyvalueaddedchange.cpp +++ b/src/core/changes/qpropertyvalueaddedchange.cpp @@ -55,7 +55,7 @@ QPropertyValueAddedChangePrivate::QPropertyValueAddedChangePrivate() * \inheaderfile Qt3DCore/QPropertyValueAddedChange * \inherits Qt3DCore::QStaticPropertyValueAddedChangeBase * \inmodule Qt3DCore - * \brief Used to notify when a value is added to a property + * \brief Used to notify when a value is added to a property. * */ diff --git a/src/core/changes/qpropertyvalueaddedchangebase.cpp b/src/core/changes/qpropertyvalueaddedchangebase.cpp index 3c9929496..aea5e1fd4 100644 --- a/src/core/changes/qpropertyvalueaddedchangebase.cpp +++ b/src/core/changes/qpropertyvalueaddedchangebase.cpp @@ -58,7 +58,7 @@ QPropertyValueAddedChangeBasePrivate::~QPropertyValueAddedChangeBasePrivate() * \class Qt3DCore::QPropertyValueAddedChangeBase * \inheaderfile Qt3DCore/QPropertyValueAddedChangeBase * \inmodule Qt3DCore - * \brief The QPropertyValueAddedChangeBase class is the base class for all PropertyValueAdded QSceneChange events + * \brief The QPropertyValueAddedChangeBase class is the base class for all PropertyValueAdded QSceneChange events. * * The QPropertyValueAddedChangeBase class is the base class for all QSceneChange events that * have the changeType() PropertyValueAdded. You should not need to instantiate this class. diff --git a/src/core/changes/qpropertyvalueremovedchange.cpp b/src/core/changes/qpropertyvalueremovedchange.cpp index 9d420abc0..89cf5620f 100644 --- a/src/core/changes/qpropertyvalueremovedchange.cpp +++ b/src/core/changes/qpropertyvalueremovedchange.cpp @@ -56,7 +56,7 @@ QPropertyValueRemovedChangePrivate::QPropertyValueRemovedChangePrivate() * \inheaderfile Qt3DCore/QPropertyValueRemovedChange * \inherits Qt3DCore::QStaticPropertyValueRemovedChangeBase * \inmodule Qt3DCore - * \brief Used to notify when a value is added to a property + * \brief Used to notify when a value is added to a property. * */ diff --git a/src/core/changes/qpropertyvalueremovedchangebase.cpp b/src/core/changes/qpropertyvalueremovedchangebase.cpp index 71213019c..16d3c5946 100644 --- a/src/core/changes/qpropertyvalueremovedchangebase.cpp +++ b/src/core/changes/qpropertyvalueremovedchangebase.cpp @@ -58,7 +58,7 @@ QPropertyValueRemovedChangeBasePrivate::~QPropertyValueRemovedChangeBasePrivate( * \class Qt3DCore::QPropertyValueRemovedChangeBase * \inheaderfile Qt3DCore/QPropertyValueRemovedChangeBase * \inmodule Qt3DCore - * \brief The QPropertyValueRemovedChangeBase class is the base class for all PropertyValueRemoved QSceneChange events + * \brief The QPropertyValueRemovedChangeBase class is the base class for all PropertyValueRemoved QSceneChange events. * * The QPropertyValueRemovedChangeBase class is the base class for all QSceneChange events that * have the changeType() PropertyValueRemoved. You should not need to instantiate this class. diff --git a/src/core/changes/qstaticpropertyupdatedchangebase.cpp b/src/core/changes/qstaticpropertyupdatedchangebase.cpp index d065dbf0b..6aed5a822 100644 --- a/src/core/changes/qstaticpropertyupdatedchangebase.cpp +++ b/src/core/changes/qstaticpropertyupdatedchangebase.cpp @@ -61,7 +61,7 @@ QStaticPropertyUpdatedChangeBasePrivate::~QStaticPropertyUpdatedChangeBasePrivat * \inheaderfile Qt3DCore/QStaticPropertyUpdatedChangeBase * \inmodule Qt3DCore * \since 5.7 - * \brief The QStaticPropertyUpdatedChangeBase class is the base class for all static PropertyUpdated QSceneChange events + * \brief The QStaticPropertyUpdatedChangeBase class is the base class for all static PropertyUpdated QSceneChange events. * */ diff --git a/src/core/changes/qstaticpropertyvalueaddedchangebase.cpp b/src/core/changes/qstaticpropertyvalueaddedchangebase.cpp index efd2c0165..ad2afc699 100644 --- a/src/core/changes/qstaticpropertyvalueaddedchangebase.cpp +++ b/src/core/changes/qstaticpropertyvalueaddedchangebase.cpp @@ -56,7 +56,7 @@ QStaticPropertyValueAddedChangeBasePrivate::QStaticPropertyValueAddedChangeBaseP * \inheaderfile Qt3DCore/QStaticPropertyValueAddedChangeBase * \inmodule Qt3DCore * \since 5.7 - * \brief The QStaticPropertyValueAddedChangeBase class is the base class for all static PropertyValueAdded QSceneChange events + * \brief The QStaticPropertyValueAddedChangeBase class is the base class for all static PropertyValueAdded QSceneChange events. * */ diff --git a/src/core/changes/qstaticpropertyvalueremovedchangebase.cpp b/src/core/changes/qstaticpropertyvalueremovedchangebase.cpp index 622eb6524..2094d5aa2 100644 --- a/src/core/changes/qstaticpropertyvalueremovedchangebase.cpp +++ b/src/core/changes/qstaticpropertyvalueremovedchangebase.cpp @@ -55,7 +55,7 @@ QStaticPropertyValueRemovedChangeBasePrivate::QStaticPropertyValueRemovedChangeB * \inheaderfile Qt3DCore/QStaticPropertyValueRemovedChangeBase * \inmodule Qt3DCore * \since 5.7 - * \brief The QStaticPropertyValueRemovedChangeBase class is the base class for all static PropertyValueRemoved QSceneChange events + * \brief The QStaticPropertyValueRemovedChangeBase class is the base class for all static PropertyValueRemoved QSceneChange events. * */ diff --git a/src/core/jobs/qaspectjob.cpp b/src/core/jobs/qaspectjob.cpp index 7b880cb93..ccb9c3a0e 100644 --- a/src/core/jobs/qaspectjob.cpp +++ b/src/core/jobs/qaspectjob.cpp @@ -73,7 +73,7 @@ QAspectJob::QAspectJob() * \class Qt3DCore::QAspectJob * \inheaderfile Qt3DCore/QAspectJob * \inmodule Qt3DCore - * \brief The base class for jobs executed in an aspect + * \brief The base class for jobs executed in an aspect. */ /*! diff --git a/src/core/nodes/qbackendnode.cpp b/src/core/nodes/qbackendnode.cpp index 00e957165..62ca14b4b 100644 --- a/src/core/nodes/qbackendnode.cpp +++ b/src/core/nodes/qbackendnode.cpp @@ -100,7 +100,7 @@ QBackendNodePrivate *QBackendNodePrivate::get(QBackendNode *n) * \inheaderfile Qt3DCore/QBackendNodeMapper * \inmodule Qt3DCore * - * \brief Creates and maps backend nodes to their respective frontend nodes + * \brief Creates and maps backend nodes to their respective frontend nodes. */ /*! @@ -130,7 +130,7 @@ QBackendNodePrivate *QBackendNodePrivate::get(QBackendNode *n) * \inheaderfile Qt3DCore/QBackendNode * \inmodule Qt3DCore * - * \brief The base class for all Qt3D backend nodes + * \brief The base class for all Qt3D backend nodes. */ /*! diff --git a/src/core/nodes/qnodeid.cpp b/src/core/nodes/qnodeid.cpp index 3e11733e6..ece7a531e 100644 --- a/src/core/nodes/qnodeid.cpp +++ b/src/core/nodes/qnodeid.cpp @@ -47,7 +47,7 @@ namespace Qt3DCore { * \class Qt3DCore::QNodeId * \inheaderfile Qt3DCore/QNodeId * \inmodule Qt3DCore - * \brief Uniquely identifies a QNode + * \brief Uniquely identifies a QNode. */ /*! diff --git a/src/core/transforms/qabstractskeleton.cpp b/src/core/transforms/qabstractskeleton.cpp index d780987ee..1bc7247a7 100644 --- a/src/core/transforms/qabstractskeleton.cpp +++ b/src/core/transforms/qabstractskeleton.cpp @@ -65,7 +65,7 @@ const QAbstractSkeletonPrivate *QAbstractSkeletonPrivate::get(const QAbstractSke \inherits Node \instantiates Qt3DCore::QAbstractSkeleton \since 5.10 - \brief A skeleton contains the joints for a skinned mesh + \brief A skeleton contains the joints for a skinned mesh. Do not use this class directly. You should use SkeletonLoader if loading skeleton data from a file (most likely) or Skeleton if creating the @@ -78,7 +78,7 @@ const QAbstractSkeletonPrivate *QAbstractSkeletonPrivate::get(const QAbstractSke \inmodule Qt3DCore \inherits Qt3DCore::QNode \since 5.10 - \brief A skeleton contains the joints for a skinned mesh + \brief A skeleton contains the joints for a skinned mesh. Do not use this class directly. You should use QSkeletonLoader if loading skeleton data from a file (most likely) or QSkeleton if creating the diff --git a/src/core/transforms/qarmature.cpp b/src/core/transforms/qarmature.cpp index 65a13b262..d9fef7767 100644 --- a/src/core/transforms/qarmature.cpp +++ b/src/core/transforms/qarmature.cpp @@ -57,7 +57,7 @@ QArmaturePrivate::QArmaturePrivate() \inherits Component3D \instantiates Qt3DCore::QArmature \since 5.10 - \brief Used to calculate skinning transform matrices and set them on shaders + \brief Used to calculate skinning transform matrices and set them on shaders. The Armature component is aggregated by entities to give them the ability to calculate the palette of skinning transform matrices needed to properly @@ -86,7 +86,7 @@ QArmaturePrivate::QArmaturePrivate() \inmodule Qt3DCore \inherits Qt3DCore::QComponent \since 5.10 - \brief Used to calculate skinning transform matrices and set them on shaders + \brief Used to calculate skinning transform matrices and set them on shaders. The Armature component is aggregated by entities to give them the ability to calculate the palette of skinning transform matrices needed to properly diff --git a/src/core/transforms/qjoint.cpp b/src/core/transforms/qjoint.cpp index a4f259ce9..c9e672cef 100644 --- a/src/core/transforms/qjoint.cpp +++ b/src/core/transforms/qjoint.cpp @@ -64,7 +64,7 @@ QJointPrivate::QJointPrivate() \inherits Node \instantiates Qt3DCore::QJoint \since 5.10 - \brief Used to transforms parts of skinned meshes + \brief Used to transforms parts of skinned meshes. The Joint node is used to build skeletons as part of the skinned mesh support in Qt 3D. A joint can be transformed by way of its scale, rotation @@ -122,7 +122,7 @@ QJointPrivate::QJointPrivate() \inmodule Qt3DCore \inherits Qt3DCore::QNode \since 5.10 - \brief Used to transforms parts of skinned meshes + \brief Used to transforms parts of skinned meshes. The QJoint node is used to build skeletons as part of the skinned mesh support in Qt 3D. A joint can be transformed by way of its scale, rotation diff --git a/src/core/transforms/qskeleton.cpp b/src/core/transforms/qskeleton.cpp index c58bc0f8c..141d8c0c4 100644 --- a/src/core/transforms/qskeleton.cpp +++ b/src/core/transforms/qskeleton.cpp @@ -59,7 +59,7 @@ QSkeletonPrivate::QSkeletonPrivate() \inherits AbstractSkeleton \instantiates Qt3DCore::QSkeleton \since 5.10 - \brief Holds the data for a skeleton to be used with skinned meshes + \brief Holds the data for a skeleton to be used with skinned meshes. Use Skeleton if you wish to manually create the joints of a skeleton for use with skinned meshes. This is mainly of use to people creating editors, @@ -80,7 +80,7 @@ QSkeletonPrivate::QSkeletonPrivate() \inmodule Qt3DCore \inherits Qt3DCore::QAbstractSkeleton \since 5.10 - \brief Holds the data for a skeleton to be used with skinned meshes + \brief Holds the data for a skeleton to be used with skinned meshes. Use QSkeleton if you wish to manually create the joints of a skeleton for use with skinned meshes. This is mainly of use to people creating editors, diff --git a/src/core/transforms/qskeletonloader.cpp b/src/core/transforms/qskeletonloader.cpp index 9e0fdae5c..00026ecf5 100644 --- a/src/core/transforms/qskeletonloader.cpp +++ b/src/core/transforms/qskeletonloader.cpp @@ -74,7 +74,7 @@ void QSkeletonLoaderPrivate::setStatus(QSkeletonLoader::Status status) \inherits AbstractSkeleton \instantiates Qt3DCore::QSkeletonLoader \since 5.10 - \brief Used to load a skeleton of joints from file + \brief Used to load a skeleton of joints from file. Use SkeletonLoader if you wish to load a whole skeleton from file rather than creating the joints yourself using Skeleton and Joints. Creating a @@ -101,7 +101,7 @@ void QSkeletonLoaderPrivate::setStatus(QSkeletonLoader::Status status) \inmodule Qt3DCore \inherits Qt3DCore::QAbstractSkeleton \since 5.10 - \brief Used to load a skeleton of joints from file + \brief Used to load a skeleton of joints from file. Use SkeletonLoader if you wish to load a whole skeleton from file rather than creating the joints yourself using Skeleton and Joints. Creating a diff --git a/src/core/transforms/qtransform.cpp b/src/core/transforms/qtransform.cpp index 82f665296..d0e2628f7 100644 --- a/src/core/transforms/qtransform.cpp +++ b/src/core/transforms/qtransform.cpp @@ -69,7 +69,7 @@ QTransformPrivate::~QTransformPrivate() \inherits Component3D \instantiates Qt3DCore::QTransform \since 5.6 - \brief Used to perform transforms on meshes + \brief Used to perform transforms on meshes. The Transform component is not shareable between multiple Entity's. The transformation is held as vector3d scale, quaternion rotation and @@ -184,7 +184,7 @@ QTransformPrivate::~QTransformPrivate() \inmodule Qt3DCore \inherits Qt3DCore::QComponent \since 5.6 - \brief Used to perform transforms on meshes + \brief Used to perform transforms on meshes. The QTransform component is not shareable between multiple QEntity's. The transformation is held as QVector3D scale, QQuaternion rotation and |