From 804c6b3d894c40e254600af930a37a4c504305bc Mon Sep 17 00:00:00 2001 From: jgromes Date: Fri, 24 May 2019 21:26:00 +0200 Subject: [PATCH] [JDY08] Added Doxygen comments --- src/modules/JDY08.h | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/src/modules/JDY08.h b/src/modules/JDY08.h index 9d4c5857..a7cf61af 100644 --- a/src/modules/JDY08.h +++ b/src/modules/JDY08.h @@ -3,12 +3,26 @@ #include "ISerial.h" +/*! + \class JDY08 + + \brief Control class for %JDY08 module. + Most methods supported by this module are implemented in ISerial interface. +*/ class JDY08: public ISerial { public: - // constructor + /*! + \brief Default constructor. + + \param mod Instance of Module that will be used to communicate with the radio. + */ JDY08(Module* mod); - - // basic methods + + /*! + \brief Initialization method. + + \param speed Baud rate to use for UART interface. + */ void begin(long speed); };