fly316/PX4-Autopilot
7
0
Fork 0
mirror of https://gitee.com/mirrors_PX4/PX4-Autopilot.git synced 2026-10-13 15:23:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

STM32 doc comments

Browse Source
This commit is contained in:
Pavel Kirienko
2014-07-15 15:19:49 +04:00
parent 9d36eef359
commit 1cfd2a2f84
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp
+3 -2
View File
@@ -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
{
libuavcan_drivers/stm32/driver/include/uavcan_stm32/clock.hpp
+2 -2
View File
@@ -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.
*/