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

[CC1101] Fixed doxygen warnings

Browse source
This commit is contained in:
jgromes 2024-04-01 10:43:56 +02:00
parent a2f1493898
commit 81e030ce65
1 changed files with 20 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/modules/CC1101/CC1101.h
View file

@ -537,7 +537,7 @@ class CC1101: 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.
*/ */
CC1101(Module* module); CC1101(Module* module);
@ -797,6 +797,7 @@ class CC1101: public PhysicalLayer {
/*! /*!
\brief Sets preamble length. \brief Sets preamble length.
\param preambleLength Preamble length to be set (in bits), allowed values: 16, 24, 32, 48, 64, 96, 128 and 192. \param preambleLength Preamble length to be set (in bits), allowed values: 16, 24, 32, 48, 64, 96, 128 and 192.
\param qualityThreshold Preamble quality threshold (PQT) to set.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold); int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold);
@ -852,14 +853,14 @@ class CC1101: 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_CC1101_MAX_PACKET_LENGTH); int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_CC1101_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 number of allowed error bits in sync word.
\param requireCarrierSense Require carrier sense above threshold in addition to sync word. \param requireCarrierSense Require carrier sense above threshold in addition to sync word.
\returns \ref status_codes \returns \ref status_codes
*/ */