From 4ca305ed24cfaf8a9e0ebc1692edf6aa3d3124c7 Mon Sep 17 00:00:00 2001 From: jgromes Date: Fri, 24 May 2019 21:25:43 +0200 Subject: [PATCH] [HC05] Added Doxygen comments --- src/modules/HC05.h | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/src/modules/HC05.h b/src/modules/HC05.h index fa67b624..5908a92e 100644 --- a/src/modules/HC05.h +++ b/src/modules/HC05.h @@ -3,12 +3,26 @@ #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 { public: - // constructor + /*! + \brief Default constructor. + + \param mod Instance of Module that will be used to communicate with the radio. + */ HC05(Module* mod); - - // basic methods + + /*! + \brief Initialization method. + + \param speed Baud rate to use for UART interface. + */ void begin(long speed); };