summaryrefslogtreecommitdiffstats
path: root/src/core
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-04-13 12:55:34 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-04-14 07:41:11 +0000
commitf03dc3a2599a0f05cded8b984489b89113c7f037 (patch)
tree306902e9865550448dcf035ffa18c0be45834e62 /src/core
parent075c0298d1c75dd2d61849b559edcb357d638689 (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>
Diffstat (limited to 'src/core')
-rw-r--r--src/core/aspects/qabstractaspect.cpp5
-rw-r--r--src/core/aspects/qaspectengine.cpp5
-rw-r--r--src/core/aspects/qaspectfactory.cpp4
-rw-r--r--src/core/core-components/qcamera.cpp5
-rw-r--r--src/core/core-components/qcameralens.cpp5
-rw-r--r--src/core/doc/qt3dcore.qdocconf11
-rw-r--r--src/core/doc/src/qt3dcore-module.qdoc5
-rw-r--r--src/core/io/qabstractattribute.cpp5
-rw-r--r--src/core/io/qabstractbuffer.cpp5
-rw-r--r--src/core/jobs/qabstractaspectjobmanager.cpp5
-rw-r--r--src/core/jobs/qaspectjob.cpp5
-rw-r--r--src/core/jobs/qaspectjobmanager.cpp5
-rw-r--r--src/core/jobs/qthreadpooler.cpp4
-rw-r--r--src/core/nodes/qbackendnode.cpp5
-rw-r--r--src/core/nodes/qcomponent.cpp5
-rw-r--r--src/core/nodes/qentity.cpp5
-rw-r--r--src/core/nodes/qnode.cpp5
-rw-r--r--src/core/qbackendscenepropertychange.cpp10
-rw-r--r--src/core/qscenechange.cpp6
-rw-r--r--src/core/qscenepropertychange.cpp10
-rw-r--r--src/core/resources/qcircularbuffer.qdoc2
-rw-r--r--src/core/resources/qframeallocator.cpp4
-rw-r--r--src/core/services/qopenglinformationservice.cpp10
-rw-r--r--src/core/services/qservicelocator.cpp7
-rw-r--r--src/core/services/qsysteminformationservice.cpp15
-rw-r--r--src/core/transforms/qabstracttransform.cpp6
-rw-r--r--src/core/transforms/qlookattransform.cpp5
-rw-r--r--src/core/transforms/qmatrixtransform.cpp4
-rw-r--r--src/core/transforms/qrotatetransform.cpp5
-rw-r--r--src/core/transforms/qscaletransform.cpp5
-rw-r--r--src/core/transforms/qtransform.cpp5
-rw-r--r--src/core/transforms/qtranslatetransform.cpp5
32 files changed, 177 insertions, 11 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)
{