drivers: can: document return value of 0 for can_get_max_bitrate()

henrikbrixandersen · fabiobaltieri · commit 4f0cfdda8093 · 2023-03-31T16:22:16.000Z
Explicitly document that a return value of 0 from can_get_max_bitrate()
indicates success.

Signed-off-by: Henrik Brix Andersen &lt;hebad@vestas.com&gt;
diff --git a/include/zephyr/drivers/can.h b/include/zephyr/drivers/can.h
@@ -715,6 +715,7 @@ static inline int z_impl_can_get_core_clock(const struct device *dev, uint32_t *
  * @param dev Pointer to the device structure for the driver instance.
  * @param[out] max_bitrate Maximum supported bitrate in bits/s
  *
+ * @retval 0 If successful.
  * @retval -EIO General input/output error.
  * @retval -ENOSYS If this function is not implemented by the driver.
  */

Original file line number	Diff line number	Diff line change
`@@ -715,6 +715,7 @@ static inline int z_impl_can_get_core_clock(const struct device dev, uint32_t `
`715`	`715`	`* @param dev Pointer to the device structure for the driver instance.`
`716`	`716`	`* @param[out] max_bitrate Maximum supported bitrate in bits/s`
`717`	`717`	`*`
	`718`	`+ * @retval 0 If successful.`
`718`	`719`	`* @retval -EIO General input/output error.`
`719`	`720`	`* @retval -ENOSYS If this function is not implemented by the driver.`
`720`	`721`	`*/`