Skip to content

Commit 0b60c0b

Browse files
committed
docs review
1 parent 4e431a6 commit 0b60c0b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

RF24.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ class RF24 {
175175
* @param _cspin The pin attached to Chip Select (often labeled CSN) on the radio module.
176176
* <br><br>For the Arduino Due board, the [Arduino Due extended SPI feature](https://www.arduino.cc/en/Reference/DueExtendedSPI)
177177
* 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.
178-
* @param _spispeed The SPI speed in Hz ie: 1000000 == 1Mhz <br><br>Users can specify default SPI speed by modifying
178+
* @param _spi_speed The SPI speed in Hz ie: 1000000 == 1Mhz <br><br>Users can specify default SPI speed by modifying
179179
* `#define RF24_SPI_SPEED` in RF24_config.h
180180
* - For Arduino, the default SPI speed will only be properly configured this way on devices supporting SPI TRANSACTIONS
181181
* - Older/Unsupported Arduino devices will use a default clock divider & settings configuration
@@ -187,7 +187,7 @@ class RF24 {
187187
* A constructor for initializing the radio's hardware dynamically
188188
* @warning You MUST use begin(uint16_t, uint16_t) or begin(_SPI*, uint16_t, uint16_t) to pass both the digital output pin
189189
* numbers connected to the radio's CE and CSN pins.
190-
* @param _spispeed The SPI speed in Hz ie: 1000000 == 1Mhz <br><br>Users can specify default SPI speed by modifying
190+
* @param _spi_speed The SPI speed in Hz ie: 1000000 == 1Mhz <br><br>Users can specify default SPI speed by modifying
191191
* `#define RF24_SPI_SPEED` in RF24_config.h
192192
* - For Arduino, the default SPI speed will only be properly configured this way on devices supporting SPI TRANSACTIONS
193193
* - Older/Unsupported Arduino devices will use a default clock divider & settings configuration
@@ -263,6 +263,7 @@ class RF24 {
263263
* @param _cspin The pin attached to Chip Select (often labeled CSN) on the radio module.
264264
* <br><br>For the Arduino Due board, the [Arduino Due extended SPI feature](https://www.arduino.cc/en/Reference/DueExtendedSPI)
265265
* 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.
266+
* @return same result as begin()
266267
*/
267268
bool begin(uint16_t _cepin, uint16_t _cspin);
268269

0 commit comments

Comments
 (0)