fix documentation
This commit is contained in:
parent
e141f4f151
commit
6695133576
3 changed files with 17 additions and 4 deletions
|
@ -9,6 +9,8 @@
|
|||
RadioLib KEYWORD1
|
||||
RadioShield KEYWORD1
|
||||
Module KEYWORD1
|
||||
Hal KEYWORD1
|
||||
ArduinoHal KEYWORD1
|
||||
|
||||
# modules
|
||||
CC1101 KEYWORD1
|
||||
|
|
|
@ -16,7 +16,18 @@
|
|||
|
||||
class ArduinoHal : public Hal {
|
||||
public:
|
||||
/*!
|
||||
\brief Arduino Hal constructor. Will use the default SPI interface and automatically initialize it.
|
||||
*/
|
||||
ArduinoHal();
|
||||
|
||||
/*!
|
||||
\brief Arduino Hal constructor. Will not attempt SPI interface initialization.
|
||||
|
||||
\param spi SPI interface to be used, can also use software SPI implementations.
|
||||
|
||||
\param spiSettings SPI interface settings.
|
||||
*/
|
||||
ArduinoHal(SPIClass& spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);
|
||||
|
||||
void init() override;
|
||||
|
|
|
@ -106,13 +106,13 @@ class Module {
|
|||
|
||||
\param hal A Hardware abstraction layer instance. An ArduinoHal instance for example.
|
||||
|
||||
\param cs Arduino pin to be used as chip select.
|
||||
\param cs Pin to be used as chip select.
|
||||
|
||||
\param irq Arduino pin to be used as interrupt/GPIO.
|
||||
\param irq Pin to be used as interrupt/GPIO.
|
||||
|
||||
\param rst Arduino pin to be used as hardware reset for the module.
|
||||
\param rst Pin to be used as hardware reset for the module.
|
||||
|
||||
\param gpio Arduino pin to be used as additional interrupt/GPIO.
|
||||
\param gpio Pin to be used as additional interrupt/GPIO.
|
||||
*/
|
||||
Module(Hal *hal, uint8_t cs, uint8_t irq, uint8_t rst, uint8_t gpio = RADIOLIB_NC);
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue