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/core/nodes | |
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/core/nodes')
-rw-r--r-- | src/core/nodes/qnode.cpp | 4 | ||||
-rw-r--r-- | src/core/nodes/qnodeid.cpp | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/src/core/nodes/qnode.cpp b/src/core/nodes/qnode.cpp index ecdc83b2c..b370102d4 100644 --- a/src/core/nodes/qnode.cpp +++ b/src/core/nodes/qnode.cpp @@ -984,9 +984,9 @@ QNodeCommand::CommandId QNode::sendCommand(const QString &name, } /*! - * \brief Send a command back to the backend node + * \brief Send a \a command back to the backend node. * - * Assumes the command is to be to sent back in reply to itself to the backend node + * Assumes the command is to be to sent back in reply to itself to the backend node. * * \sa QNodeCommand, QNode::sendCommand */ diff --git a/src/core/nodes/qnodeid.cpp b/src/core/nodes/qnodeid.cpp index 7e392137e..3e11733e6 100644 --- a/src/core/nodes/qnodeid.cpp +++ b/src/core/nodes/qnodeid.cpp @@ -89,7 +89,7 @@ namespace Qt3DCore { /*! * \fn Qt3DCore::QNodeId::operator bool() const - * \TODO + * Returns \TODO */ /*! |