Skip to content

Commit

Permalink
docs review
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Apr 11, 2021
1 parent 4e431a6 commit 0b60c0b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions RF24.h
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ class RF24 {
* @param _cspin The pin attached to Chip Select (often labeled CSN) on the radio module.
* <br><br>For the Arduino Due board, the [Arduino Due extended SPI feature](https://www.arduino.cc/en/Reference/DueExtendedSPI)
* is not supported. This means that the Due's pins 4, 10, or 52 are not mandated options (can use any digital output pin) for the radio's CSN pin.
* @param _spispeed The SPI speed in Hz ie: 1000000 == 1Mhz <br><br>Users can specify default SPI speed by modifying
* @param _spi_speed The SPI speed in Hz ie: 1000000 == 1Mhz <br><br>Users can specify default SPI speed by modifying
* `#define RF24_SPI_SPEED` in RF24_config.h
* - For Arduino, the default SPI speed will only be properly configured this way on devices supporting SPI TRANSACTIONS
* - Older/Unsupported Arduino devices will use a default clock divider & settings configuration
Expand All @@ -187,7 +187,7 @@ class RF24 {
* A constructor for initializing the radio's hardware dynamically
* @warning You MUST use begin(uint16_t, uint16_t) or begin(_SPI*, uint16_t, uint16_t) to pass both the digital output pin
* numbers connected to the radio's CE and CSN pins.
* @param _spispeed The SPI speed in Hz ie: 1000000 == 1Mhz <br><br>Users can specify default SPI speed by modifying
* @param _spi_speed The SPI speed in Hz ie: 1000000 == 1Mhz <br><br>Users can specify default SPI speed by modifying
* `#define RF24_SPI_SPEED` in RF24_config.h
* - For Arduino, the default SPI speed will only be properly configured this way on devices supporting SPI TRANSACTIONS
* - Older/Unsupported Arduino devices will use a default clock divider & settings configuration
Expand Down Expand Up @@ -263,6 +263,7 @@ class RF24 {
* @param _cspin The pin attached to Chip Select (often labeled CSN) on the radio module.
* <br><br>For the Arduino Due board, the [Arduino Due extended SPI feature](https://www.arduino.cc/en/Reference/DueExtendedSPI)
* is not supported. This means that the Due's pins 4, 10, or 52 are not mandated options (can use any digital output pin) for the radio's CSN pin.
* @return same result as begin()
*/
bool begin(uint16_t _cepin, uint16_t _cspin);

Expand Down

0 comments on commit 0b60c0b

Please sign in to comment.