diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-04-20 10:26:56 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-04-20 10:17:18 +0000 |
commit | dcda92d3094f35c50c3665059df1b237bf4904b8 (patch) | |
tree | 67d674255dc29cc237f49f6b0d1940679e71d077 /src/input/frontend/qinputaspect.cpp | |
parent | bb09fa7b64b288a68edc61c52ea8467f96eb3924 (diff) |
Doc: Fix documentation warnings related to Clang QDoc parser
Since Qt 5.11, QDoc uses Clang to parse C++ documentation. Clang
requires a module header, as well as proper include paths, to
build a precompiled header and process the sources.
To do this, add a custom module header that pulls in all Qt 3D modules
- this way, we can continue using a single documentation project to
covers all of Qt 3D.
Fix all documentation warnings are caused by missing namespaces, QML
module/type names and typos, as well as a number of linking problems
and other minor issues.
After this change, the remaining documentation issues consist of
'No documentation for ...' warnings.
Task-number: QTBUG-67790
Change-Id: I38b91163c475a00cc1893e793240470c5409eb57
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/input/frontend/qinputaspect.cpp')
-rw-r--r-- | src/input/frontend/qinputaspect.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/input/frontend/qinputaspect.cpp b/src/input/frontend/qinputaspect.cpp index b37e32d43..1bc57579f 100644 --- a/src/input/frontend/qinputaspect.cpp +++ b/src/input/frontend/qinputaspect.cpp @@ -172,7 +172,7 @@ QInputAspect::~QInputAspect() { } -/*! +/* Create each of the detected input device integrations through the Integration Factory */ void QInputAspectPrivate::loadInputDevicePlugins() @@ -193,10 +193,10 @@ void QInputAspectPrivate::loadInputDevicePlugins() /*! Create a physical device identified by \a name using the input device integrations present - returns a nullptr if it is not found. - \note caller is responsible for ownership + returns a \c nullptr if it is not found. + + \note Caller is responsible for ownership. */ -// Note: caller is responsible for ownership QAbstractPhysicalDevice *QInputAspect::createPhysicalDevice(const QString &name) { Q_D(QInputAspect); @@ -204,7 +204,7 @@ QAbstractPhysicalDevice *QInputAspect::createPhysicalDevice(const QString &name) } /*! - \return a list of all available physical devices. + Returns a list of all available physical devices. */ QStringList QInputAspect::availablePhysicalDevices() const { |