From efd3f23eb19d074d8e907528ebbd3ebe985d07ba Mon Sep 17 00:00:00 2001 From: Pavel Kirienko Date: Tue, 15 Jul 2014 15:34:56 +0400 Subject: [PATCH] STM32 doc comments --- .../stm32/driver/include/uavcan_stm32/can.hpp | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp b/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp index 83226d94ce..fae14e2b10 100644 --- a/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp +++ b/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp @@ -202,8 +202,15 @@ public: uavcan::StaticAssert<(RxQueueCapacity <= CanIface::MaxRxQueueCapacity)>::check(); } + /** + * This function returns select masks indicating which interfaces are available for read/write. + */ uavcan::CanSelectMasks makeSelectMasks() const; + /** + * Returns zero if OK. + * Returns negative value if failed (e.g. invalid bitrate). + */ int init(uavcan::uint32_t bitrate); virtual CanIface* getIface(uavcan::uint8_t iface_index);