[HC05] Added Doxygen comments
This commit is contained in:
parent
0e1640b9fc
commit
4ca305ed24
1 changed files with 17 additions and 3 deletions
|
@ -3,12 +3,26 @@
|
||||||
|
|
||||||
#include "ISerial.h"
|
#include "ISerial.h"
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\class HC05
|
||||||
|
|
||||||
|
\brief Control class for %HC05 module.
|
||||||
|
Most methods supported by this module are implemented in ISerial interface.
|
||||||
|
*/
|
||||||
class HC05: public ISerial {
|
class HC05: public ISerial {
|
||||||
public:
|
public:
|
||||||
// constructor
|
/*!
|
||||||
|
\brief Default constructor.
|
||||||
|
|
||||||
|
\param mod Instance of Module that will be used to communicate with the radio.
|
||||||
|
*/
|
||||||
HC05(Module* mod);
|
HC05(Module* mod);
|
||||||
|
|
||||||
// basic methods
|
/*!
|
||||||
|
\brief Initialization method.
|
||||||
|
|
||||||
|
\param speed Baud rate to use for UART interface.
|
||||||
|
*/
|
||||||
void begin(long speed);
|
void begin(long speed);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue