Skip to content

Commit 7aecb70

Browse files
committed
comment cleanups
1 parent 89b4440 commit 7aecb70

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

sfeIoTNodeLoRaWAN/sfeIoTNodeLoRaWAN.cpp

+17-2
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,11 @@ uint8_t sfeIoTNodeLoRaWAN::get_logTypeSer(void)
500500
{
501501
return _logTypeSer;
502502
}
503-
//---------------------------------------------------------------------------
503+
/**
504+
* @brief Sets the log type for serial output
505+
*
506+
* @param[in] logType The log type
507+
*/
504508
void sfeIoTNodeLoRaWAN::set_logTypeSer(uint8_t logType)
505509
{
506510
if (logType == _logTypeSer)
@@ -521,11 +525,22 @@ void sfeIoTNodeLoRaWAN::set_logTypeSer(uint8_t logType)
521525

522526
//---------------------------------------------------------------------------
523527
// local/board name things
528+
/**
529+
* @brief Getter for the the local name property
530+
*
531+
* @return The local name.
532+
*/
533+
524534
std::string sfeIoTNodeLoRaWAN::get_local_name(void)
525535
{
526536
return flux.localName();
527537
}
528538
//---------------------------------------------------------------------------
539+
/**
540+
* @brief Setter for the local name property
541+
*
542+
* @param[in] name The name
543+
*/
529544

530545
void sfeIoTNodeLoRaWAN::set_local_name(std::string name)
531546
{
@@ -730,7 +745,7 @@ void sfeIoTNodeLoRaWAN::checkBatteryLevels(void)
730745
}
731746

732747
//---------------------------------------------------------------------------
733-
// Terminal Baudrate things
748+
// Terminal Baud-rate things
734749
//---------------------------------------------------------------------------
735750
uint32_t sfeIoTNodeLoRaWAN::get_termBaudRate(void)
736751
{

0 commit comments

Comments
 (0)