diff options
| author | Ivan Solovev <ivan.solovev@qt.io> | 2023-02-03 17:15:23 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-02-07 11:35:10 +0000 |
| commit | 4e44177cb37d897041a80f73a3d002f214c13064 (patch) | |
| tree | 14ff2d4cdf483d53f85e8f19d6d9c52bff55f8f0 /src | |
| parent | 9fe08b6325bd087e4e7fb2df5357dad6b7e58b37 (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
Change-Id: I27ff640fb1a06035222306b05d938a2856ea7651
Reviewed-by: André Hartmann <aha_1980@gmx.de>
(cherry picked from commit 4eb6a3c945ab3ea3409b38bacab813b1c83cdd3a)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src')
| -rw-r--r-- | src/serialbus/qcancommondefinitions.cpp | 6 |
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) |