diff --git a/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp b/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp index ca2e1aabbd..83226d94ce 100644 --- a/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp +++ b/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp @@ -164,7 +164,8 @@ public: unsigned getRxQueueLength() const; /** - * Returns last hardware error code (LEC field in the register ESR) + * Returns last hardware error code (LEC field in the register ESR). + * The error code will be reset. */ uavcan::uint8_t yieldLastHardwareErrorCode(); @@ -177,7 +178,7 @@ public: /** * CAN driver, incorporates all available CAN ifaces. - * Please avoid direct usage, prefer @ref CanInitHelper instead. + * Please avoid direct use, prefer @ref CanInitHelper instead. */ class CanDriver : public uavcan::ICanDriver, uavcan::Noncopyable { diff --git a/libuavcan_drivers/stm32/driver/include/uavcan_stm32/clock.hpp b/libuavcan_drivers/stm32/driver/include/uavcan_stm32/clock.hpp index cc98469059..d4afa07e5f 100644 --- a/libuavcan_drivers/stm32/driver/include/uavcan_stm32/clock.hpp +++ b/libuavcan_drivers/stm32/driver/include/uavcan_stm32/clock.hpp @@ -18,7 +18,7 @@ namespace clock void init(); /** - * Returns current monotonic time passed since the moment when clock::init() was called. + * Returns current monotonic time since the moment when clock::init() was called. * This function is thread safe. */ uavcan::MonotonicTime getMonotonic(); @@ -30,7 +30,7 @@ uavcan::MonotonicTime getMonotonic(); uavcan::UtcTime getUtc(); /** - * Performs UTC time adjustment. + * Performs UTC phase and frequency adjustment. * The UTC time will be zero until first adjustment has been performed. * This function is thread safe. */