diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-11-11 22:00:47 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 12:04:27 +0100 |
| commit | 80120869717f691f4339dc6a2f966a1160788867 (patch) | |
| tree | 7a2df9582114cd7183e8b977e3f662c5e1924d57 | |
| parent | 15c618da80a71d0f5c33cdade6535f43eb852363 (diff) | |
Doc: Fix documentation warnings
Fix several instances of incorrect parameter documentation, and
one incorrect \sa link.
Fixes: QTBUG-79831
Change-Id: Idefb514488adb3909e09d624a5b84b579fd4e71b
Reviewed-by: André Hartmann <aha_1980@gmx.de>
| -rw-r--r-- | src/serialbus/qcanbusdevice.cpp | 10 | ||||
| -rw-r--r-- | src/serialbus/qcanbusframe.cpp | 2 |
2 files changed, 6 insertions, 6 deletions
diff --git a/src/serialbus/qcanbusdevice.cpp b/src/serialbus/qcanbusdevice.cpp index 222f19c..5b6c343 100644 --- a/src/serialbus/qcanbusdevice.cpp +++ b/src/serialbus/qcanbusdevice.cpp @@ -346,8 +346,8 @@ bool QCanBusDevice::hasOutgoingFrames() const /*! * \since 5.14 - * Called from the derived plugin to register a function that performs the - * CAN controller hardware reset when \a resetController() is called. + * Called from the derived plugin to register a function \a resetter which performs the + * CAN controller hardware reset when resetController() is called. */ void QCanBusDevice::setResetControllerFunction(std::function<void()> resetter) { @@ -358,8 +358,8 @@ void QCanBusDevice::setResetControllerFunction(std::function<void()> resetter) /*! * \since 5.14 - * Called from the derived plugin to register a function that returns the - * CAN controller bus status when \a busStatus() is called. + * Called from the derived plugin to register a function \a busStatusGetter + * which returns the CAN controller bus status when busStatus() is called. */ void QCanBusDevice::setCanBusStatusGetter(std::function<CanBusStatus()> busStatusGetter) { @@ -559,7 +559,7 @@ bool QCanBusDevice::hasBusStatus() const The function hasBusStatus() can be used at runtime to check if the used CAN plugin has support for requesting the CAN bus status. - \sa hasBusStatus(), hardwareControllerReset() + \sa hasBusStatus(), resetController() */ QCanBusDevice::CanBusStatus QCanBusDevice::busStatus() const { diff --git a/src/serialbus/qcanbusframe.cpp b/src/serialbus/qcanbusframe.cpp index c62539e..1476314 100644 --- a/src/serialbus/qcanbusframe.cpp +++ b/src/serialbus/qcanbusframe.cpp @@ -88,7 +88,7 @@ QT_BEGIN_NAMESPACE \a newFrameId with more than 11 bits in size is given. When the format is extended and a \a newFrameId with up to 11 bits or less - is passed, the \e {CAN extended frame format} setting is \a not changed. + is passed, the \e {CAN extended frame format} setting is \b not changed. \sa frameId(), hasExtendedFrameFormat() */ |