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 /src/core/services/qopenglinformationservice.cpp | |
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>
Diffstat (limited to 'src/core/services/qopenglinformationservice.cpp')
-rw-r--r-- | src/core/services/qopenglinformationservice.cpp | 10 |
1 files changed, 8 insertions, 2 deletions
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) |