diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-04-13 12:55:34 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-04-14 07:41:11 +0000 |
| commit | f03dc3a2599a0f05cded8b984489b89113c7f037 (patch) | |
| tree | 306902e9865550448dcf035ffa18c0be45834e62 | |
| parent | 075c0298d1c75dd2d61849b559edcb357d638689 (diff) | |
Doc: Fix multiple C++ documentation issues
- Remove multiple \namespace commands for namespace Qt3D. QDoc in 5.5
is now able to collate namespace members from multiple modules.
- Mark 'Q...Private' classes and functions taking private arguments as
\internal
- Use correct \qtvariable for Qt 3D Core and Render
- Add src/plugins directory to Qt 3D Core documentation build to
correctly generate Assimp-related documentation.
- Ensure documentation for C++ properties is visible by
using the \property command instead of documenting the
setter/getter functions.
- Add export and logging macros to qdoc ignore directives
- Remove unnecessary use of \fn command
- Language and styling fixes
Change-Id: I2481fa30ad2f6869b85c038c20ff1730b8522d46
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
92 files changed, 771 insertions, 402 deletions
diff --git a/src/core/aspects/qabstractaspect.cpp b/src/core/aspects/qabstractaspect.cpp index 1de4069e4..0330ccb8d 100644 --- a/src/core/aspects/qabstractaspect.cpp +++ b/src/core/aspects/qabstractaspect.cpp @@ -52,6 +52,10 @@ static QByteArray className(const QMetaObject &obj) namespace Qt3D { +/*! + \class Qt3D::QAbstractAspectPrivate + \internal +*/ QAbstractAspectPrivate::QAbstractAspectPrivate(QAbstractAspect *qq) : QObjectPrivate() , m_root(Q_NULLPTR) @@ -79,6 +83,7 @@ QAbstractAspect::QAbstractAspect(AspectType aspectType, QObject *parent) d->m_aspectType = aspectType; } +/*! \internal */ QAbstractAspect::QAbstractAspect(QAbstractAspectPrivate &dd, QObject *parent) : QObject(dd, parent) { diff --git a/src/core/aspects/qaspectengine.cpp b/src/core/aspects/qaspectengine.cpp index 1c16c4bf4..82b06866a 100644 --- a/src/core/aspects/qaspectengine.cpp +++ b/src/core/aspects/qaspectengine.cpp @@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAspectEnginePrivate + \internal +*/ QAspectEnginePrivate::QAspectEnginePrivate(QAspectEngine *qq) : QObjectPrivate() , m_postman(new QPostman()) @@ -81,6 +85,7 @@ QAspectEngine::QAspectEngine(QObject *parent) d->m_aspectThread->waitForStart(QThread::HighestPriority); } +/*! \internal */ QAspectEngine::QAspectEngine(QAspectEnginePrivate &dd, QObject *parent) : QObject(dd, parent) { diff --git a/src/core/aspects/qaspectfactory.cpp b/src/core/aspects/qaspectfactory.cpp index 9c049c66c..04e902acf 100644 --- a/src/core/aspects/qaspectfactory.cpp +++ b/src/core/aspects/qaspectfactory.cpp @@ -54,6 +54,10 @@ QT3DCORESHARED_EXPORT void qt3d_QAspectFactoryPrivate_addDefaultFactory(const QS defaultFactories->insert(name, factory); } +/*! + \class Qt3D::QAspectFactoryPrivate + \internal +*/ QAspectFactoryPrivate::QAspectFactoryPrivate() : m_factories(*defaultFactories) { diff --git a/src/core/core-components/qcamera.cpp b/src/core/core-components/qcamera.cpp index 6ca15a7bc..6fc43273a 100644 --- a/src/core/core-components/qcamera.cpp +++ b/src/core/core-components/qcamera.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QCameraPrivate + \internal +*/ QCameraPrivate::QCameraPrivate(QCamera *qq) : QEntityPrivate(qq) , m_lens(new QCameraLens()) @@ -70,6 +74,7 @@ QCamera::QCamera(QNode *parent) : addComponent(d_func()->m_transform); } +/*! \internal */ QCamera::QCamera(QCameraPrivate &dd, QNode *parent) : QEntity(dd, parent) { diff --git a/src/core/core-components/qcameralens.cpp b/src/core/core-components/qcameralens.cpp index d299a5096..0d5f6ea49 100644 --- a/src/core/core-components/qcameralens.cpp +++ b/src/core/core-components/qcameralens.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QCameraLensPrivate + \internal +*/ QCameraLensPrivate::QCameraLensPrivate(QCameraLens *qq) : QComponentPrivate(qq) , m_projectionType(QCameraLens::OrthogonalProjection) @@ -79,6 +83,7 @@ void QCameraLens::copy(const QNode *ref) d_func()->m_projectionMatrix = lens->d_func()->m_projectionMatrix; } +/*! \internal */ QCameraLens::QCameraLens(QCameraLensPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf index a1a90a31b..02907b173 100644 --- a/src/core/doc/qt3dcore.qdocconf +++ b/src/core/doc/qt3dcore.qdocconf @@ -28,13 +28,20 @@ tagfile = ../../../doc/qt3dcore/qt3dcore.tags depends += qtcore qtqml qtquick qtdoc qt3drender -headerdirs += .. -sourcedirs += .. +headerdirs += .. \ + ../../plugins +sourcedirs += .. \ + ../../plugins exampledirs += src/snippets #excludedirs += imagedirs += images +Cpp.ignoretokens += QT3DCORE_PRIVATE_EXPORT \ + QT3DCORESHARED_EXPORT + +Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY + navigation.landingpage = "Qt3D Core" navigation.cppclassespage = "Qt3D Core C++ Classes" diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3dcore-module.qdoc index 20cef4e80..453152d85 100644 --- a/src/core/doc/src/qt3dcore-module.qdoc +++ b/src/core/doc/src/qt3dcore-module.qdoc @@ -40,7 +40,7 @@ \brief The Qt3D Core module contains functionality to support near-realtime simulation systems. \ingroup modules - \qtvariable qt3dcore + \qtvariable 3dcore The Qt3D Core module provides the foundations and core types used for near-realtime simulations built on the Qt3D framework. @@ -50,6 +50,7 @@ \namespace Qt3D \inmodule Qt3DCore - The Qt3D namespace contains classes and types that are in the foundation of the Qt3D simulation + \brief Contains classes and types that are the foundation of the Qt3D simulation + framework, as well as classes that provide the ability to render using the Qt3D framework. */ diff --git a/src/core/io/qabstractattribute.cpp b/src/core/io/qabstractattribute.cpp index c18961a63..1dcd72c69 100644 --- a/src/core/io/qabstractattribute.cpp +++ b/src/core/io/qabstractattribute.cpp @@ -42,11 +42,16 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAbstractAttributePrivate + \internal +*/ QAbstractAttributePrivate::QAbstractAttributePrivate(QAbstractAttribute *qq) : q_ptr(qq) { } +/*! \internal */ QAbstractAttribute::QAbstractAttribute(QAbstractAttributePrivate &dd, QAbstractBufferPtr buf, int type, uint count, uint offset, uint stride) : d_ptr(&dd) { diff --git a/src/core/io/qabstractbuffer.cpp b/src/core/io/qabstractbuffer.cpp index b162549e9..afef0d108 100644 --- a/src/core/io/qabstractbuffer.cpp +++ b/src/core/io/qabstractbuffer.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAbstractBufferPrivate + \internal +*/ QAbstractBufferPrivate::QAbstractBufferPrivate(QAbstractBuffer *qq) : q_ptr(qq) { @@ -55,6 +59,7 @@ QAbstractBuffer::~QAbstractBuffer() { } +/*! \internal */ QAbstractBuffer::QAbstractBuffer(QAbstractBufferPrivate &dd) : d_ptr(&dd) { diff --git a/src/core/jobs/qabstractaspectjobmanager.cpp b/src/core/jobs/qabstractaspectjobmanager.cpp index 393c36897..bfd9e1638 100644 --- a/src/core/jobs/qabstractaspectjobmanager.cpp +++ b/src/core/jobs/qabstractaspectjobmanager.cpp @@ -41,11 +41,16 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAbstractAspectJobManagerPrivate + \internal +*/ QAbstractAspectJobManager::QAbstractAspectJobManager(QObject *parent) : QObject(*new QAbstractAspectJobManagerPrivate, parent) { } +/*! \internal */ QAbstractAspectJobManager::QAbstractAspectJobManager(QAbstractAspectJobManagerPrivate &dd, QObject *parent) : QObject(dd, parent) { diff --git a/src/core/jobs/qaspectjob.cpp b/src/core/jobs/qaspectjob.cpp index e2f9eff6f..5442c5b88 100644 --- a/src/core/jobs/qaspectjob.cpp +++ b/src/core/jobs/qaspectjob.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAspectJobPrivate + \internal +*/ QAspectJobPrivate::QAspectJobPrivate(QAspectJob *qq) : q_ptr(qq) { @@ -51,6 +55,7 @@ QAspectJob::QAspectJob() { } +/*! \internal */ QAspectJob::QAspectJob(QAspectJobPrivate &dd) : d_ptr(&dd) { diff --git a/src/core/jobs/qaspectjobmanager.cpp b/src/core/jobs/qaspectjobmanager.cpp index 1ad7e8116..f959bee18 100644 --- a/src/core/jobs/qaspectjobmanager.cpp +++ b/src/core/jobs/qaspectjobmanager.cpp @@ -99,6 +99,10 @@ void SynchronizedJob::run(ThreadWeaver::JobPointer self, ThreadWeaver::Thread *t } // anonymous #endif +/*! + \class Qt3D::QAspectJobManagerPrivate + \internal +*/ QAspectJobManagerPrivate::QAspectJobManagerPrivate(QAspectJobManager *qq) : QAbstractAspectJobManagerPrivate() , q_ptr(qq) @@ -124,6 +128,7 @@ QAspectJobManager::QAspectJobManager(QObject *parent) #endif } +/*! \internal */ QAspectJobManager::QAspectJobManager(QAspectJobManagerPrivate &dd, QObject *parent) : QAbstractAspectJobManager(dd, parent) { diff --git a/src/core/jobs/qthreadpooler.cpp b/src/core/jobs/qthreadpooler.cpp index e187e8bff..b48cc5aad 100644 --- a/src/core/jobs/qthreadpooler.cpp +++ b/src/core/jobs/qthreadpooler.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QThreadPoolerPrivate + \internal +*/ QThreadPoolerPrivate::QThreadPoolerPrivate(QThreadPooler *qq) : QObjectPrivate(), m_mutex(new QMutex(QMutex::NonRecursive)), diff --git a/src/core/nodes/qbackendnode.cpp b/src/core/nodes/qbackendnode.cpp index f1d926305..df7662f1f 100644 --- a/src/core/nodes/qbackendnode.cpp +++ b/src/core/nodes/qbackendnode.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QBackendNodePrivate + \internal +*/ QBackendNodePrivate::QBackendNodePrivate(QBackendNode *qq, QBackendNode::Mode mode) : q_ptr(qq) , m_mode(mode) @@ -123,6 +127,7 @@ QBackendNode *QBackendNode::createBackendNode(QNode *frontend) const return d->m_factory->createBackendNode(frontend); } +/*! \internal */ QBackendNode::QBackendNode(QBackendNodePrivate &dd) : d_ptr(&dd) { diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp index 2827db9f9..d3ed84c22 100644 --- a/src/core/nodes/qcomponent.cpp +++ b/src/core/nodes/qcomponent.cpp @@ -45,6 +45,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QComponentPrivate + \internal +*/ QComponentPrivate::QComponentPrivate(QComponent *qq) : QNodePrivate(qq) , m_shareable(true) @@ -163,6 +167,7 @@ QVector<QEntity *> QComponent::entities() const return d->m_entities; } +/*! \internal */ QComponent::QComponent(QComponentPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/core/nodes/qentity.cpp b/src/core/nodes/qentity.cpp index 0e8c596d0..cd33fe442 100644 --- a/src/core/nodes/qentity.cpp +++ b/src/core/nodes/qentity.cpp @@ -51,6 +51,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QEntityPrivate + \internal +*/ QEntityPrivate::QEntityPrivate(QEntity *qq) : QNodePrivate(qq) , m_enabled(true) @@ -71,6 +75,7 @@ QEntity::~QEntity() removeAllComponents(); } +/*! \internal */ QEntity::QEntity(QEntityPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp index c9b780dd7..a7cbf96ce 100644 --- a/src/core/nodes/qnode.cpp +++ b/src/core/nodes/qnode.cpp @@ -54,6 +54,10 @@ namespace Qt3D { QHash<QNodeId, QNode *> QNodePrivate::m_clonesLookupTable = QHash<QNodeId, QNode *>(); +/*! + \class Qt3D::QNodePrivate + \internal +*/ QNodePrivate::QNodePrivate(QNode *qq) : QObjectPrivate() , m_changeArbiter(Q_NULLPTR) @@ -291,6 +295,7 @@ QNode::QNode(QNode *parent) // to add ourselve with the parent } +/*! \internal */ QNode::QNode(QNodePrivate &dd, QNode *parent) : QObject(dd, parent) { diff --git a/src/core/qbackendscenepropertychange.cpp b/src/core/qbackendscenepropertychange.cpp index 7d33414f7..b0ed2ea40 100644 --- a/src/core/qbackendscenepropertychange.cpp +++ b/src/core/qbackendscenepropertychange.cpp @@ -43,6 +43,14 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QBackendScenePropertyChange +*/ + +/*! + \class Qt3D::QBackendScenePropertyChangePrivate + \internal +*/ QBackendScenePropertyChangePrivate::QBackendScenePropertyChangePrivate(QBackendScenePropertyChange *qq) : QScenePropertyChangePrivate(qq) { @@ -74,11 +82,13 @@ QNodeId QBackendScenePropertyChange::targetNode() const return d->m_targetUuid; } +/*! \internal */ QBackendScenePropertyChange::QBackendScenePropertyChange(QBackendScenePropertyChangePrivate &dd) : QScenePropertyChange(dd) { } +/*! \internal */ QBackendScenePropertyChange::QBackendScenePropertyChange(QBackendScenePropertyChangePrivate &dd, ChangeFlag type, const QNodeId &subjectId, QSceneChange::Priority priority) : QScenePropertyChange(dd, type, Observable, subjectId, priority) { diff --git a/src/core/qscenechange.cpp b/src/core/qscenechange.cpp index 20218f04c..5632b2a4d 100644 --- a/src/core/qscenechange.cpp +++ b/src/core/qscenechange.cpp @@ -58,6 +58,10 @@ namespace Qt3D { \value AllChanges Allows an observer to monitor for any of the above changes. */ +/*! + \class Qt3D::QSceneChangePrivate + \internal +*/ QSceneChangePrivate::QSceneChangePrivate(QSceneChange *qq) : q_ptr(qq) { @@ -83,11 +87,13 @@ QSceneChange::~QSceneChange() delete d_ptr; } +/*! \internal */ QSceneChange::QSceneChange(QSceneChangePrivate &dd) : d_ptr(&dd) { } +/*! \internal */ QSceneChange::QSceneChange(QSceneChangePrivate &dd, ChangeFlag type, ObservableType observableType, const QNodeId &subjectId, QSceneChange::Priority priority) : d_ptr(&dd) { diff --git a/src/core/qscenepropertychange.cpp b/src/core/qscenepropertychange.cpp index 9daac1bd0..1f3ae9558 100644 --- a/src/core/qscenepropertychange.cpp +++ b/src/core/qscenepropertychange.cpp @@ -42,9 +42,17 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QScenePropertyChange +*/ + QFrameAllocator *QScenePropertyChangePrivate::m_allocator = new QFrameAllocator(128, sizeof(QScenePropertyChange), sizeof(QScenePropertyChangePrivate) * 2); QMutex QScenePropertyChangePrivate::m_mutex; +/*! + \class Qt3D::QScenePropertyChangePrivate + \internal +*/ QScenePropertyChangePrivate::QScenePropertyChangePrivate(QScenePropertyChange *qq) : QSceneChangePrivate(qq) { @@ -72,11 +80,13 @@ QScenePropertyChange::QScenePropertyChange(ChangeFlag type, ObservableType obser { } +/*! \internal */ QScenePropertyChange::QScenePropertyChange(QScenePropertyChangePrivate &dd) : QSceneChange(dd) { } +/*! \internal */ QScenePropertyChange::QScenePropertyChange(QScenePropertyChangePrivate &dd, ChangeFlag type, ObservableType observableType, const QNodeId &subjectId, QSceneChange::Priority priority) : QSceneChange(dd, type, observableType, subjectId, priority) { diff --git a/src/core/resources/qcircularbuffer.qdoc b/src/core/resources/qcircularbuffer.qdoc index 02b5bba27..080eeab98 100644 --- a/src/core/resources/qcircularbuffer.qdoc +++ b/src/core/resources/qcircularbuffer.qdoc @@ -184,7 +184,7 @@ support \c operator==(). These requirements are documented on a per-function basis. - QCircularBuffer provides \l{STL-Style Iterators} (\l {Qt3D::QCircularBuffer::}{const_iterator) + QCircularBuffer provides \l{STL-Style Iterators} (\l {Qt3D::QCircularBuffer::}{const_iterator}) and \l {Qt3D::QCircularBuffer::}{iterator}). In practice, these are rarely used, because you can use indexes into the QCircularBuffer. diff --git a/src/core/resources/qframeallocator.cpp b/src/core/resources/qframeallocator.cpp index 5b8c9aaf5..ead5a790e 100644 --- a/src/core/resources/qframeallocator.cpp +++ b/src/core/resources/qframeallocator.cpp @@ -49,6 +49,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QFrameAllocatorPrivate + \internal +*/ QFrameAllocatorPrivate::QFrameAllocatorPrivate(QFrameAllocator *qq) : q_ptr(qq) { diff --git a/src/core/services/qopenglinformationservice.cpp b/src/core/services/qopenglinformationservice.cpp index 593bc62af..e651d9fbe 100644 --- a/src/core/services/qopenglinformationservice.cpp +++ b/src/core/services/qopenglinformationservice.cpp @@ -42,6 +42,11 @@ QT_BEGIN_NAMESPACE namespace Qt3D { /*! + \class Qt3D::QOpenGLInformationServicePrivate + \internal +*/ + +/*! \class Qt3D::QOpenGLInformationService \inmodule Qt3DCore \brief Interface for a Qt3D OpenGL information service @@ -53,8 +58,9 @@ namespace Qt3D { */ /*! - Creates an instance of QOpenGLInformationService. This constructor is protected - so only subclasses can instantiate a QOpenGLInformationService object. + Creates an instance of QOpenGLInformationService, with a \a description for + the new service. This constructor is protected so only subclasses can + instantiate a QOpenGLInformationService object. */ QOpenGLInformationService::QOpenGLInformationService(const QString &description) : QAbstractServiceProvider(QServiceLocator::OpenGLInformation, description) diff --git a/src/core/services/qservicelocator.cpp b/src/core/services/qservicelocator.cpp index a98ae16d2..706114378 100644 --- a/src/core/services/qservicelocator.cpp +++ b/src/core/services/qservicelocator.cpp @@ -43,11 +43,16 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAbstractServiceProvider +*/ + QAbstractServiceProvider::QAbstractServiceProvider(int type, const QString &description) : d_ptr(new QAbstractServiceProviderPrivate(type, description)) { } +/*! \internal */ QAbstractServiceProvider::QAbstractServiceProvider(QAbstractServiceProviderPrivate &dd) : d_ptr(&dd) { @@ -127,7 +132,7 @@ QServiceLocator::~QServiceLocator() existing provider for this service. The service provider does not take ownership of the provider. - \sa unregisterService(), serviceCount(), service() + \sa unregisterServiceProvider(), serviceCount(), service() */ void QServiceLocator::registerServiceProvider(int serviceType, QAbstractServiceProvider *provider) { diff --git a/src/core/services/qsysteminformationservice.cpp b/src/core/services/qsysteminformationservice.cpp index 9194fd1b8..df2869986 100644 --- a/src/core/services/qsysteminformationservice.cpp +++ b/src/core/services/qsysteminformationservice.cpp @@ -42,6 +42,16 @@ QT_BEGIN_NAMESPACE namespace Qt3D { /*! + \class Qt3D::QAbstractServiceProviderPrivate + \internal +*/ + +/*! + \class Qt3D::QSystemInformationServicePrivate + \internal +*/ + +/*! \class Qt3D::QSystemInformationService \inmodule Qt3DCore \brief Interface for a Qt3D system information service @@ -51,8 +61,9 @@ namespace Qt3D { */ /*! - Creates an instance of QSystemInformationService. This constructor is protected - so only subclasses can instantiate a QSystemInformationService object. + Creates an instance of QSystemInformationService, with a \a description for + the new service. This constructor is protected so only subclasses can + instantiate a QSystemInformationService object. */ QSystemInformationService::QSystemInformationService(const QString &description) : QAbstractServiceProvider(*new QSystemInformationServicePrivate(description)) diff --git a/src/core/transforms/qabstracttransform.cpp b/src/core/transforms/qabstracttransform.cpp index aa40902b5..2a4d97ff4 100644 --- a/src/core/transforms/qabstracttransform.cpp +++ b/src/core/transforms/qabstracttransform.cpp @@ -41,17 +41,21 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAbstractTransformPrivate + \internal +*/ QAbstractTransformPrivate::QAbstractTransformPrivate() : QObjectPrivate() { } - QAbstractTransform::QAbstractTransform(QObject *parent) : QObject(*new QAbstractTransformPrivate, parent) { } +/*! \internal */ QAbstractTransform::QAbstractTransform(QAbstractTransformPrivate &dd, QObject *parent) : QObject(dd, parent) { diff --git a/src/core/transforms/qlookattransform.cpp b/src/core/transforms/qlookattransform.cpp index ce042e229..cea39ac81 100644 --- a/src/core/transforms/qlookattransform.cpp +++ b/src/core/transforms/qlookattransform.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QLookAtTransformPrivate + \internal +*/ QLookAtTransformPrivate::QLookAtTransformPrivate() : QAbstractTransformPrivate() , m_matrixDirty(true) @@ -53,6 +57,7 @@ QLookAtTransform::QLookAtTransform(QObject *parent) { } +/*! \internal */ QLookAtTransform::QLookAtTransform(QLookAtTransformPrivate &dd, QObject *parent) : QAbstractTransform(dd, parent) { diff --git a/src/core/transforms/qmatrixtransform.cpp b/src/core/transforms/qmatrixtransform.cpp index a85812457..706a183f1 100644 --- a/src/core/transforms/qmatrixtransform.cpp +++ b/src/core/transforms/qmatrixtransform.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QMatrixTransformPrivate + \internal +*/ QMatrixTransformPrivate::QMatrixTransformPrivate() : QAbstractTransformPrivate() { diff --git a/src/core/transforms/qrotatetransform.cpp b/src/core/transforms/qrotatetransform.cpp index b20168f9a..264b0b5bc 100644 --- a/src/core/transforms/qrotatetransform.cpp +++ b/src/core/transforms/qrotatetransform.cpp @@ -48,6 +48,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRotateTransformPrivate + \internal +*/ QRotateTransformPrivate::QRotateTransformPrivate() : QAbstractTransformPrivate() , m_angleDeg(0) @@ -69,6 +73,7 @@ QRotateTransform::QRotateTransform(QObject *parent) { } +/*! \internal */ QRotateTransform::QRotateTransform(QRotateTransformPrivate &dd, QObject *parent) : QAbstractTransform(dd, parent) { diff --git a/src/core/transforms/qscaletransform.cpp b/src/core/transforms/qscaletransform.cpp index 82e7ad19e..f102fe373 100644 --- a/src/core/transforms/qscaletransform.cpp +++ b/src/core/transforms/qscaletransform.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QScaleTransformPrivate + \internal +*/ QScaleTransformPrivate::QScaleTransformPrivate() : QAbstractTransformPrivate() , m_scale3D(1.0f, 1.0f, 1.0f) @@ -54,6 +58,7 @@ QScaleTransform::QScaleTransform(QObject *parent) { } +/*! \internal */ QScaleTransform::QScaleTransform(QScaleTransformPrivate &dd, QObject *parent) : QAbstractTransform(dd, parent) { diff --git a/src/core/transforms/qtransform.cpp b/src/core/transforms/qtransform.cpp index 83107041e..5ec3fe6c0 100644 --- a/src/core/transforms/qtransform.cpp +++ b/src/core/transforms/qtransform.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QTransformPrivate + \internal +*/ QTransformPrivate::QTransformPrivate(QTransform *qq) : QComponentPrivate(qq), m_transformsDirty(false) @@ -93,6 +97,7 @@ QTransform::QTransform(QAbstractTransform *transform, QNode *parent) addTransform(transform); } +/*! \internal */ QTransform::QTransform(QTransformPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/core/transforms/qtranslatetransform.cpp b/src/core/transforms/qtranslatetransform.cpp index 54f9cf997..6c7dc0896 100644 --- a/src/core/transforms/qtranslatetransform.cpp +++ b/src/core/transforms/qtranslatetransform.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QTranslateTransformPrivate + \internal +*/ QTranslateTransformPrivate::QTranslateTransformPrivate() : QAbstractTransformPrivate() { @@ -53,6 +57,7 @@ QTranslateTransform::QTranslateTransform(QObject *parent) { } +/*! \internal */ QTranslateTransform::QTranslateTransform(QTranslateTransformPrivate &dd, QObject *parent) : QAbstractTransform(dd, parent) { diff --git a/src/input/qinputaspect.cpp b/src/input/qinputaspect.cpp index f769ab3af..894e0d6b0 100644 --- a/src/input/qinputaspect.cpp +++ b/src/input/qinputaspect.cpp @@ -50,6 +50,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QInputAspectPrivate + \internal +*/ QInputAspectPrivate::QInputAspectPrivate(QInputAspect *qq) : QAbstractAspectPrivate(qq) , m_inputHandler(new Input::InputHandler()) diff --git a/src/input/qkeyboardcontroller.cpp b/src/input/qkeyboardcontroller.cpp index 6dc9d64bd..7e7a44215 100644 --- a/src/input/qkeyboardcontroller.cpp +++ b/src/input/qkeyboardcontroller.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QKeyboardControllerPrivate + \internal +*/ QKeyboardControllerPrivate::QKeyboardControllerPrivate(QKeyboardController *qq) : QNodePrivate(qq) { @@ -60,6 +64,7 @@ QKeyboardInput *QKeyboardController::activeInput() const return d->m_activeInput; } +/*! \internal */ QKeyboardController::QKeyboardController(QKeyboardControllerPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/input/qkeyboardinput.cpp b/src/input/qkeyboardinput.cpp index a6dfc1241..46b458995 100644 --- a/src/input/qkeyboardinput.cpp +++ b/src/input/qkeyboardinput.cpp @@ -43,6 +43,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QKeyboardInputPrivate + \internal +*/ QKeyboardInputPrivate::QKeyboardInputPrivate(QKeyboardInput *qq) : QComponentPrivate(qq) , m_controller(Q_NULLPTR) @@ -59,6 +63,7 @@ QKeyboardInput::QKeyboardInput(QNode *parent) { } +/*! \internal */ QKeyboardInput::QKeyboardInput(QKeyboardInputPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/plugins/sceneparsers/assimp/assimphelpers.cpp b/src/plugins/sceneparsers/assimp/assimphelpers.cpp index 9ad5847e7..345bb79bc 100644 --- a/src/plugins/sceneparsers/assimp/assimphelpers.cpp +++ b/src/plugins/sceneparsers/assimp/assimphelpers.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE namespace Qt3D { namespace AssimpHelper { /*! - * \class AssimpIOStream + * \class Qt3D::AssimpHelper::AssimpIOStream * * \internal * diff --git a/src/plugins/sceneparsers/assimp/assimpparser.cpp b/src/plugins/sceneparsers/assimp/assimpparser.cpp index 79610acee..9673deceb 100644 --- a/src/plugins/sceneparsers/assimp/assimpparser.cpp +++ b/src/plugins/sceneparsers/assimp/assimpparser.cpp @@ -60,16 +60,15 @@ QT_BEGIN_NAMESPACE namespace Qt3D { /*! - * \class AssimpParser - * \namespace Qt3D - * \since 5.5 - * - * \brief Provides a generic way of loading various 3D assets - * format into a Qt3D scene. - * - * It should be noted that Assimp aiString is explicitly defined to be UTF-8. - * - * \sa GLTFParser + \class Qt3D::AssimpParser + \since 5.5 + + \brief Provides a generic way of loading various 3D assets + format into a Qt3D scene. + + It should be noted that Assimp aiString is explicitly defined to be UTF-8. + + \sa GLTFParser */ Q_LOGGING_CATEGORY(AssimpParserLog, "Qt3D.AssimpParser") @@ -230,7 +229,7 @@ private: }; /*! - * Initialized a new instance of AssimpParser. + * Constructor. Initializes a new instance of AssimpParser. */ AssimpParser::AssimpParser() : AbstractSceneParser(), m_sceneParsed(false), @@ -239,7 +238,7 @@ AssimpParser::AssimpParser() : AbstractSceneParser(), } /*! - * Cleans the parser properly before destruction. + * Destructor. Cleans the parser properly before destroying it. */ AssimpParser::~AssimpParser() { @@ -247,7 +246,7 @@ AssimpParser::~AssimpParser() } /*! - * Return true if the provided \a path has a suffix supported + * Returns \c true if the provided \a path has a suffix supported * by the Assimp Assets importer. */ bool AssimpParser::isAssimpPath(const QString &path) @@ -272,8 +271,8 @@ QMatrix4x4 AssimpParser::aiMatrix4x4ToQMatrix4x4(const aiMatrix4x4 &matrix) } /*! - * Sets the \a path used by the parser to load the asset file. - * If the file is valid, this will trigger the parsing of the file. + * Sets the \a source used by the parser to load the asset file. + * If the file is valid, this will trigger parsing of the file. */ void AssimpParser::setSource(const QUrl &source) { @@ -288,7 +287,7 @@ void AssimpParser::setSource(const QUrl &source) } /*! - * Returns true if the extension of \a path is supported by + * Returns \c true if the extension of \a source is supported by * the assimp parser. */ bool AssimpParser::isExtensionSupported(const QUrl &source) const @@ -302,7 +301,7 @@ bool AssimpParser::isExtensionSupported(const QUrl &source) const * node specified by \a id. If \a id is empty, the scene is assumed to be * the root node of the scene. * - * Returns Q_NULLPTR if \a id was specified but not node matching it can be found. + * Returns \c Q_NULLPTR if \a id was specified but no node matching it was found. */ QEntity *AssimpParser::scene(const QString &id) { @@ -327,7 +326,7 @@ QEntity *AssimpParser::scene(const QString &id) /*! * Returns a Node from the scene identified by \a id. - * Returns Q_NULLPTR if no node can be found. + * Returns \c Q_NULLPTR if the node was not found. */ QEntity *AssimpParser::node(const QString &id) { @@ -384,7 +383,7 @@ QEntity *AssimpParser::node(aiNode *node) /*! * Reads the scene file pointed by \a path and launches the parsing of - * the scene using Assimp after having cleaned up previously saved values + * the scene using Assimp, after having cleaned up previously saved values * from eventual previous parsings. */ void AssimpParser::readSceneFile(const QString &path) @@ -413,7 +412,7 @@ void AssimpParser::readSceneFile(const QString &path) } /*! - * Cleans the various dictionnaries holding the scenes infos. + * Cleans the various dictionaries holding the scene's information. */ void AssimpParser::cleanup() { @@ -423,7 +422,7 @@ void AssimpParser::cleanup() } /*! - * Parses the the aiScene provided py Assimp and convert Assimp + * Parses the aiScene provided py Assimp and converts Assimp * values to Qt3D values. */ void AssimpParser::parse() @@ -448,8 +447,9 @@ void AssimpParser::parse() } /*! - * Converts the provided Assimp aiMaterial \a material to a Qt3D material. - * \sa Material and adds its to a dictionary of materials. + * Converts the provided Assimp aiMaterial identified by \a materialIndex to a + * Qt3D material and adds it to a dictionary of materials. + * \sa Material */ void AssimpParser::loadMaterial(uint materialIndex) { @@ -471,7 +471,8 @@ void AssimpParser::loadMaterial(uint materialIndex) /*! * Converts the Assimp aiMesh mesh identified by \a meshIndex to a QMeshData - * \sa QMeshData and adds it to a dictionary of meshes. + * and adds it to a dictionary of meshes. + * \sa QMeshData */ void AssimpParser::loadMesh(uint meshIndex) { @@ -611,7 +612,7 @@ void AssimpParser::loadMesh(uint meshIndex) /*! * Converts the provided Assimp aiTexture at \a textureIndex to a Texture and - * adds it ot a dictionary of textures. + * adds it to a dictionary of textures. * \sa Texture */ void AssimpParser::loadEmbeddedTexture(uint textureIndex) @@ -702,7 +703,7 @@ void AssimpParser::copyMaterialName(QMaterial *material, aiMaterial *assimpMater } /*! - * Fills \a material color properties with \a assimpMaterial color properties; + * Fills \a material color properties with \a assimpMaterial color properties. */ void AssimpParser::copyMaterialColorProperties(QMaterial *material, aiMaterial *assimpMaterial) { @@ -722,7 +723,7 @@ void AssimpParser::copyMaterialColorProperties(QMaterial *material, aiMaterial * } /*! - * Retrieves a\a material bool property; + * Retrieves a \a material bool property. */ void AssimpParser::copyMaterialBoolProperties(QMaterial *material, aiMaterial *assimpMaterial) { @@ -803,7 +804,7 @@ void AssimpParser::copyMaterialTextures(QMaterial *material, aiMaterial *assimpM } /*! - * Retrieves a\a material float property. + * Retrieves a \a material float property. */ void AssimpParser::copyMaterialFloatProperties(QMaterial *material, aiMaterial *assimpMaterial) { diff --git a/src/quick3d/quick3d/qqmlaspectengine.cpp b/src/quick3d/quick3d/qqmlaspectengine.cpp index e5320377d..ec00cdf75 100644 --- a/src/quick3d/quick3d/qqmlaspectengine.cpp +++ b/src/quick3d/quick3d/qqmlaspectengine.cpp @@ -47,6 +47,10 @@ namespace Qt3D { namespace Quick { +/*! + \class Qt3D::QQmlAspectEnginePrivate + \internal +*/ QQmlAspectEnginePrivate::QQmlAspectEnginePrivate(QQmlAspectEngine *qq) : QObjectPrivate() , q_ptr(qq) diff --git a/src/quick3d/quick3drenderer/items/quick3dparameter.cpp b/src/quick3d/quick3drenderer/items/quick3dparameter.cpp index 576b0a07e..32e7c0d62 100644 --- a/src/quick3d/quick3drenderer/items/quick3dparameter.cpp +++ b/src/quick3d/quick3drenderer/items/quick3dparameter.cpp @@ -75,6 +75,7 @@ Quick3DParameter::Quick3DParameter(QNode *parent) { } +/*! \internal */ Quick3DParameter::Quick3DParameter(Quick3DParameterPrivate &dd, QNode *parent) : QParameter(dd, parent) { diff --git a/src/render/backend/qrenderaspect.cpp b/src/render/backend/qrenderaspect.cpp index ec81f3684..a6f9b85bb 100644 --- a/src/render/backend/qrenderaspect.cpp +++ b/src/render/backend/qrenderaspect.cpp @@ -112,6 +112,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRenderAspectPrivate + \internal +*/ QRenderAspectPrivate::QRenderAspectPrivate(QRenderAspect::RenderType type, QRenderAspect *qq) : QAbstractAspectPrivate(qq) , m_renderer(new Render::Renderer(type)) @@ -174,6 +178,7 @@ QRenderAspect::QRenderAspect(QRenderAspect::RenderType type, QObject *parent) registerBackendTypes(); } +/*! \internal */ QRenderAspect::QRenderAspect(QRenderAspectPrivate &dd, QObject *parent) : QAbstractAspect(dd, parent) diff --git a/src/render/defaults/qdiffusemapmaterial.cpp b/src/render/defaults/qdiffusemapmaterial.cpp index a32cb3c3a..117f3ecbb 100644 --- a/src/render/defaults/qdiffusemapmaterial.cpp +++ b/src/render/defaults/qdiffusemapmaterial.cpp @@ -52,6 +52,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QDiffuseMapMaterialPrivate + \internal +*/ QDiffuseMapMaterialPrivate::QDiffuseMapMaterialPrivate(QDiffuseMapMaterial *qq) : QMaterialPrivate(qq) , m_diffuseMapEffect(new QEffect()) @@ -146,7 +150,6 @@ void QDiffuseMapMaterialPrivate::init() */ /*! - \fn Qt3D::QDiffuseMapMaterial::QDiffuseMapMaterial() Constructs a new Qt3D::QDiffuseMapMaterial instance with parent object \a parent. */ @@ -162,13 +165,17 @@ QDiffuseMapMaterial::QDiffuseMapMaterial(QNode *parent) d->init(); } +/*! + Destroys the QDiffuseMapMaterial instance. +*/ QDiffuseMapMaterial::~QDiffuseMapMaterial() { } /*! - \fn Qt3D::QDiffuseMapMaterial::ambient() const - \return the current QColor ambient value. + \property Qt3D::QDiffuseMapMaterial::ambient + + Holds the current ambient color. */ QColor QDiffuseMapMaterial::ambient() const { @@ -177,8 +184,9 @@ QColor QDiffuseMapMaterial::ambient() const } /*! - \fn Qt3D::QDiffuseMapMaterial::specular() const - \return the current QColor specular value. + \property Qt3D::QDiffuseMapMaterial::specular + + Holds the current specular color. */ QColor QDiffuseMapMaterial::specular() const { @@ -187,8 +195,9 @@ QColor QDiffuseMapMaterial::specular() const } /*! - \fn Qt3D::QDiffuseMapMaterial::shininess() const - \return the current shininess as a float value. + \property Qt3D::QDiffuseMapMaterial::shininess + + Holds the current shininess as a float value. */ float QDiffuseMapMaterial::shininess() const { @@ -197,12 +206,18 @@ float QDiffuseMapMaterial::shininess() const } /*! - \fn Qt3D::QDiffuseMapMaterial::diffuse() const - \return the current QTexture used as the diffuse map. - \b {Note:} By default the diffuse texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QDiffuseMapMaterial::diffuse + + Holds the current QTexture used as the diffuse map. + + By default, the diffuse texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QDiffuseMapMaterial::diffuse() const { @@ -211,8 +226,9 @@ QAbstractTextureProvider *QDiffuseMapMaterial::diffuse() const } /*! - \fn Qt3D::QDiffuseMapMaterial::textureScale() const - \return the current texture scale. + \property Qt3D::QDiffuseMapMaterial::textureScale + + Holds the current texture scale as a float value. */ float QDiffuseMapMaterial::textureScale() const { @@ -220,50 +236,30 @@ float QDiffuseMapMaterial::textureScale() const return d->m_textureScaleParameter->value().toFloat(); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setAmbient(const QColor &ambient) - Sets the current ambient color to \a ambient. - */ void QDiffuseMapMaterial::setAmbient(const QColor &ambient) { Q_D(const QDiffuseMapMaterial); d->m_ambientParameter->setValue(ambient); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setSpecular(const QColor &specular) - Sets the current specular color to \a specular. - */ void QDiffuseMapMaterial::setSpecular(const QColor &specular) { Q_D(QDiffuseMapMaterial); d->m_specularParameter->setValue(specular); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setShininess(float shininess) - Sets the current shininess value to \a shininess. - */ void QDiffuseMapMaterial::setShininess(float shininess) { Q_D(QDiffuseMapMaterial); d->m_shininessParameter->setValue(shininess); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setDiffuse(QTexture *diffuseMap) - Sets the current diffuse map to \a diffuseMap. - */ void QDiffuseMapMaterial::setDiffuse(QAbstractTextureProvider *diffuseMap) { Q_D(QDiffuseMapMaterial); d->m_diffuseParameter->setValue(QVariant::fromValue(diffuseMap)); } -/*! - \fn Qt3D::QDiffuseMapMaterial::setTextureScale(float textureScale) - Sets the current texture scale to \a textureScale. - */ void QDiffuseMapMaterial::setTextureScale(float textureScale) { Q_D(QDiffuseMapMaterial); diff --git a/src/render/defaults/qdiffusespecularmapmaterial.cpp b/src/render/defaults/qdiffusespecularmapmaterial.cpp index 7420ddea0..61fc5fa12 100644 --- a/src/render/defaults/qdiffusespecularmapmaterial.cpp +++ b/src/render/defaults/qdiffusespecularmapmaterial.cpp @@ -53,6 +53,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QDiffuseSpecularMapMaterialPrivate + \internal +*/ QDiffuseSpecularMapMaterialPrivate::QDiffuseSpecularMapMaterialPrivate(QDiffuseSpecularMapMaterial *qq) : QMaterialPrivate(qq) , m_diffuseSpecularMapEffect(new QEffect()) @@ -154,7 +158,6 @@ void QDiffuseSpecularMapMaterialPrivate::init() */ /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::QDiffuseSpecularMapMaterial() Constructs a new Qt3D::QDiffuseSpecularMapMaterial instance with parent object \a parent. */ QDiffuseSpecularMapMaterial::QDiffuseSpecularMapMaterial(QNode *parent) @@ -169,13 +172,17 @@ QDiffuseSpecularMapMaterial::QDiffuseSpecularMapMaterial(QNode *parent) d->init(); } +/*! + Destroys the QDiffuseSpecularMapMaterial instance. +*/ QDiffuseSpecularMapMaterial::~QDiffuseSpecularMapMaterial() { } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::ambient() const - \return the current QColor ambient value. + \property Qt3D::QDiffuseSpecularMapMaterial::ambient + + Holds the current ambient color. */ QColor QDiffuseSpecularMapMaterial::ambient() const { @@ -184,12 +191,18 @@ QColor QDiffuseSpecularMapMaterial::ambient() const } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::diffuse() const - \return the current diffuse map texture. - \b {Note:} By default the diffuse texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QDiffuseSpecularMapMaterial::diffuse + + Holds the current diffuse map texture. + + By default, the diffuse texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QDiffuseSpecularMapMaterial::diffuse() const { @@ -198,12 +211,18 @@ QAbstractTextureProvider *QDiffuseSpecularMapMaterial::diffuse() const } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::specular() const - \return the current specular map texture. - \b {Note:} By default the specular texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QDiffuseSpecularMapMaterial::specular + + Holds the current specular map texture. + + By default, the specular texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QDiffuseSpecularMapMaterial::specular() const { @@ -212,8 +231,9 @@ QAbstractTextureProvider *QDiffuseSpecularMapMaterial::specular() const } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::shininess() const - \return the current shininess as a float value. + \property Qt3D::QDiffuseSpecularMapMaterial::shininess + + Holds the current shininess as a float value. */ float QDiffuseSpecularMapMaterial::shininess() const { @@ -222,8 +242,8 @@ float QDiffuseSpecularMapMaterial::shininess() const } /*! - \fn Qt3D::QDiffuseSpecularMapMaterial::textureScale() const - \return the current texture scale. + \property Qt3D::QDiffuseSpecularMapMaterial::textureScale + Holds the current texture scale as a float value. */ float QDiffuseSpecularMapMaterial::textureScale() const { @@ -231,50 +251,30 @@ float QDiffuseSpecularMapMaterial::textureScale() const return d->m_textureScaleParameter->value().toFloat(); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setAmbient(const QColor &ambient) - Sets the current ambient color to \a ambient - */ void QDiffuseSpecularMapMaterial::setAmbient(const QColor &ambient) { Q_D(QDiffuseSpecularMapMaterial); d->m_ambientParameter->setValue(ambient); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setDiffuse(QTexture *diffuse) - Sets the current diffuse map to \a diffuse. - */ void QDiffuseSpecularMapMaterial::setDiffuse(QAbstractTextureProvider *diffuse) { Q_D(QDiffuseSpecularMapMaterial); d->m_diffuseParameter->setValue(QVariant::fromValue(diffuse)); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setSpecular(QTexture *specular) - Sets the current specular map to \a specular. - */ void QDiffuseSpecularMapMaterial::setSpecular(QAbstractTextureProvider *specular) { Q_D(QDiffuseSpecularMapMaterial); d->m_specularParameter->setValue(QVariant::fromValue(specular)); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setShininess(float shininess) - Sets the current shininess value to \a shininess. - */ void QDiffuseSpecularMapMaterial::setShininess(float shininess) { Q_D(QDiffuseSpecularMapMaterial); d->m_shininessParameter->setValue(shininess); } -/*! - \fn Qt3D::QDiffuseSpecularMapMaterial::setTextureScale(float textureScale) - Sets the current texture scale to \a textureScale. - */ void QDiffuseSpecularMapMaterial::setTextureScale(float textureScale) { Q_D(QDiffuseSpecularMapMaterial); diff --git a/src/render/defaults/qforwardrenderer.cpp b/src/render/defaults/qforwardrenderer.cpp index c8bf9e8d7..f7d13515e 100644 --- a/src/render/defaults/qforwardrenderer.cpp +++ b/src/render/defaults/qforwardrenderer.cpp @@ -46,6 +46,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QForwardRendererPrivate + \internal +*/ QForwardRendererPrivate::QForwardRendererPrivate(QForwardRenderer *qq) : QTechniqueFilterPrivate(qq) , m_viewport(new QViewport()) @@ -91,7 +95,6 @@ void QForwardRendererPrivate::init() */ /*! - \fn Qt3D::QForwardRenderer::QForwardRenderer(QNode *parent) Constructs a new Qt3D::QForwardRenderer instance with parent object \a parent. */ QForwardRenderer::QForwardRenderer(QNode *parent) @@ -104,35 +107,25 @@ QForwardRenderer::QForwardRenderer(QNode *parent) d->init(); } +/*! + Destroys the QForwardRenderer instance. +*/ QForwardRenderer::~QForwardRenderer() { } -/*! - \fn Qt3D::QForwardRenderer::setViewportRect(const QRectF &viewportRect) - Sets the current viewport rect to \a viewportRect. - */ void QForwardRenderer::setViewportRect(const QRectF &viewportRect) { Q_D(QForwardRenderer); d->m_viewport->setRect(viewportRect); } -/*! - \fn Qt3D::QForwardRenderer::setClearColor(const QColor &clearColor) - Sets the clearColor to \a clearColor. - */ void QForwardRenderer::setClearColor(const QColor &clearColor) { Q_D(QForwardRenderer); d->m_viewport->setClearColor(clearColor); } -/*! - \fn Qt3D::QForwardRenderer::setCamera(QEntity *camera) - Sets the camera which should be used to render the scene to \a camera. - \b {Note:} A camera is a QEntity having a QCameraLens has one of its components - */ void QForwardRenderer::setCamera(QEntity *camera) { Q_D(QForwardRenderer); @@ -140,8 +133,9 @@ void QForwardRenderer::setCamera(QEntity *camera) } /*! - \fn Qt3D::QForwardRenderer::viewportRect() const - \return the current viewport rect. + \property Qt3D::QForwardRenderer::viewportRect + + Holds the current viewport rect. */ QRectF QForwardRenderer::viewportRect() const { @@ -150,8 +144,8 @@ QRectF QForwardRenderer::viewportRect() const } /*! - \fn Qt3D::QForwardRenderer::clearColor() const - \return the current clearColor. + \property Qt3D::QForwardRenderer::clearColor + Holds the current clearColor. */ QColor QForwardRenderer::clearColor() const { @@ -160,8 +154,10 @@ QColor QForwardRenderer::clearColor() const } /*! - \fn Qt3D::QForwardRenderer::camera() const - \return the current QEntity camera used to render the scene. + \property Qt3D::QForwardRenderer::camera + Holds the current QEntity camera used to render the scene. + + \note A camera is a QEntity that has a QCameraLens as one of its components. */ QEntity *QForwardRenderer::camera() const { diff --git a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp index 4f94893bc..09b2f951a 100644 --- a/src/render/defaults/qnormaldiffusemapalphamaterial.cpp +++ b/src/render/defaults/qnormaldiffusemapalphamaterial.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QNormalDiffuseMapAlphaMaterialPrivate + \internal +*/ QNormalDiffuseMapAlphaMaterialPrivate::QNormalDiffuseMapAlphaMaterialPrivate(QNormalDiffuseMapAlphaMaterial *qq) : QNormalDiffuseMapMaterialPrivate(qq) , m_alphaCoverage(new QAlphaCoverage()) @@ -143,7 +147,6 @@ void QNormalDiffuseMapAlphaMaterialPrivate::init() */ /*! - \fn Qt3D::QNormalDiffuseMapAlphaMaterial::QNormalDiffuseMapAlphaMaterial() Constructs a new Qt3D::QNormalDiffuseMapAlphaMaterial instance with parent object \a parent. */ QNormalDiffuseMapAlphaMaterial::QNormalDiffuseMapAlphaMaterial(QNode *parent) @@ -151,6 +154,9 @@ QNormalDiffuseMapAlphaMaterial::QNormalDiffuseMapAlphaMaterial(QNode *parent) { } +/*! + Destroys the QNormalDiffuseMapAlphaMaterial instance. +*/ QNormalDiffuseMapAlphaMaterial::~QNormalDiffuseMapAlphaMaterial() { } diff --git a/src/render/defaults/qnormaldiffusemapmaterial.cpp b/src/render/defaults/qnormaldiffusemapmaterial.cpp index ce5565020..01de6f4d5 100644 --- a/src/render/defaults/qnormaldiffusemapmaterial.cpp +++ b/src/render/defaults/qnormaldiffusemapmaterial.cpp @@ -53,6 +53,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QNormalDiffuseMapMaterialPrivate + \internal +*/ QNormalDiffuseMapMaterialPrivate::QNormalDiffuseMapMaterialPrivate(QNormalDiffuseMapMaterial *qq) : QMaterialPrivate(qq) , m_normalDiffuseEffect(new QEffect()) @@ -155,7 +159,6 @@ void QNormalDiffuseMapMaterialPrivate::init() */ /*! - \fn Qt3D::QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial() Constructs a new Qt3D::QNormalDiffuseMapMaterial instance with parent object \a parent. */ QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNode *parent) @@ -171,6 +174,7 @@ QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNode *parent) d->init(); } +/*! \internal */ QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNormalDiffuseMapMaterialPrivate &dd, QNode *parent) : QMaterial(dd, parent) { @@ -184,13 +188,16 @@ QNormalDiffuseMapMaterial::QNormalDiffuseMapMaterial(QNormalDiffuseMapMaterialPr d->init(); } +/*! + Destroys the QNormalDiffuseMapMaterial instance. +*/ QNormalDiffuseMapMaterial::~QNormalDiffuseMapMaterial() { } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::ambient() const - \return the current QColor ambient value. + \property Qt3D::QNormalDiffuseMapMaterial::ambient + Holds the current ambient color. */ QColor QNormalDiffuseMapMaterial::ambient() const { @@ -199,8 +206,8 @@ QColor QNormalDiffuseMapMaterial::ambient() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::specular() const - \return the current QColor specular value. + \property Qt3D::QNormalDiffuseMapMaterial::specular + Holds the current specular color. */ QColor QNormalDiffuseMapMaterial::specular() const { @@ -209,12 +216,18 @@ QColor QNormalDiffuseMapMaterial::specular() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::diffuse() const - \return the current diffuse map texture. - \b {Note:} By default the diffuse texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QNormalDiffuseMapMaterial::diffuse + + Holds the current diffuse map texture. + + By default, the diffuse texture has these properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap modeM + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseMapMaterial::diffuse() const { @@ -223,11 +236,17 @@ QAbstractTextureProvider *QNormalDiffuseMapMaterial::diffuse() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::normal() const - \return the current normal map texture. - \b {Note:} By default the normal texture has linear minification - and magnification filters, the wrap mode is repeat and maximum anisotropy - is set to 16.0. + \property Qt3D::QNormalDiffuseMapMaterial::normal + + Holds the current normal map texture. + + By default, the normal texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseMapMaterial::normal() const { @@ -236,8 +255,9 @@ QAbstractTextureProvider *QNormalDiffuseMapMaterial::normal() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::shininess() const - \return the current shininess as a float value. + \property Qt3D::QNormalDiffuseMapMaterial::shininess + + Holds the current shininess as a float value. */ float QNormalDiffuseMapMaterial::shininess() const { @@ -246,8 +266,9 @@ float QNormalDiffuseMapMaterial::shininess() const } /*! - \fn Qt3D::QNormalDiffuseMapMaterial::textureScale() const - \return the current texture scale. + \property Qt3D::QNormalDiffuseMapMaterial::textureScale + + Holds the current texture scale as a float value. */ float QNormalDiffuseMapMaterial::textureScale() const { @@ -255,60 +276,36 @@ float QNormalDiffuseMapMaterial::textureScale() const return d->m_textureScaleParameter->value().toFloat(); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setAmbient(const QColor &ambient) - Sets the current ambient color to \a ambient - */ void QNormalDiffuseMapMaterial::setAmbient(const QColor &ambient) { Q_D(QNormalDiffuseMapMaterial); d->m_ambientParameter->setValue(ambient); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setSpecular(const QColor &specular) - Sets the current specular color to \a specular. - */ void QNormalDiffuseMapMaterial::setSpecular(const QColor &specular) { Q_D(QNormalDiffuseMapMaterial); d->m_specularParameter->setValue(specular); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setDiffuse(QTexture *diffuse) - Sets the current diffuse map to \a diffuse. - */ void QNormalDiffuseMapMaterial::setDiffuse(QAbstractTextureProvider *diffuse) { Q_D(QNormalDiffuseMapMaterial); d->m_diffuseParameter->setValue(QVariant::fromValue(diffuse)); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setNormal(QTexture *normal) - Sets the current normal map to \a normal. - */ void QNormalDiffuseMapMaterial::setNormal(QAbstractTextureProvider *normal) { Q_D(QNormalDiffuseMapMaterial); d->m_normalParameter->setValue(QVariant::fromValue(normal)); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setShininess(float shininess) - Sets the current shininess value to \a shininess. - */ void QNormalDiffuseMapMaterial::setShininess(float shininess) { Q_D(QNormalDiffuseMapMaterial); d->m_shininessParameter->setValue(shininess); } -/*! - \fn Qt3D::QNormalDiffuseMapMaterial::setTextureScale(float textureScale) - Sets the current texture scale to \a textureScale. - */ void QNormalDiffuseMapMaterial::setTextureScale(float textureScale) { Q_D(QNormalDiffuseMapMaterial); diff --git a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp index 9a9342db3..8f7441b9f 100644 --- a/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp +++ b/src/render/defaults/qnormaldiffusespecularmapmaterial.cpp @@ -52,6 +52,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QNormalDiffuseSpecularMapMaterialPrivate + \internal +*/ QNormalDiffuseSpecularMapMaterialPrivate::QNormalDiffuseSpecularMapMaterialPrivate(QNormalDiffuseSpecularMapMaterial *qq) : QMaterialPrivate(qq) , m_normalDiffuseSpecularEffect(new QEffect()) @@ -161,7 +165,6 @@ void QNormalDiffuseSpecularMapMaterialPrivate::init() */ /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial() Constructs a new Qt3D::QNormalDiffuseSpecularMapMaterial instance with parent object \a parent. */ QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNode *parent) @@ -177,7 +180,7 @@ QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNode *pare d->init(); } - +/*! \internal */ QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNormalDiffuseSpecularMapMaterialPrivate &dd, QNode *parent) : QMaterial(dd, parent) { @@ -191,13 +194,16 @@ QNormalDiffuseSpecularMapMaterial::QNormalDiffuseSpecularMapMaterial(QNormalDiff d->init(); } +/*! + Destroys the Qt3D::QNormalDiffuseSpecularMapMaterial instance. +*/ QNormalDiffuseSpecularMapMaterial::~QNormalDiffuseSpecularMapMaterial() { } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::ambient() const - \return the current QColor ambient value. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::ambient + Holds the current ambient color. */ QColor QNormalDiffuseSpecularMapMaterial::ambient() const { @@ -206,12 +212,18 @@ QColor QNormalDiffuseSpecularMapMaterial::ambient() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::diffuse() const - \return the current diffuse map texture. - \b {Note:} By default the diffuse texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::diffuse + + Holds the current diffuse map texture. + + By default, the diffuse texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::diffuse() const { @@ -220,11 +232,17 @@ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::diffuse() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::normal() const - \return the current normal map texture. - \b {Note:} By default the normal texture has linear minification - and magnification filters, the wrap mode is repeat and maximum anisotropy - is set to 16.0. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::normal + + Holds the current normal map texture. + + By default, the normal texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::normal() const { @@ -233,12 +251,18 @@ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::normal() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::specular() const - \return the current specular map texture. - \b {Note:} By default the specular texture has a linear - magnification filter, a linear mipmap linear minification filter, - the wrap mode is repeat, the maximum anisotropy is set to 16.0 - and mipmapping is enabled. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::specular + + Holds the current specular map texture. + + By default, the specular texture has the following properties: + + \list + \li Linear minification and magnification filters + \li Linear mipmap with mipmapping enabled + \li Repeat wrap mode + \li Maximum anisotropy of 16.0 + \endlist */ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::specular() const { @@ -247,8 +271,9 @@ QAbstractTextureProvider *QNormalDiffuseSpecularMapMaterial::specular() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::shininess() const - \return the current shininess as a float value. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::shininess + + Holds the current shininess as a float value. */ float QNormalDiffuseSpecularMapMaterial::shininess() const { @@ -257,8 +282,9 @@ float QNormalDiffuseSpecularMapMaterial::shininess() const } /*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::textureScale() const - \return the current texture scale. + \property Qt3D::QNormalDiffuseSpecularMapMaterial::textureScale + + Holds the current texture scale as a float value. */ float QNormalDiffuseSpecularMapMaterial::textureScale() const { @@ -266,60 +292,36 @@ float QNormalDiffuseSpecularMapMaterial::textureScale() const return d->m_textureScaleParameter->value().toFloat(); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setAmbient(const QColor &ambient) - Sets the current ambient color to \a ambient - */ void QNormalDiffuseSpecularMapMaterial::setAmbient(const QColor &ambient) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_ambientParameter->setValue(ambient); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setDiffuse(QTexture *diffuse) - Sets the current diffuse map to \a diffuse. - */ void QNormalDiffuseSpecularMapMaterial::setDiffuse(QAbstractTextureProvider *diffuse) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_diffuseParameter->setValue(QVariant::fromValue(diffuse)); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setNormal(QTexture *normal) - Sets the current normal map to \a normal. - */ void QNormalDiffuseSpecularMapMaterial::setNormal(QAbstractTextureProvider *normal) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_normalParameter->setValue(QVariant::fromValue(normal)); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setSpecular(QTexture *specular) - Sets the current specular map to \a specular. - */ void QNormalDiffuseSpecularMapMaterial::setSpecular(QAbstractTextureProvider *specular) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_specularParameter->setValue(QVariant::fromValue(specular)); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setShininess(float shininess) - Sets the current shininess value to \a shininess. - */ void QNormalDiffuseSpecularMapMaterial::setShininess(float shininess) { Q_D(QNormalDiffuseSpecularMapMaterial); d->m_shininessParameter->setValue(shininess); } -/*! - \fn Qt3D::QNormalDiffuseSpecularMapMaterial::setTextureScale(float textureScale) - Sets the current texture scale to \a textureScale. - */ void QNormalDiffuseSpecularMapMaterial::setTextureScale(float textureScale) { Q_D(QNormalDiffuseSpecularMapMaterial); diff --git a/src/render/defaults/qpervertexcolormaterial.cpp b/src/render/defaults/qpervertexcolormaterial.cpp index e2bc66f86..a3191f6b9 100644 --- a/src/render/defaults/qpervertexcolormaterial.cpp +++ b/src/render/defaults/qpervertexcolormaterial.cpp @@ -51,6 +51,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QPerVertexColorMaterialPrivate + \internal +*/ QPerVertexColorMaterialPrivate::QPerVertexColorMaterialPrivate(QPerVertexColorMaterial *qq) : QMaterialPrivate(qq) , m_vertexEffect(new QEffect()) diff --git a/src/render/defaults/qphongmaterial.cpp b/src/render/defaults/qphongmaterial.cpp index a6e336776..68023e3a1 100644 --- a/src/render/defaults/qphongmaterial.cpp +++ b/src/render/defaults/qphongmaterial.cpp @@ -51,6 +51,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QPhongMaterialPrivate + \internal +*/ QPhongMaterialPrivate::QPhongMaterialPrivate(QPhongMaterial *qq) : QMaterialPrivate(qq) , m_phongEffect(new QEffect()) @@ -110,16 +114,16 @@ QPhongMaterial::QPhongMaterial(QNode *parent) /*! \fn Qt3D::QPhongMaterial::~QPhongMaterial() - Destroys the QPhongMaterial + Destroys the QPhongMaterial. */ QPhongMaterial::~QPhongMaterial() { } /*! - \fn QColor Qt3D::QPhongMaterial::ambient() const + \property Qt3D::QPhongMaterial::ambient - Returns the ambient color. + Holds the ambient color. */ QColor QPhongMaterial::ambient() const { @@ -128,9 +132,9 @@ QColor QPhongMaterial::ambient() const } /*! - \fn QColor Qt3D::QPhongMaterial::diffuse() const + \property Qt3D::QPhongMaterial::diffuse - Returns the diffuse color. + Holds the diffuse color. */ QColor QPhongMaterial::diffuse() const { @@ -139,9 +143,9 @@ QColor QPhongMaterial::diffuse() const } /*! - \fn QColor Qt3D::QPhongMaterial::specular() const + \property QColor Qt3D::QPhongMaterial::specular - Returns the specular color. + Holds the specular color. */ QColor QPhongMaterial::specular() const { @@ -150,9 +154,9 @@ QColor QPhongMaterial::specular() const } /*! - \fn Qt3D::QPhongMaterial::shininess() const + \property Qt3D::QPhongMaterial::shininess - Returns the shininess exponent. + Holds the shininess exponent. */ float QPhongMaterial::shininess() const { @@ -160,44 +164,24 @@ float QPhongMaterial::shininess() const return d->m_shininessParameter->value().toFloat(); } -/*! - \fn Qt3D::QPhongMaterial::setAmbient(const QColor &ambient) - - Sets the current ambient color to \a ambient. -*/ void QPhongMaterial::setAmbient(const QColor &ambient) { Q_D(QPhongMaterial); d->m_shininessParameter->setValue(ambient); } -/*! - \fn Qt3D::QPhongMaterial::setDiffuse(const QColor &diffuse) - - Sets the current diffuse color to \a diffuse. -*/ void QPhongMaterial::setDiffuse(const QColor &diffuse) { Q_D(QPhongMaterial); d->m_diffuseParameter->setValue(diffuse); } -/*! - \fn Qt3D::QPhongMaterial::setSpecular(const QColor &specular) - - Sets the current specular color to \a specular. -*/ void QPhongMaterial::setSpecular(const QColor &specular) { Q_D(QPhongMaterial); d->m_specularParameter->setValue(specular); } -/*! - \fn Qt3D::QPhongMaterial::setShininess(float shininess) - - Sets the current shininess exponent to \a shininess. -*/ void QPhongMaterial::setShininess(float shininess) { Q_D(QPhongMaterial); diff --git a/src/render/doc/qt3drender.qdocconf b/src/render/doc/qt3drender.qdocconf index 415f5d1ea..204f96baa 100644 --- a/src/render/doc/qt3drender.qdocconf +++ b/src/render/doc/qt3drender.qdocconf @@ -35,5 +35,10 @@ exampledirs += ../../../examples/qt3d \ imagedirs += images +Cpp.ignoretokens += QT3DRENDERERSHARED_EXPORT \ + QT3DRENDERERSHARED_PRIVATE_EXPORT + +Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY + navigation.landingpage = "Qt3D Render" navigation.cppclassespage = "Qt3D Render C++ Classes" diff --git a/src/render/doc/src/qt3drender-module.qdoc b/src/render/doc/src/qt3drender-module.qdoc index dd2f22a3b..37de124f1 100644 --- a/src/render/doc/src/qt3drender-module.qdoc +++ b/src/render/doc/src/qt3drender-module.qdoc @@ -40,16 +40,10 @@ \brief The Qt3D Render module contains functionality to support 2D and 3D rendering using Qt3D. \ingroup modules - \qtvariable qt3drender + \qtvariable 3drender The Qt3D Render module provides an aspect, components, and other supporting types necessary to implement 2D and 3D rendering as part of the Qt3D framework. -*/ - -/*! - \namespace Qt3D - \inmodule Qt3DRender - The Qt3D namespace contains user-visible classes and types that provide the ability to render - using the Qt3D framework. + Classes, types, and functions are declared under the \l [Qt3DCore]{Qt3D} namespace. */ diff --git a/src/render/frontend/framegraph-components/qcameraselector.cpp b/src/render/frontend/framegraph-components/qcameraselector.cpp index acd6711a2..e679d6b8f 100644 --- a/src/render/frontend/framegraph-components/qcameraselector.cpp +++ b/src/render/frontend/framegraph-components/qcameraselector.cpp @@ -44,11 +44,20 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::CameraSelector +*/ + +/*! \internal */ QCameraSelector::QCameraSelector(QCameraSelectorPrivate &dd, QNode *parent) : QFrameGraphNode(dd, parent) { } +/*! + \class Qt3D::QCameraSelectorPrivate + \internal +*/ QCameraSelectorPrivate::QCameraSelectorPrivate(Qt3D::QCameraSelector *qq) : QFrameGraphNodePrivate(qq) , m_camera(Q_NULLPTR) diff --git a/src/render/frontend/framegraph-components/qclearbuffer.cpp b/src/render/frontend/framegraph-components/qclearbuffer.cpp index 48df3b945..41a069551 100644 --- a/src/render/frontend/framegraph-components/qclearbuffer.cpp +++ b/src/render/frontend/framegraph-components/qclearbuffer.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QClearBufferPrivate + \internal +*/ QClearBufferPrivate::QClearBufferPrivate(QClearBuffer *qq) : QFrameGraphNodePrivate(qq) , m_buffersType(QClearBuffer::None) @@ -63,6 +67,7 @@ QClearBuffer::QClearBuffer(QNode *parent) { } +/*! \internal */ QClearBuffer::QClearBuffer(QClearBufferPrivate &dd, QNode *parent) : QFrameGraphNode(dd, parent) { diff --git a/src/render/frontend/framegraph-components/qframegraph.cpp b/src/render/frontend/framegraph-components/qframegraph.cpp index 4069b4bdd..4f44703b0 100644 --- a/src/render/frontend/framegraph-components/qframegraph.cpp +++ b/src/render/frontend/framegraph-components/qframegraph.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QFrameGraphPrivate + \internal +*/ QFrameGraphPrivate::QFrameGraphPrivate(QFrameGraph *qq) : QComponentPrivate(qq) , m_activeFrameGraph(Q_NULLPTR) @@ -59,7 +63,7 @@ void QFrameGraph::copy(const QNode *ref) } /*! - * \class FrameGraph + * \class Qt3D::FrameGraph * * \brief Component that has an activeFrameGraph property that should * reference the root FrameGraphItem of a frame graph tree. The Entity @@ -69,7 +73,6 @@ void QFrameGraph::copy(const QNode *ref) * Note that only a single FrameGraph can be active at any moment. * * \since 5.3 - * \namespace Qt3D */ QFrameGraph::QFrameGraph(QNode *parent) @@ -77,13 +80,16 @@ QFrameGraph::QFrameGraph(QNode *parent) { } +/*! \internal */ QFrameGraph::QFrameGraph(QFrameGraphPrivate &dd, QNode *parent) : QComponent(dd, parent) { } /*! - * Returns the current activeFrameGraph root node. + * \property Qt3D::QFrameGraph::activeFrameGraph + * + * Holds the current activeFrameGraph root node. */ QFrameGraphNode *QFrameGraph::activeFrameGraph() const { @@ -91,9 +97,6 @@ QFrameGraphNode *QFrameGraph::activeFrameGraph() const return d->m_activeFrameGraph; } -/*! - * Sets the root node \a activeFrameGraph of the FrameGraph. - */ void QFrameGraph::setActiveFrameGraph(QFrameGraphNode *activeFrameGraph) { Q_D(QFrameGraph); diff --git a/src/render/frontend/framegraph-components/qframegraphnode.cpp b/src/render/frontend/framegraph-components/qframegraphnode.cpp index 5bd45e753..7bf379b4b 100644 --- a/src/render/frontend/framegraph-components/qframegraphnode.cpp +++ b/src/render/frontend/framegraph-components/qframegraphnode.cpp @@ -38,7 +38,7 @@ #include "qframegraphnode_p.h" /*! - * \class FrameGraphNode + * \class Qt3D::FrameGraphNode * * \brief Base class of all FrameGraph configuration nodes. * @@ -46,13 +46,16 @@ * but rather through one of its subclasses. * * \since 5.3 - * \namespace Qt3D */ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QFrameGraphNodePrivate + \internal +*/ QFrameGraphNodePrivate::QFrameGraphNodePrivate(QFrameGraphNode *qq) : QNodePrivate(qq) , m_enabled(true) @@ -69,6 +72,7 @@ QFrameGraphNode::QFrameGraphNode(QNode *parent) { } +/*! \internal */ QFrameGraphNode::QFrameGraphNode(QFrameGraphNodePrivate &dd, QNode *parent) : QNode(dd, parent) { @@ -98,6 +102,12 @@ QList<QFrameGraphNode *> QFrameGraphNode::frameGraphChildren() const return d->m_fgChildren; } +/*! + \property Qt3D::QFrameGraphNode::enabled + + Holds whether the frame graph node is enabled or disabled. +*/ + bool QFrameGraphNode::isEnabled() const { Q_D(const QFrameGraphNode); diff --git a/src/render/frontend/framegraph-components/qframegraphselector.cpp b/src/render/frontend/framegraph-components/qframegraphselector.cpp index 6550543c5..84f88dff7 100644 --- a/src/render/frontend/framegraph-components/qframegraphselector.cpp +++ b/src/render/frontend/framegraph-components/qframegraphselector.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QFrameGraphSelectorPrivate + \internal +*/ QFrameGraphSelectorPrivate::QFrameGraphSelectorPrivate(QFrameGraphSelector *qq) : QFrameGraphNodePrivate(qq) { diff --git a/src/render/frontend/framegraph-components/qlayerfilter.cpp b/src/render/frontend/framegraph-components/qlayerfilter.cpp index 9ba19cd7e..838aca131 100644 --- a/src/render/frontend/framegraph-components/qlayerfilter.cpp +++ b/src/render/frontend/framegraph-components/qlayerfilter.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QLayerFilterPrivate + \internal +*/ QLayerFilterPrivate::QLayerFilterPrivate(QLayerFilter *qq) : QFrameGraphNodePrivate(qq) { @@ -61,6 +65,7 @@ QLayerFilter::QLayerFilter(QNode *parent) { } +/*! \internal */ QLayerFilter::QLayerFilter(QLayerFilterPrivate &dd, QNode *parent) : QFrameGraphNode(dd, parent) { diff --git a/src/render/frontend/framegraph-components/qrenderpassfilter.cpp b/src/render/frontend/framegraph-components/qrenderpassfilter.cpp index 5f22b90f2..442233f0c 100644 --- a/src/render/frontend/framegraph-components/qrenderpassfilter.cpp +++ b/src/render/frontend/framegraph-components/qrenderpassfilter.cpp @@ -44,10 +44,16 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRenderPassFilterPrivate + \internal +*/ + QRenderPassFilter::QRenderPassFilter(QNode *parent) : QFrameGraphNode(*new QRenderPassFilterPrivate(this), parent) {} +/*! \internal */ QRenderPassFilter::QRenderPassFilter(QRenderPassFilterPrivate &dd, QNode *parent) : QFrameGraphNode(dd, parent) { diff --git a/src/render/frontend/framegraph-components/qrendertargetselector.cpp b/src/render/frontend/framegraph-components/qrendertargetselector.cpp index ff250b4e2..3307d4879 100644 --- a/src/render/frontend/framegraph-components/qrendertargetselector.cpp +++ b/src/render/frontend/framegraph-components/qrendertargetselector.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRenderTargetSelectorPrivate + \internal +*/ QRenderTargetSelectorPrivate::QRenderTargetSelectorPrivate(QRenderTargetSelector *qq) : QFrameGraphNodePrivate(qq) , m_target(Q_NULLPTR) @@ -86,6 +90,7 @@ QRenderTarget *QRenderTargetSelector::target() const return d->m_target; } +/*! \internal */ QRenderTargetSelector::QRenderTargetSelector(QRenderTargetSelectorPrivate &dd, QNode *parent) : QFrameGraphNode(dd, parent) { diff --git a/src/render/frontend/framegraph-components/qsortcriterion.cpp b/src/render/frontend/framegraph-components/qsortcriterion.cpp index f7381ec6d..631a9e595 100644 --- a/src/render/frontend/framegraph-components/qsortcriterion.cpp +++ b/src/render/frontend/framegraph-components/qsortcriterion.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QSortCriterionPrivate + \internal +*/ QSortCriterionPrivate::QSortCriterionPrivate(QSortCriterion *qq) : QNodePrivate(qq) , m_sort(QSortCriterion::StateChangeCost) @@ -76,6 +80,7 @@ void QSortCriterion::setSort(QSortCriterion::SortType &sort) } } +/*! \internal */ QSortCriterion::QSortCriterion(QSortCriterionPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/render/frontend/framegraph-components/qsortmethod.cpp b/src/render/frontend/framegraph-components/qsortmethod.cpp index 08725b6f6..f778e33a3 100644 --- a/src/render/frontend/framegraph-components/qsortmethod.cpp +++ b/src/render/frontend/framegraph-components/qsortmethod.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QSortMethodPrivate + \internal +*/ QSortMethodPrivate::QSortMethodPrivate(QSortMethod *qq) : QFrameGraphNodePrivate(qq) { @@ -62,6 +66,7 @@ QSortMethod::QSortMethod(QNode *parent) { } +/*! \internal */ QSortMethod::QSortMethod(QSortMethodPrivate &dd, QNode *parent) : QFrameGraphNode(dd, parent) { diff --git a/src/render/frontend/framegraph-components/qtechniquefilter.cpp b/src/render/frontend/framegraph-components/qtechniquefilter.cpp index 4fbbb0c75..2e625988a 100644 --- a/src/render/frontend/framegraph-components/qtechniquefilter.cpp +++ b/src/render/frontend/framegraph-components/qtechniquefilter.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QTechniqueFilterPrivate + \internal +*/ QTechniqueFilterPrivate::QTechniqueFilterPrivate(QTechniqueFilter *qq) : QFrameGraphNodePrivate(qq) { @@ -64,6 +68,7 @@ QTechniqueFilter::QTechniqueFilter(QNode *parent) { } +/*! \internal */ QTechniqueFilter::QTechniqueFilter(QTechniqueFilterPrivate &dd, QNode *parent) : QFrameGraphNode(dd, parent) { diff --git a/src/render/frontend/framegraph-components/qviewport.cpp b/src/render/frontend/framegraph-components/qviewport.cpp index 481cf54b2..fda834176 100644 --- a/src/render/frontend/framegraph-components/qviewport.cpp +++ b/src/render/frontend/framegraph-components/qviewport.cpp @@ -43,6 +43,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QViewportPrivate + \internal +*/ QViewportPrivate::QViewportPrivate(QViewport *qq) : QFrameGraphNodePrivate(qq) { @@ -62,6 +66,7 @@ QViewport::QViewport(QNode *parent) { } +/*! \internal */ QViewport::QViewport(QViewportPrivate &dd, QNode *parent) : QFrameGraphNode(dd, parent) { diff --git a/src/render/frontend/qabstractlight.cpp b/src/render/frontend/qabstractlight.cpp index 7dbbc531c..1a0865536 100644 --- a/src/render/frontend/qabstractlight.cpp +++ b/src/render/frontend/qabstractlight.cpp @@ -50,6 +50,10 @@ namespace Qt3D */ +/*! + \class Qt3D::QAbstractLightPrivate + \internal +*/ QAbstractLightPrivate::QAbstractLightPrivate(QAbstractLight *qq) : QShaderDataPrivate(qq) , m_color(QColor(255, 255, 255)) @@ -67,6 +71,10 @@ void QAbstractLight::copy(const QNode *ref) } /*! + \class Qt3D::QAbstractLight +*/ + +/*! * Constructs a new QAbstractLight with the given \a parent. */ QAbstractLight::QAbstractLight(Qt3D::QNode *parent) : @@ -74,7 +82,7 @@ QAbstractLight::QAbstractLight(Qt3D::QNode *parent) : { } - +/*! \internal */ QAbstractLight::QAbstractLight(QAbstractLightPrivate &dd, QNode *parent) : QShaderData(dd, parent) { @@ -82,7 +90,9 @@ QAbstractLight::QAbstractLight(QAbstractLightPrivate &dd, QNode *parent) /*! - * Returns the current QAbstractLight color. + * \property Qt3D::QAbstractLight::color + * + * Holds the current QAbstractLight color. */ QColor QAbstractLight::color() const { @@ -90,11 +100,6 @@ QColor QAbstractLight::color() const return d->m_color; } -/*! - * Sets the current QAbstractLight \a color; - * - * \sa void QAbstractLight::colorChanged(); - */ void QAbstractLight::setColor(const QColor &color) { Q_D(QAbstractLight); @@ -104,6 +109,11 @@ void QAbstractLight::setColor(const QColor &color) } } +/*! + \property Qt3D::QAbstractLight::intensity + + Holds the current QAbstractLight intensity. +*/ float QAbstractLight::intensity() const { Q_D(const QAbstractLight); @@ -119,6 +129,11 @@ void QAbstractLight::setIntensity(float intensity) } } +/*! + \property Qt3D::QAbstractLight::position + + Holds the current QAbstractLight position. +*/ void QAbstractLight::setPosition(const QVector3D &position) { Q_D(QAbstractLight); diff --git a/src/render/frontend/qabstractmesh.cpp b/src/render/frontend/qabstractmesh.cpp index 94495f23d..6a12ac66d 100644 --- a/src/render/frontend/qabstractmesh.cpp +++ b/src/render/frontend/qabstractmesh.cpp @@ -39,8 +39,7 @@ #include <Qt3DCore/qscenepropertychange.h> /*! - * \class QAbstractMesh - * \namespace Qt3D + * \class Qt3D::QAbstractMesh * * \brief Provides an abstract class that should be the base of all Mesh * primitives in a scene @@ -55,6 +54,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAbstractMeshPrivate + \internal +*/ QAbstractMeshPrivate::QAbstractMeshPrivate(QAbstractMesh *qq) : QComponentPrivate(qq) { @@ -73,6 +76,7 @@ QAbstractMesh::QAbstractMesh(QNode *parent) { } +/*! \internal */ QAbstractMesh::QAbstractMesh(QAbstractMeshPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/render/frontend/qabstractsceneloader.cpp b/src/render/frontend/qabstractsceneloader.cpp index 9e0b06aec..916d4c801 100644 --- a/src/render/frontend/qabstractsceneloader.cpp +++ b/src/render/frontend/qabstractsceneloader.cpp @@ -47,6 +47,10 @@ namespace Qt3D { namespace Render { +/*! + \class Qt3D::Render::QAbstractSceneLoaderPrivate + \internal +*/ QAbstractSceneLoaderPrivate::QAbstractSceneLoaderPrivate(QAbstractSceneLoader *qq) : QComponentPrivate(qq) , m_status(QAbstractSceneLoader::Loading) @@ -54,6 +58,7 @@ QAbstractSceneLoaderPrivate::QAbstractSceneLoaderPrivate(QAbstractSceneLoader *q m_shareable = false; } +/*! \internal */ QAbstractSceneLoader::QAbstractSceneLoader(QAbstractSceneLoaderPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/render/frontend/qabstracttextureimage.cpp b/src/render/frontend/qabstracttextureimage.cpp index 8f012652c..df2adbf21 100644 --- a/src/render/frontend/qabstracttextureimage.cpp +++ b/src/render/frontend/qabstracttextureimage.cpp @@ -43,6 +43,11 @@ QT_BEGIN_NAMESPACE namespace Qt3D { /*! + \class Qt3D::QAbstractTextureImagePrivate + \internal +*/ + +/*! \class Qt3D::QAbstractTextureImage \since 5.5 \brief Encapsulates the necessary information to create an OpenGL texture image. @@ -73,7 +78,9 @@ QAbstractTextureImage::~QAbstractTextureImage() } /*! - \return the mipmal level of the texture image. + \property Qt3D::QAbstractTextureImage::mipmapLevel + + Holds the mipmap level of the texture image. */ int QAbstractTextureImage::mipmapLevel() const { @@ -82,7 +89,9 @@ int QAbstractTextureImage::mipmapLevel() const } /*! - \return the layer of the texture image. + \property Qt3D::QAbstractTextureImage::layer + + Holds the layer of the texture image. */ int QAbstractTextureImage::layer() const { @@ -91,7 +100,13 @@ int QAbstractTextureImage::layer() const } /*! - \return the cube map face of the texture image. + \property Qt3D::QAbstractTextureImage::cubeMapFace + + Holds the cube map face of the texture image. + + \note The cube map face has a meaning only for + \l {QAbstractTextureProvider::}{TargetCubeMap} and + \l {QAbstractTextureProvider::}{TargetCubeMapArray}. */ QAbstractTextureProvider::CubeMapFace QAbstractTextureImage::cubeMapFace() const { @@ -99,9 +114,6 @@ QAbstractTextureProvider::CubeMapFace QAbstractTextureImage::cubeMapFace() const return d->m_face; } -/*! - Sets the mipmap level of the texture image to \a level. - */ void QAbstractTextureImage::setMipmapLevel(int level) { Q_D(QAbstractTextureImage); @@ -111,11 +123,6 @@ void QAbstractTextureImage::setMipmapLevel(int level) } } -/*! - Sets the layer of the texture image to \a layer. - \note: has a meaning only for Target2DArray, TargetCubeMapArray and Target3D - Qt3D::QAbstractTextureProvider. - */ void QAbstractTextureImage::setLayer(int layer) { Q_D(QAbstractTextureImage); @@ -125,11 +132,6 @@ void QAbstractTextureImage::setLayer(int layer) } } -/*! - Sets the cube map face of the texture image to \a face. - \note: has a meaning only for TargetCubeMap and TargetCubeMapArray - Qt3D::QAbstractTextureProvider. - */ void QAbstractTextureImage::setCubeMapFace(QAbstractTextureProvider::CubeMapFace face) { Q_D(QAbstractTextureImage); @@ -140,7 +142,7 @@ void QAbstractTextureImage::setCubeMapFace(QAbstractTextureProvider::CubeMapFace } /*! - Triggers an update of the data functor that is sent to the backend + Triggers an update of the data functor that is sent to the backend. */ void QAbstractTextureImage::update() { @@ -161,6 +163,7 @@ void QAbstractTextureImage::copy(const QNode *ref) d_func()->m_mipmapLevel = imageRef->mipmapLevel(); } +/*! \internal */ QAbstractTextureImage::QAbstractTextureImage(QAbstractTextureImagePrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/render/frontend/qabstracttextureprovider.cpp b/src/render/frontend/qabstracttextureprovider.cpp index 8d08b76b6..549332c0c 100644 --- a/src/render/frontend/qabstracttextureprovider.cpp +++ b/src/render/frontend/qabstracttextureprovider.cpp @@ -43,6 +43,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAbstractTextureProviderPrivate + \internal +*/ QAbstractTextureProviderPrivate::QAbstractTextureProviderPrivate(QAbstractTextureProvider *qq) : QNodePrivate(qq) , m_target(QAbstractTextureProvider::Target2D) @@ -85,7 +89,7 @@ void QAbstractTextureProvider::copy(const QNode *ref) /*! \class Qt3D::QAbstractTextureProvider \since 5.5 - \brief Qt3D::QAbstractTextureProvider is a base class to be used to provide textures. + \brief A base class to be used to provide textures. Qt3D::QAbstractTextureProvider shouldn't be used directly but rather through one of its subclasses. Each subclass implements a given texture @@ -107,6 +111,7 @@ QAbstractTextureProvider::QAbstractTextureProvider(Target target, QNode *parent) d_func()->m_target = target; } +/*! \internal */ QAbstractTextureProvider::QAbstractTextureProvider(QAbstractTextureProviderPrivate &dd, QNode *parent) : QNode(dd, parent) { @@ -117,7 +122,7 @@ QAbstractTextureProvider::~QAbstractTextureProvider() } /*! - Sets the size of the texture provider to width \a, height \a h and depth \a d. + Sets the size of the texture provider to width \a w, height \a h and depth \a d. */ void QAbstractTextureProvider::setSize(int w, int h, int d) { @@ -127,7 +132,9 @@ void QAbstractTextureProvider::setSize(int w, int h, int d) } /*! - Sets the width of the texture provider to \a width. + \property Qt3D::QAbstractTextureProvider::width + + Holds the width of the texture provider. */ void QAbstractTextureProvider::setWidth(int width) { @@ -139,7 +146,9 @@ void QAbstractTextureProvider::setWidth(int width) } /*! - Sets the height of the texture provider to \a height. + \property Qt3D::QAbstractTextureProvider::height + + Holds the height of the texture provider. */ void QAbstractTextureProvider::setHeight(int height) { @@ -151,7 +160,9 @@ void QAbstractTextureProvider::setHeight(int height) } /*! - Sets the depth of the texture provider to \a depth. + \property Qt3D::QAbstractTextureProvider::depth + + Holds the depth of the texture provider. */ void QAbstractTextureProvider::setDepth(int depth) { @@ -162,27 +173,18 @@ void QAbstractTextureProvider::setDepth(int depth) } } -/*! - \returns the width of the texture provider. - */ int QAbstractTextureProvider::width() const { Q_D(const QAbstractTextureProvider); return d->m_width; } -/*! - \returns the height of the texture provider. - */ int QAbstractTextureProvider::height() const { Q_D(const QAbstractTextureProvider); return d->m_height; } -/*! - \returns the depth of the texture provider. - */ int QAbstractTextureProvider::depth() const { Q_D(const QAbstractTextureProvider); @@ -190,11 +192,13 @@ int QAbstractTextureProvider::depth() const } /*! - Sets the maximum layers count to \a maximumLayers, by defaults, the maximum - layer count is 1. + \property Qt3D::QAbstractTextureProvider::maximumLayers + + Holds the maximum layer count of the texture provider. By default, the + maximum layer count is 1. - \note this has a meaning only for texture providers that - have 3D or array target formats. + \note this has a meaning only for texture providers that have 3D or + array target formats. */ void QAbstractTextureProvider::setMaximumLayers(int maximumLayers) { @@ -205,10 +209,6 @@ void QAbstractTextureProvider::setMaximumLayers(int maximumLayers) } } -/*! - \return return the maximum layers count of the texture provider. - \note this has a meaning only for texture providers that have 3D or array target formats. - */ int QAbstractTextureProvider::maximumLayers() const { Q_D(const QAbstractTextureProvider); @@ -216,7 +216,9 @@ int QAbstractTextureProvider::maximumLayers() const } /*! - Sets the format of the texture provider to \a format. + \property Qt3D::QAbstractTextureProvider::format + + Holds the format of the texture provider. */ void QAbstractTextureProvider::setFormat(TextureFormat format) { @@ -227,9 +229,6 @@ void QAbstractTextureProvider::setFormat(TextureFormat format) } } -/*! - \returns the format of the texture provider. - */ QAbstractTextureProvider::TextureFormat QAbstractTextureProvider::format() const { Q_D(const QAbstractTextureProvider); @@ -237,7 +236,9 @@ QAbstractTextureProvider::TextureFormat QAbstractTextureProvider::format() const } /*! - Sets the current status of the texture provider to \a status. + \property Qt3D::QAbstractTextureProvider::status readonly + + Holds the current status of the texture provider. */ void QAbstractTextureProvider::setStatus(Status status) { @@ -248,9 +249,6 @@ void QAbstractTextureProvider::setStatus(Status status) } } -/*! - \returns the current status of the texture provider. - */ QAbstractTextureProvider::Status QAbstractTextureProvider::status() const { Q_D(const QAbstractTextureProvider); @@ -258,8 +256,11 @@ QAbstractTextureProvider::Status QAbstractTextureProvider::status() const } /*! - \returns the target format of the texture provider. - \note: The target format can only be set once. + \property Qt3D::QAbstractTextureProvider::target readonly + + Holds the target format of the texture provider. + + \note The target format can only be set once. */ QAbstractTextureProvider::Target QAbstractTextureProvider::target() const { @@ -268,8 +269,10 @@ QAbstractTextureProvider::Target QAbstractTextureProvider::target() const } /*! - Adds a new Qt3D::QAbstractTextureImage \a texture image to the texture provider. - \note: Qt3D::QAbstractTextureImage should never be shared by several Qt3D::QAbstractTextureProvider + Adds a new Qt3D::QAbstractTextureImage \a textureImage to the texture provider. + + \note Qt3D::QAbstractTextureImage should never be shared between multiple + Qt3D::QAbstractTextureProvider instances. */ void QAbstractTextureProvider::addTextureImage(QAbstractTextureImage *textureImage) { @@ -297,7 +300,7 @@ void QAbstractTextureProvider::addTextureImage(QAbstractTextureImage *textureIma } /*! - Removes a Qt3D::QAbstractTextureImage \a texture image form the texture provider. + Removes a Qt3D::QAbstractTextureImage \a textureImage from the texture provider. */ void QAbstractTextureProvider::removeTextureImage(QAbstractTextureImage *textureImage) { @@ -312,7 +315,8 @@ void QAbstractTextureProvider::removeTextureImage(QAbstractTextureImage *texture } /*! -\return the list of QAbstractTextureImage * contained in the texture provider. + Returns a list of pointers to QAbstractTextureImage objects contained in + the texture provider. */ QList<QAbstractTextureImage *> QAbstractTextureProvider::textureImages() const { @@ -321,7 +325,9 @@ QList<QAbstractTextureImage *> QAbstractTextureProvider::textureImages() const } /*! - Sets whether the texture provider should auto generate mipmaps. + \property Qt3D::QAbstractTextureProvider::generateMipMaps + + Holds whether the texture provider should auto generate mipmaps. */ void QAbstractTextureProvider::setGenerateMipMaps(bool gen) { @@ -332,9 +338,6 @@ void QAbstractTextureProvider::setGenerateMipMaps(bool gen) } } -/*! - \returns whether texture provider auto generates mipmaps. - */ bool QAbstractTextureProvider::generateMipMaps() const { Q_D(const QAbstractTextureProvider); @@ -342,7 +345,9 @@ bool QAbstractTextureProvider::generateMipMaps() const } /*! - Sets the minification filter of the texture provider to \a f. + \property Qt3D::QAbstractTextureProvider::minificationFilter + + Holds the minification filter of the texture provider. */ void QAbstractTextureProvider::setMinificationFilter(Filter f) { @@ -354,7 +359,9 @@ void QAbstractTextureProvider::setMinificationFilter(Filter f) } /*! - Sets the magnification filter of the texture provider to \a f. + \property Qt3D::QAbstractTextureProvider::magnificationFilter + + Holds the magnification filter of the texture provider. */ void QAbstractTextureProvider::setMagnificationFilter(Filter f) { @@ -365,18 +372,12 @@ void QAbstractTextureProvider::setMagnificationFilter(Filter f) } } -/*! - \returns the minification filter of the texture provider. - */ QAbstractTextureProvider::Filter QAbstractTextureProvider::minificationFilter() const { Q_D(const QAbstractTextureProvider); return d->m_minFilter; } -/*! - \returns the magnification filter of the texture provider. - */ QAbstractTextureProvider::Filter QAbstractTextureProvider::magnificationFilter() const { Q_D(const QAbstractTextureProvider); @@ -384,7 +385,9 @@ QAbstractTextureProvider::Filter QAbstractTextureProvider::magnificationFilter() } /*! - Sets the wrap mode of the texture provider to \a wrapMode. + \property Qt3D::QAbstractTextureProvider::wrapMode + + Holds the wrap mode of the texture provider. */ void QAbstractTextureProvider::setWrapMode(const QTextureWrapMode &wrapMode) { @@ -412,9 +415,6 @@ void QAbstractTextureProvider::setWrapMode(const QTextureWrapMode &wrapMode) } } -/*! - \returns the wrap mode of the texture provider. - */ QTextureWrapMode *QAbstractTextureProvider::wrapMode() { Q_D(QAbstractTextureProvider); @@ -422,7 +422,9 @@ QTextureWrapMode *QAbstractTextureProvider::wrapMode() } /*! - Sets the maximum anisotropy of the texture provider to \a anisotropy. + \property Qt3D::QAbstractTextureProvider::maximumAnisotropy + + Holds the maximum anisotropy of the texture provider. */ void QAbstractTextureProvider::setMaximumAnisotropy(float anisotropy) { @@ -433,9 +435,6 @@ void QAbstractTextureProvider::setMaximumAnisotropy(float anisotropy) } } -/*! - \returns the maximum anisotropy of the texture provider. - */ float QAbstractTextureProvider::maximumAnisotropy() const { Q_D(const QAbstractTextureProvider); @@ -443,7 +442,9 @@ float QAbstractTextureProvider::maximumAnisotropy() const } /*! - Sets the comparison function of the texture provider to \a function. + \property Qt3D::QAbstractTextureProvider::comparisonFunction + + Holds the comparison function of the texture provider. */ void QAbstractTextureProvider::setComparisonFunction(QAbstractTextureProvider::ComparisonFunction function) { @@ -454,9 +455,6 @@ void QAbstractTextureProvider::setComparisonFunction(QAbstractTextureProvider::C } } -/*! - \returns the comparison function of the texture provider. - */ QAbstractTextureProvider::ComparisonFunction QAbstractTextureProvider::comparisonFunction() const { Q_D(const QAbstractTextureProvider); @@ -464,7 +462,9 @@ QAbstractTextureProvider::ComparisonFunction QAbstractTextureProvider::compariso } /*! - Sets the comparison mode of the texture provider to \a mode. + \property Qt3D::QAbstractTextureProvider::comparisonMode + + Holds the comparison mode of the texture provider. */ void QAbstractTextureProvider::setComparisonMode(QAbstractTextureProvider::ComparisonMode mode) { @@ -475,9 +475,6 @@ void QAbstractTextureProvider::setComparisonMode(QAbstractTextureProvider::Compa } } -/*! - \returns the comparison mode of the texture provider. - */ QAbstractTextureProvider::ComparisonMode QAbstractTextureProvider::comparisonMode() const { Q_D(const QAbstractTextureProvider); diff --git a/src/render/frontend/qannotation.cpp b/src/render/frontend/qannotation.cpp index 831017a51..75b4d732e 100644 --- a/src/render/frontend/qannotation.cpp +++ b/src/render/frontend/qannotation.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QAnnotationPrivate + \internal +*/ QAnnotationPrivate::QAnnotationPrivate(QAnnotation *qq) : QNodePrivate(qq) { diff --git a/src/render/frontend/qcolormask.cpp b/src/render/frontend/qcolormask.cpp index 22f130134..95e2e69b2 100644 --- a/src/render/frontend/qcolormask.cpp +++ b/src/render/frontend/qcolormask.cpp @@ -61,16 +61,15 @@ public: }; /*! - \class Qt3D::QColorMask - \brief QColorMask allows to specify which color components should be written - to the currently bound frame buffer. + \brief Allows specifying which color components should be written to the + currently bound frame buffer. - By default each color component (red, green, blue, alpha) is set to true - which means they will be written to the frame buffer. Setting any of the - color component to false will prevent it from being written into the frame - buffer. + By default, the property for each color component (red, green, blue, alpha) + is set to \c true which means they will be written to the frame buffer. + Setting any of the color component to \c false will prevent it from being + written into the frame buffer. */ @@ -86,36 +85,24 @@ QColorMask::~QColorMask() { } -/*! - \return whether the red color component should be written to the frame buffer; - */ bool QColorMask::isRed() const { Q_D(const QColorMask); return d->m_red; } -/*! - \return whether the green color component should be written to the frame buffer; - */ bool QColorMask::isGreen() const { Q_D(const QColorMask); return d->m_green; } -/*! - \return whether the blue color component should be written to the frame buffer; - */ bool QColorMask::isBlue() const { Q_D(const QColorMask); return d->m_blue; } -/*! - \return whether the alpha color component should be written to the frame buffer; - */ bool QColorMask::isAlpha() const { Q_D(const QColorMask); @@ -123,7 +110,8 @@ bool QColorMask::isAlpha() const } /*! - Sets whether the \a red color component should be written to the frame buffer; + \property Qt3D::QColorMask::red + Holds whether the red color component should be written to the frame buffer. */ void QColorMask::setRed(bool red) { @@ -135,7 +123,8 @@ void QColorMask::setRed(bool red) } /*! - Sets whether the \a greem color component should be written to the frame buffer; + \property Qt3D::QColorMask::green + Holds whether the green color component should be written to the frame buffer. */ void QColorMask::setGreen(bool green) { @@ -147,7 +136,8 @@ void QColorMask::setGreen(bool green) } /*! - Sets whether the \a blue color component should be written to the frame buffer; + \property Qt3D::QColorMask::blue + Holds whether the blue color component should be written to the frame buffer. */ void QColorMask::setBlue(bool blue) { @@ -159,7 +149,8 @@ void QColorMask::setBlue(bool blue) } /*! - Sets whether the \a alpha color component should be written to the frame buffer; + \property Qt3D::QColorMask::alpha + Holds whether the alpha component should be written to the frame buffer. */ void QColorMask::setAlpha(bool alpha) { diff --git a/src/render/frontend/qcuboidmesh.cpp b/src/render/frontend/qcuboidmesh.cpp index 42bd15888..33769b1ca 100644 --- a/src/render/frontend/qcuboidmesh.cpp +++ b/src/render/frontend/qcuboidmesh.cpp @@ -48,6 +48,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QCuboidMeshPrivate + \internal +*/ QCuboidMeshPrivate::QCuboidMeshPrivate(QCuboidMesh *qq) : QAbstractMeshPrivate(qq) , m_xExtent(1.0) @@ -77,6 +81,7 @@ QCuboidMesh::QCuboidMesh(QNode *parent) update(); } +/*! \internal */ QCuboidMesh::QCuboidMesh(QCuboidMeshPrivate &dd, QNode *parent) : QAbstractMesh(dd, parent) { diff --git a/src/render/frontend/qdirectionallight.cpp b/src/render/frontend/qdirectionallight.cpp index cf24db3e9..4cfc72a50 100644 --- a/src/render/frontend/qdirectionallight.cpp +++ b/src/render/frontend/qdirectionallight.cpp @@ -61,6 +61,10 @@ namespace Qt3D { * \endcode */ +/*! + \class Qt3D::QDirectionalLightPrivate + \internal +*/ QDirectionalLightPrivate::QDirectionalLightPrivate(QDirectionalLight *qq) : QAbstractLightPrivate(qq) { @@ -80,6 +84,7 @@ QDirectionalLight::QDirectionalLight(QNode *parent) { } +/*! \internal */ QDirectionalLight::QDirectionalLight(QDirectionalLightPrivate &dd, QNode *parent) : QAbstractLight(dd, parent) { diff --git a/src/render/frontend/qeffect.cpp b/src/render/frontend/qeffect.cpp index 57527fc4b..03e86282e 100644 --- a/src/render/frontend/qeffect.cpp +++ b/src/render/frontend/qeffect.cpp @@ -45,6 +45,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QEffectPrivate + \internal +*/ QEffectPrivate::QEffectPrivate(QEffect *qq) : QNodePrivate(qq) {} @@ -65,6 +69,7 @@ void QEffect::copy(const QNode* ref) addTechnique(qobject_cast<QTechnique *>(QNode::clone(t))); } +/*! \internal */ QEffect::QEffect(QEffectPrivate &dd, QNode *parent) : QNode(dd, parent) { @@ -140,7 +145,7 @@ void QEffect::addTechnique(QTechnique *t) } /*! - * Removes a technique \t from the effect. This posts a ComponentRemoved + * Removes a technique \a t from the effect. This posts a ComponentRemoved * QScenePropertyChange notification to the QChangeArbiter, the value is * the removed technique's id and the property name is "technique". */ diff --git a/src/render/frontend/qlayer.cpp b/src/render/frontend/qlayer.cpp index a7886304f..4f96a8fe8 100644 --- a/src/render/frontend/qlayer.cpp +++ b/src/render/frontend/qlayer.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QLayerPrivate + \internal +*/ QLayerPrivate::QLayerPrivate(QLayer *qq) : QComponentPrivate(qq) { @@ -58,6 +62,7 @@ QLayer::QLayer(QNode *parent) { } +/*! \internal */ QLayer::QLayer(QLayerPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/render/frontend/qmaterial.cpp b/src/render/frontend/qmaterial.cpp index e9de8a21c..4cd5713ba 100644 --- a/src/render/frontend/qmaterial.cpp +++ b/src/render/frontend/qmaterial.cpp @@ -43,8 +43,7 @@ #include <Qt3DCore/qscenepropertychange.h> /*! - * \class QMaterial - * \namespace Qt3D + * \class Qt3D::QMaterial * * \inherits Component * @@ -53,16 +52,21 @@ * * QAbstractMaterial provide a way to specify the rendering of an Entity. * Any aspect can define its own subclass of QAbstractMaterial so that a - * Material can be used to describe a visual element, the way sound should - * reflect on an element, the temperature of a surface and so on. + * Material can be used to describe a visual element; for example, the way + * sound should reflect off an element, the temperature of a surface, + * and so on. * - * \sa QEffect, QMesh, QComponent + * \sa QEffect, QMesh, {Qt3D::}{QComponent} */ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QMaterialPrivate + \internal +*/ QMaterialPrivate::QMaterialPrivate(QMaterial *qq) : QComponentPrivate(qq) , m_effect(Q_NULLPTR) @@ -85,6 +89,7 @@ QMaterial::QMaterial(QNode *parent) { } +/*! \internal */ QMaterial::QMaterial(QMaterialPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/render/frontend/qmesh.cpp b/src/render/frontend/qmesh.cpp index c2fb74cf1..a8b7858e5 100644 --- a/src/render/frontend/qmesh.cpp +++ b/src/render/frontend/qmesh.cpp @@ -61,6 +61,10 @@ private: }; +/*! + \class Qt3D::QMeshPrivate + \internal +*/ QMeshPrivate::QMeshPrivate(QMesh *qq) : QAbstractMeshPrivate(qq) {} @@ -77,6 +81,7 @@ QMesh::QMesh(QNode *parent) { } +/*! \internal */ QMesh::QMesh(QMeshPrivate &dd, QNode *parent) : QAbstractMesh(dd, parent) { diff --git a/src/render/frontend/qparameter.cpp b/src/render/frontend/qparameter.cpp index 9a1ec67c5..38833d8a9 100644 --- a/src/render/frontend/qparameter.cpp +++ b/src/render/frontend/qparameter.cpp @@ -45,6 +45,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QParameterPrivate + \internal +*/ QParameterPrivate::QParameterPrivate(QParameter *qq) : QNodePrivate(qq) { @@ -63,6 +67,7 @@ void QParameter::copy(const QNode *ref) d_func()->m_value = param->d_func()->m_value; } +/*! \internal */ QParameter::QParameter(QParameterPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/render/frontend/qparametermapping.cpp b/src/render/frontend/qparametermapping.cpp index 61c4946be..0d9910e2e 100644 --- a/src/render/frontend/qparametermapping.cpp +++ b/src/render/frontend/qparametermapping.cpp @@ -41,6 +41,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QParameterMappingPrivate + \internal +*/ QParameterMappingPrivate::QParameterMappingPrivate(QParameterMapping *qq) : QNodePrivate(qq) , m_bindingType(QParameterMapping::Uniform) @@ -61,6 +65,7 @@ QParameterMapping::QParameterMapping(QNode *parent) { } +/*! \internal */ QParameterMapping::QParameterMapping(QParameterMappingPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/render/frontend/qplanemesh.cpp b/src/render/frontend/qplanemesh.cpp index 17b22cc9b..7d31df1bd 100644 --- a/src/render/frontend/qplanemesh.cpp +++ b/src/render/frontend/qplanemesh.cpp @@ -48,6 +48,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QPlaneMeshPrivate + \internal +*/ QPlaneMeshPrivate::QPlaneMeshPrivate(QPlaneMesh *qq) : QAbstractMeshPrivate(qq) , m_width(1.0f) @@ -71,6 +75,7 @@ void QPlaneMesh::copy(const QNode *ref) d_func()->m_meshResolution = mesh->d_func()->m_meshResolution; } +/*! \internal */ QPlaneMesh::QPlaneMesh(QPlaneMeshPrivate &dd, QNode *parent) : QAbstractMesh(dd, parent) { diff --git a/src/render/frontend/qpointlight.cpp b/src/render/frontend/qpointlight.cpp index 314875157..2d1c9ed43 100644 --- a/src/render/frontend/qpointlight.cpp +++ b/src/render/frontend/qpointlight.cpp @@ -59,6 +59,10 @@ namespace Qt3D { * \endcode */ +/*! + \class Qt3D::QPointLightPrivate + \internal +*/ QPointLightPrivate::QPointLightPrivate(QPointLight *qq) : QAbstractLightPrivate(qq) { @@ -69,6 +73,7 @@ QPointLight::QPointLight(QNode *parent) { } +/*! \internal */ QPointLight::QPointLight(QPointLightPrivate &dd, QNode *parent) : QAbstractLight(dd, parent) { diff --git a/src/render/frontend/qrenderattachment.cpp b/src/render/frontend/qrenderattachment.cpp index fb7892fd9..f4445895e 100644 --- a/src/render/frontend/qrenderattachment.cpp +++ b/src/render/frontend/qrenderattachment.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRenderAttachmentPrivate + \internal +*/ QRenderAttachmentPrivate::QRenderAttachmentPrivate(QRenderAttachment *qq) : QNodePrivate(qq) , m_texture(Q_NULLPTR) @@ -65,6 +69,7 @@ QRenderAttachment::QRenderAttachment(QNode *parent) { } +/*! \internal */ QRenderAttachment::QRenderAttachment(QRenderAttachmentPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/render/frontend/qrenderpass.cpp b/src/render/frontend/qrenderpass.cpp index 3fa5d0308..9482248f5 100644 --- a/src/render/frontend/qrenderpass.cpp +++ b/src/render/frontend/qrenderpass.cpp @@ -48,6 +48,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRenderPassPrivate + \internal +*/ QRenderPassPrivate::QRenderPassPrivate(QRenderPass *qq) : QNodePrivate(qq) , m_shader(Q_NULLPTR) @@ -73,6 +77,7 @@ QRenderPass::QRenderPass(QNode *parent) { } +/*! \internal */ QRenderPass::QRenderPass(QRenderPassPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/render/frontend/qrenderstate.cpp b/src/render/frontend/qrenderstate.cpp index 17375c4c2..69154c155 100644 --- a/src/render/frontend/qrenderstate.cpp +++ b/src/render/frontend/qrenderstate.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRenderStatePrivate + \internal +*/ QRenderStatePrivate::QRenderStatePrivate(QRenderState *qq, QRenderState::Type type) : QNodePrivate(qq), m_type(type) @@ -54,6 +58,7 @@ QRenderState::Type QRenderState::type() const return d->m_type; } +/*! \internal */ QRenderState::QRenderState(QRenderStatePrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/render/frontend/qrendertarget.cpp b/src/render/frontend/qrendertarget.cpp index 3eb3b4e08..764ab04c1 100644 --- a/src/render/frontend/qrendertarget.cpp +++ b/src/render/frontend/qrendertarget.cpp @@ -43,6 +43,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QRenderTargetPrivate + \internal +*/ QRenderTargetPrivate::QRenderTargetPrivate(QRenderTarget *qq) : QComponentPrivate(qq) { @@ -61,6 +65,7 @@ QRenderTarget::QRenderTarget(QNode *parent) { } +/*! \internal */ QRenderTarget::QRenderTarget(QRenderTargetPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/render/frontend/qshaderdata.cpp b/src/render/frontend/qshaderdata.cpp index c209a4c53..02570091c 100644 --- a/src/render/frontend/qshaderdata.cpp +++ b/src/render/frontend/qshaderdata.cpp @@ -41,12 +41,20 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QShaderDataPrivate + \internal +*/ QShaderDataPrivate::QShaderDataPrivate(QShaderData *qq) : QComponentPrivate(qq) , m_propertyReader(PropertyReaderInterfacePtr(new QShaderDataPropertyReader())) { } +/*! + \class Qt3D::QShaderDataPrivate + \internal +*/ QShaderDataPrivate::QShaderDataPrivate(QShaderData *qq, PropertyReaderInterfacePtr reader) : QComponentPrivate(qq) , m_propertyReader(reader) @@ -59,9 +67,9 @@ QShaderDataPrivate::QShaderDataPrivate(QShaderData *qq, PropertyReaderInterfaceP * \brief Provides a way of specifying values of a Uniform Block or a shader * structure. * - * \note When subclassing and adding properties to Qt3D::QShaderData please not - * that if you need to nest inner Qt3D::QShaderData, the data type of the - * property should be Qt3D::QShaderData* and not whatever you named your subclass. + * \note When subclassing and adding properties to Qt3D::QShaderData, please note + * that if you need to nest an inner Qt3D::QShaderData, the data type of the + * property should be Qt3D::QShaderData* instead of the name of your subclass. * * \since 5.5 */ @@ -77,6 +85,7 @@ PropertyReaderInterfacePtr QShaderData::propertyReader() const return d->m_propertyReader; } +/*! \internal */ QShaderData::QShaderData(QShaderDataPrivate &dd, QNode *parent) : QComponent(dd, parent) { diff --git a/src/render/frontend/qshaderprogram.cpp b/src/render/frontend/qshaderprogram.cpp index 15621d55c..8e9e2eaf4 100644 --- a/src/render/frontend/qshaderprogram.cpp +++ b/src/render/frontend/qshaderprogram.cpp @@ -46,6 +46,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QShaderProgramPrivate + \internal +*/ QShaderProgramPrivate::QShaderProgramPrivate(QShaderProgram *qq) : QNodePrivate(qq) { @@ -69,6 +73,7 @@ QShaderProgram::QShaderProgram(QNode *parent) { } +/*! \internal */ QShaderProgram::QShaderProgram(QShaderProgramPrivate &dd, QNode *parent) : QNode(dd, parent) { diff --git a/src/render/frontend/qspotlight.cpp b/src/render/frontend/qspotlight.cpp index 467ceca19..edb6243a3 100644 --- a/src/render/frontend/qspotlight.cpp +++ b/src/render/frontend/qspotlight.cpp @@ -63,6 +63,10 @@ namespace Qt3D { * \endcode */ +/*! + \class Qt3D::QSpotLightPrivate + \internal +*/ QSpotLightPrivate::QSpotLightPrivate(QSpotLight *qq) : QAbstractLightPrivate(qq) , m_cutOffAngle(45.0f) @@ -84,6 +88,7 @@ QSpotLight::QSpotLight(QNode *parent) { } +/*! \internal */ QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent) : QAbstractLight(dd, parent) { diff --git a/src/render/frontend/qtechnique.cpp b/src/render/frontend/qtechnique.cpp index e78d88e01..d6d931caa 100644 --- a/src/render/frontend/qtechnique.cpp +++ b/src/render/frontend/qtechnique.cpp @@ -45,6 +45,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QTechniquePrivate + \internal +*/ QTechniquePrivate::QTechniquePrivate(QTechnique *qq) : QNodePrivate(qq) { @@ -61,6 +65,7 @@ QTechnique::QTechnique(QNode *parent) QObject::connect(&d->m_openGLFilter, SIGNAL(openGLFilterChanged()), this, SLOT(openGLFilterChanged())); } +/*! \internal */ QTechnique::QTechnique(QTechniquePrivate &dd, QNode *parent) : QNode(dd, parent) { @@ -200,7 +205,7 @@ void QTechnique::addPass(QRenderPass *pass) /*! * Removes a \a pass from the technique. This posts a ComponentRemoved * QScenePropertyChange notification to the QChangeArbiter with the value - * being the \a pass' id and the property name being "pass". + * being the id of \a pass and the property name being "pass". */ void QTechnique::removePass(QRenderPass *pass) { diff --git a/src/render/frontend/qtextureimage.cpp b/src/render/frontend/qtextureimage.cpp index 92b69797f..6a46f8b68 100644 --- a/src/render/frontend/qtextureimage.cpp +++ b/src/render/frontend/qtextureimage.cpp @@ -114,7 +114,7 @@ QTextureImage::~QTextureImage() } /*! - \return the source url from which data will be loaded of the texture image. + Returns the source url from which data for the texture image will be loaded. */ QUrl QTextureImage::source() const { @@ -124,7 +124,7 @@ QUrl QTextureImage::source() const /*! Sets the source url of the texture image to \a source. - \note: this triggers a call to update() + \note This triggers a call to update() */ void QTextureImage::setSource(const QUrl &source) { @@ -137,7 +137,7 @@ void QTextureImage::setSource(const QUrl &source) } /*! - \returns the a Qt3D::QTextureDataFunctorPtr functor to be used by the + Returns the Qt3D::QTextureDataFunctorPtr functor to be used by the backend to load the texture image data into an OpenGL texture object. */ QTextureDataFunctorPtr QTextureImage::dataFunctor() const diff --git a/src/render/frontend/qwrapmode.cpp b/src/render/frontend/qwrapmode.cpp index 870c194bf..e73ff6541 100644 --- a/src/render/frontend/qwrapmode.cpp +++ b/src/render/frontend/qwrapmode.cpp @@ -64,8 +64,8 @@ public: \class Qt3D::QTextureWrapMode \since 5.5 - \brief Qt3D::QTextureWrapMode defines the wrap mode a - Qt3D::QAbstractTextureProvider should apply to a texture. + \brief Defines the wrap mode a Qt3D::QAbstractTextureProvider + should apply to a texture. */ QTextureWrapMode::QTextureWrapMode(WrapMode wrapMode, QObject *parent) diff --git a/src/render/io/qattribute.cpp b/src/render/io/qattribute.cpp index a10245241..821a28f1c 100644 --- a/src/render/io/qattribute.cpp +++ b/src/render/io/qattribute.cpp @@ -46,6 +46,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + class Qt3D::AttributePrivate + \internal +*/ AttributePrivate::AttributePrivate(Attribute *qq) : QAbstractAttributePrivate(qq) { @@ -56,6 +60,7 @@ Attribute::Attribute(QAbstractBufferPtr buf, int type, int count, int offset, in { } +/*! \internal */ Attribute::Attribute(AttributePrivate &dd, QAbstractBufferPtr buf, int type, int count, int offset, int stride) : QAbstractAttribute(dd, buf, type, count, offset, stride) { diff --git a/src/render/io/qbuffer.cpp b/src/render/io/qbuffer.cpp index 87366cb62..209f87aca 100644 --- a/src/render/io/qbuffer.cpp +++ b/src/render/io/qbuffer.cpp @@ -42,6 +42,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::BufferPrivate + \internal +*/ BufferPrivate::BufferPrivate(Buffer *qq) : QAbstractBufferPrivate(qq) { @@ -55,7 +59,7 @@ Buffer::Buffer(QOpenGLBuffer::Type ty) d->m_usage = QOpenGLBuffer::StaticDraw; } - +/*! \internal */ Buffer::Buffer(BufferPrivate &dd, QOpenGLBuffer::Type ty) : QAbstractBuffer(dd) { diff --git a/src/render/io/qmeshdata.cpp b/src/render/io/qmeshdata.cpp index 90ec9da4d..f53d4c8af 100644 --- a/src/render/io/qmeshdata.cpp +++ b/src/render/io/qmeshdata.cpp @@ -44,6 +44,10 @@ QT_BEGIN_NAMESPACE namespace Qt3D { +/*! + \class Qt3D::QMeshDataPrivate + \internal +*/ QMeshDataPrivate::QMeshDataPrivate(QMeshData *qq) : q_ptr(qq) , m_verticesPerPatch(0) @@ -61,6 +65,7 @@ QMeshData::~QMeshData() { } +/*! \internal */ QMeshData::QMeshData(QMeshDataPrivate &dd) : d_ptr(&dd) { |