Skip to content

Commit a8ebd44

Browse files
committed
Added doxygen comment to I2C master.
1 parent 96cad11 commit a8ebd44

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

src/i2c/i2cmaster.hpp

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,17 @@ typedef int i2c_inst_t;
2626
#include "sdkwrapper.hpp"
2727

2828
namespace rpp_driver {
29+
/**
30+
* @brief I2C Master controller class.
31+
* @details
32+
* This class provides a set of easy to use member function to control the I2C
33+
* master controller. Everything operation in this class is polling based and
34+
* blocking.
35+
*
36+
* The ReadBlocking() and WriteBlocking() functions has nostop parameter. To use
37+
* the restart condition, set this parameter to true.
38+
*
39+
*/
2940
class I2cMaster : public I2cMasterInterface {
3041
public:
3142
/**

0 commit comments

Comments
 (0)