summaryrefslogtreecommitdiffstats
path: root/src/serialbus
diff options
context:
space:
mode:
authorIvan Solovev <ivan.solovev@qt.io>2023-02-03 17:15:23 +0100
committerIvan Solovev <ivan.solovev@qt.io>2023-02-06 18:31:26 +0100
commit4eb6a3c945ab3ea3409b38bacab813b1c83cdd3a (patch)
treefe88d7c898aaaa496e670b134d7bb3f89c4769a2 /src/serialbus
parent2c1ff70cd1960fe582f461207424c26a4bbe5b9b (diff)
Fix QtCanBus::UniqueId documentation
The type was converted to enum, but the docs were not updated. This patch fixes 3 documentation warnings: src/serialbus/qcancommondefinitions.cpp:63: (qdoc) warning: Cannot find 'QtCanBus::UniqueId' specified with '\typealias' in any header file src/serialbus/qcanuniqueiddescription.cpp:9: (qdoc) warning: Can't link to 'QtCanBus::UniqueId' src/serialbus/qcanuniqueiddescription.cpp:101: (qdoc) warning: Can't link to 'QtCanBus::UniqueId' This commit amends e6b4b720aabed07a3b6c28b446f1563f464fcc38 Pick-to: 6.5 Change-Id: I27ff640fb1a06035222306b05d938a2856ea7651 Reviewed-by: André Hartmann <aha_1980@gmx.de>
Diffstat (limited to 'src/serialbus')
-rw-r--r--src/serialbus/qcancommondefinitions.cpp6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/serialbus/qcancommondefinitions.cpp b/src/serialbus/qcancommondefinitions.cpp
index 225751c..c48d5c1 100644
--- a/src/serialbus/qcancommondefinitions.cpp
+++ b/src/serialbus/qcancommondefinitions.cpp
@@ -61,7 +61,11 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \typealias QtCanBus::UniqueId
+ \enum QtCanBus::UniqueId
+
+ Represents a CAN unique identifier. The underlying type is quint32.
+
+ An enum is used to avoid implicit conversions to or from unsigned int.
*/
QtCanBus::UniqueId qbswap(QtCanBus::UniqueId src)