summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@theqtcompany.com>2016-01-25 10:55:36 +0100
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2016-01-26 09:13:17 +0000
commit5a68874f7a2f18070890bec7c3259af94abe320b (patch)
treeed0eee0a10f23d9781679b0899ee2bb2423c1b29
parent9e62c61e42c321f8b4c258ada90e1bf6acb039b1 (diff)
Doc: Mark the rest of the private classes \internal
Private headers are no longer part of the documentation build, so the documentation for these classes triggers a lot of QDoc warnings. Avoid this by replacing the QDoc comment blocks '/*!' with standard C comments. Change-Id: Id7aac9354e12ba2b7a62f84b947a5f6f38702c6d Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
-rw-r--r--src/core/qchangearbiter.cpp2
-rw-r--r--src/core/resources/qframeallocator.cpp2
-rw-r--r--src/core/resources/qresourcemanager.cpp6
-rw-r--r--src/core/services/qabstractframeadvanceservice.cpp8
-rw-r--r--src/core/services/qeventfilterservice.cpp2
-rw-r--r--src/core/services/qopenglinformationservice.cpp8
-rw-r--r--src/core/services/qservicelocator.cpp28
-rw-r--r--src/core/services/qsysteminformationservice.cpp10
-rw-r--r--src/core/services/qtickclockservice.cpp4
9 files changed, 35 insertions, 35 deletions
diff --git a/src/core/qchangearbiter.cpp b/src/core/qchangearbiter.cpp
index e9a004d8c..039fe4f6c 100644
--- a/src/core/qchangearbiter.cpp
+++ b/src/core/qchangearbiter.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCore {
-/*!
+/* !\internal
\class Qt3DCore::QChangeArbiter
\inmodule Qt3DCore
\since 5.5
diff --git a/src/core/resources/qframeallocator.cpp b/src/core/resources/qframeallocator.cpp
index 2988ec534..d2527000d 100644
--- a/src/core/resources/qframeallocator.cpp
+++ b/src/core/resources/qframeallocator.cpp
@@ -34,7 +34,7 @@
**
****************************************************************************/
-/*!
+/* !\internal
\class Qt3DCore::QFrameAllocator
\inmodule Qt3DCore
\brief Provides a pool of memory chunks to be used to allocate objects on a per frame basis.
diff --git a/src/core/resources/qresourcemanager.cpp b/src/core/resources/qresourcemanager.cpp
index 8af1d5d5d..b71a1c20b 100644
--- a/src/core/resources/qresourcemanager.cpp
+++ b/src/core/resources/qresourcemanager.cpp
@@ -34,7 +34,7 @@
**
****************************************************************************/
-/*!
+/* !\internal
\class Qt3DCore::QResourceManager
\inmodule Qt3DCore
\since 5.5
@@ -54,7 +54,7 @@
parameters. The defaults are ArrayAllocatingPolicy and NonLockingPolicy respectively.
*/
-/*!
+/* !\internal
\class Qt3DCore::ArrayAllocatingPolicy
\inmodule Qt3DCore
\since 5.5
@@ -67,7 +67,7 @@
\sa QResourceManager
*/
-/*!
+/* !\internal
\class Qt3DCore::ObjectLevelLockingPolicy
\inmodule Qt3DCore
\since 5.5
diff --git a/src/core/services/qabstractframeadvanceservice.cpp b/src/core/services/qabstractframeadvanceservice.cpp
index c4e445858..f282f34e7 100644
--- a/src/core/services/qabstractframeadvanceservice.cpp
+++ b/src/core/services/qabstractframeadvanceservice.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCore {
-/*!
+/* !\internal
\class Qt3DCore::QAbstractFrameAdvanceService
\inmodule Qt3DCore
\brief Interface for a Qt3D frame advance service.
@@ -67,19 +67,19 @@ QAbstractFrameAdvanceService::QAbstractFrameAdvanceService(QAbstractFrameAdvance
}
-/*!
+/*
\fn qint64 Qt3DCore::QAbstractFrameAdvanceService::waitForNextFrame()
Returns the current time, the call may be blocking if waiting for a tick.
*/
-/*!
+/*
\fn void Qt3DCore::QAbstractFrameAdvanceService::start()
Starts the service.
*/
-/*!
+/*
\fn void Qt3DCore::QAbstractFrameAdvanceService::stop()
Stops the service, performing any cleanup deemed necessary.
diff --git a/src/core/services/qeventfilterservice.cpp b/src/core/services/qeventfilterservice.cpp
index c9a74a173..f8607e761 100644
--- a/src/core/services/qeventfilterservice.cpp
+++ b/src/core/services/qeventfilterservice.cpp
@@ -119,7 +119,7 @@ public:
};
-/*!
+/* !\internal
\class Qt3DCore::QEventFilterService
\inmodule Qt3DCore
diff --git a/src/core/services/qopenglinformationservice.cpp b/src/core/services/qopenglinformationservice.cpp
index 127a6ca76..2e5fa5780 100644
--- a/src/core/services/qopenglinformationservice.cpp
+++ b/src/core/services/qopenglinformationservice.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCore {
-/*!
+/* !\internal
\class Qt3DCore::QOpenGLInformationService
\inmodule Qt3DCore
\brief Interface for a Qt3D OpenGL information service
@@ -53,7 +53,7 @@ namespace Qt3DCore {
having a valid OpenGL context on the current thread.
*/
-/*!
+/*
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.
@@ -63,7 +63,7 @@ QOpenGLInformationService::QOpenGLInformationService(const QString &description)
{
}
-/*!
+/*
\internal
*/
QOpenGLInformationService::QOpenGLInformationService(QOpenGLInformationServicePrivate &dd)
@@ -71,7 +71,7 @@ QOpenGLInformationService::QOpenGLInformationService(QOpenGLInformationServicePr
{
}
-/*!
+/*
\fn QSurfaceFormat Qt3DCore::QOpenGLInformationService::format() const
Subclasses should override this function to return the QSurfaceFormat of the
diff --git a/src/core/services/qservicelocator.cpp b/src/core/services/qservicelocator.cpp
index eaa74a925..aa073933f 100644
--- a/src/core/services/qservicelocator.cpp
+++ b/src/core/services/qservicelocator.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCore {
-/*!
+/* !\internal
\class Qt3DCore::QAbstractServiceProvider
\inmodule Qt3DCore
*/
@@ -56,7 +56,7 @@ QAbstractServiceProvider::QAbstractServiceProvider(int type, const QString &desc
d_ptr->q_ptr = this;
}
-/*! \internal */
+/* \internal */
QAbstractServiceProvider::QAbstractServiceProvider(QAbstractServiceProviderPrivate &dd)
: d_ptr(&dd)
{
@@ -97,7 +97,7 @@ public:
};
-/*!
+/* !\internal
\class Qt3DCore::QServiceLocator
\inmodule Qt3DCore
\brief Service locator used by aspects to retrieve pointers to concrete service objects
@@ -119,7 +119,7 @@ public:
do nothing implementations.
*/
-/*!
+/*
Creates an instance of QServiceLocator.
*/
QServiceLocator::QServiceLocator()
@@ -127,14 +127,14 @@ QServiceLocator::QServiceLocator()
{
}
-/*!
+/*
Destroys a QServiceLocator object
*/
QServiceLocator::~QServiceLocator()
{
}
-/*!
+/*
Registers \a provider service provider for the service \a serviceType. This replaces any
existing provider for this service. The service provider does not take ownership
of the provider.
@@ -149,7 +149,7 @@ void QServiceLocator::registerServiceProvider(int serviceType, QAbstractServiceP
++(d->m_nonNullDefaultServices);
}
-/*!
+/*
Unregisters any existing provider for the \a serviceType.
\sa registerServiceProvider()
@@ -162,7 +162,7 @@ void QServiceLocator::unregisterServiceProvider(int serviceType)
d->m_nonNullDefaultServices -= removedCount;
}
-/*!
+/*
Returns the number of registered services.
*/
int QServiceLocator::serviceCount() const
@@ -171,7 +171,7 @@ int QServiceLocator::serviceCount() const
return DefaultServiceCount + d->m_services.size() - d->m_nonNullDefaultServices;
}
-/*!
+/*
\fn T *Qt3DCore::QServiceLocator::service(int serviceType)
Returns a pointer to the service provider for \a serviceType. If no provider
@@ -182,7 +182,7 @@ int QServiceLocator::serviceCount() const
*/
-/*!
+/*
Returns a pointer to a provider for the system information service. If no provider
has been explicitly registered for this service type, then a pointer to a null, do-
nothing service is returned.
@@ -193,7 +193,7 @@ QSystemInformationService *QServiceLocator::systemInformation()
return static_cast<QSystemInformationService *>(d->m_services.value(SystemInformation, &d->m_nullSystemInfo));
}
-/*!
+/*
Returns a pointer to a provider for the OpenGL information service. If no provider
has been explicitly registered for this service type, then a pointer to a null, do-
nothing service is returned.
@@ -204,7 +204,7 @@ QOpenGLInformationService *QServiceLocator::openGLInformation()
return static_cast<QOpenGLInformationService *>(d->m_services.value(OpenGLInformation, &d->m_nullOpenGLInfo));
}
-/*!
+/*
Returns a pointer to a provider for the frame advance service. If no provider
has been explicitly registered for this service type, then a pointer to a simple timer-based
service is returned.
@@ -215,7 +215,7 @@ QAbstractFrameAdvanceService *QServiceLocator::frameAdvanceService()
return static_cast<QAbstractFrameAdvanceService *>(d->m_services.value(FrameAdvanceService, &d->m_defaultFrameAdvanceService));
}
-/*!
+/*
Returns a pointer to a provider for the event filter service. If no
provider has been explicitly registered for this service type, then a
pointer to the default event filter service is returned.
@@ -226,7 +226,7 @@ QEventFilterService *QServiceLocator::eventFilterService()
return static_cast<QEventFilterService *>(d->m_services.value(EventFilterService, &d->m_eventFilterService));
}
-/*!
+/*
\internal
*/
QAbstractServiceProvider *QServiceLocator::_q_getServiceHelper(int type)
diff --git a/src/core/services/qsysteminformationservice.cpp b/src/core/services/qsysteminformationservice.cpp
index 6de4ffe34..17a2feff9 100644
--- a/src/core/services/qsysteminformationservice.cpp
+++ b/src/core/services/qsysteminformationservice.cpp
@@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCore {
-/*!
+/* !\internal
\class Qt3DCore::QSystemInformationService
\inmodule Qt3DCore
\brief Interface for a Qt3D system information service
@@ -50,7 +50,7 @@ namespace Qt3DCore {
system information service.
*/
-/*!
+/*
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.
@@ -60,7 +60,7 @@ QSystemInformationService::QSystemInformationService(const QString &description)
{
}
-/*!
+/*
\internal
*/
QSystemInformationService::QSystemInformationService(QSystemInformationServicePrivate &dd)
@@ -68,14 +68,14 @@ QSystemInformationService::QSystemInformationService(QSystemInformationServicePr
{
}
-/*!
+/*
\fn QStringList Qt3DCore::QSystemInformationService::aspectNames() const
Subclasses should override this function and return a string list containing the
names of all registered aspects.
*/
-/*!
+/*
\fn int Qt3DCore::QSystemInformationService::threadPoolThreadCount() const
Subclasses should override this function and return the number of threads in the
diff --git a/src/core/services/qtickclockservice.cpp b/src/core/services/qtickclockservice.cpp
index b53c6b327..6899ddf8a 100644
--- a/src/core/services/qtickclockservice.cpp
+++ b/src/core/services/qtickclockservice.cpp
@@ -56,7 +56,7 @@ public:
QTickClock m_clock;
};
-/*!
+/* !\internal
\class Qt3DCore::QTickClockService
\inmodule Qt3DCore
\brief Default QAbstractFrameAdvanceService implementation.
@@ -78,7 +78,7 @@ qint64 QTickClockService::waitForNextFrame()
return d->m_clock.waitForNextTick();
}
-/*!
+/*
Starts the inner tick clock used by the service.
*/
void QTickClockService::start()