summaryrefslogtreecommitdiffstats
path: root/src/core/services/qsysteminformationservice.cpp
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/services/qsysteminformationservice.cpp
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/services/qsysteminformationservice.cpp')
-rw-r--r--src/core/services/qsysteminformationservice.cpp15
1 files changed, 13 insertions, 2 deletions
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))