forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[RF69] Fixed doxygen warnings

Browse source
This commit is contained in:
jgromes 2024-04-01 10:44:22 +02:00
parent 361e3cc9ac
commit ba416e987a
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/modules/RF69/RF69.h
View file

@ -486,7 +486,7 @@ class RF69: public PhysicalLayer {
/*! /*!
\brief Default constructor. \brief Default constructor.
\param mod Instance of Module that will be used to communicate with the radio. \param module Instance of Module that will be used to communicate with the radio.
*/ */
RF69(Module* module); RF69(Module* module);
@ -575,7 +575,7 @@ class RF69: public PhysicalLayer {
/*! /*!
\brief Sets AES key. \brief Sets AES key.
\param Key to be used for AES encryption. Must be exactly 16 bytes long. \param key Key to be used for AES encryption. Must be exactly 16 bytes long.
*/ */
void setAESKey(uint8_t* key); void setAESKey(uint8_t* key);
@ -872,14 +872,14 @@ class RF69: public PhysicalLayer {
/*! /*!
\brief Set modem in variable packet length mode. \brief Set modem in variable packet length mode.
\param len Maximum packet length. \param maxLen Maximum packet length.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_RF69_MAX_PACKET_LENGTH); int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_RF69_MAX_PACKET_LENGTH);
/*! /*!
\brief Enable sync word filtering and generation. \brief Enable sync word filtering and generation.
\param numBits Sync word length in bits. \param maxErrBits Maximum allowed number of error bits in sync word.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0); int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0);