Skip to content

Commit bd66422

Browse files
Draft: Remove duplicated setRfSwitchPins documentation
All radios that support RfSwitch define this method that simply forwards to the `Module::setRfSwitchPins()` method. Previously, all these methods duplicated the documentation as well, but this uses the doxygen \copydoc to remove this duplication. TODO: Apply to all radios if this approach is accepted
1 parent 3958449 commit bd66422

1 file changed

Lines changed: 1 addition & 8 deletions

File tree

src/modules/SX126x/SX126x.h

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -914,14 +914,7 @@ class SX126x: public PhysicalLayer {
914914
*/
915915
int16_t setEncoding(uint8_t encoding) override;
916916

917-
/*!
918-
\brief Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state.
919-
When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch!
920-
921-
\param rxEn RX enable pin.
922-
923-
\param txEn TX enable pin.
924-
*/
917+
/*! \copydoc Module::setRfSwitchPins */
925918
void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);
926919

927920
/*!

0 commit comments

Comments
 (0)