Skip to content

Commit

Permalink
Rename RadioSettingGrpPub to TransportSettingGrpPub
Browse files Browse the repository at this point in the history
https://www.mysensors.org/apidocs/group__RadioSettingGrpPub.html
had the headline "Radio selection". In MySensors lingo, we probably
mean "Transport selection", especially since RS485 is included but
does not use radio.

By renaming the group and the text, it might become easier for users
to understand which different transports are supported by MySensors.

This fixes mysensors#1272
  • Loading branch information
mfalkvidd committed May 30, 2019
1 parent 385cd4d commit ee1abdf
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions MyConfig.h
Original file line number Diff line number Diff line change
Expand Up @@ -192,16 +192,16 @@


/**
* @defgroup RadioSettingGrpPub Radio selection
* @defgroup TransportSettingGrpPub Transport selection
* @ingroup MyConfigGrp
* @brief These options control what radio type to use and various radio specific customisations.
* @brief These options control what transport type to use and various transport specific customisations.
* @{
*/


/**
* @defgroup RS485SettingGrpPub RS485
* @ingroup RadioSettingGrpPub
* @ingroup TransportSettingGrpPub
* @brief These options are specific to the RS485 wired transport.
* @{
*/
Expand Down Expand Up @@ -254,7 +254,7 @@

/**
* @defgroup RF24SettingGrpPub RF24
* @ingroup RadioSettingGrpPub
* @ingroup TransportSettingGrpPub
* @brief These options are specific to the RF24 family of wireless transport modules.
*
* The following chips are supported by this driver:
Expand Down Expand Up @@ -441,7 +441,7 @@

/**
* @defgroup NRF5SettingGrpPub nRF5
* @ingroup RadioSettingGrpPub
* @ingroup TransportSettingGrpPub
* @brief These options are specific to the nRF5 (with Enhanced ShockBurst) family of wireless
* transport modules.
*
Expand Down Expand Up @@ -572,7 +572,7 @@

/**
* @defgroup RFM69SettingGrpPub RFM69
* @ingroup RadioSettingGrpPub
* @ingroup TransportSettingGrpPub
* @brief These options are specific to the %RFM69 family of wireless transport modules.
*
* The following chips are supported by this driver:
Expand Down Expand Up @@ -793,7 +793,7 @@

/**
* @defgroup RFM95SettingGrpPub RFM95
* @ingroup RadioSettingGrpPub
* @ingroup TransportSettingGrpPub
* @brief These options are specific to the %RFM95 family of wireless transport modules.
*
* The following chips are supported by this driver:
Expand Down Expand Up @@ -955,7 +955,7 @@

/**
* @defgroup SoftSpiSettingGrpPub Soft SPI
* @ingroup RadioSettingGrpPub
* @ingroup TransportSettingGrpPub
* @brief These options are specific the soft SPI driver for certain radio transport drivers.
*
* The following transport drivers supported by this driver:
Expand Down Expand Up @@ -997,7 +997,7 @@
#endif
/** @}*/ // End of SoftSpiSettingGrpPub group

/** @}*/ // End of RadioSettingGrpPub group
/** @}*/ // End of TransportSettingGrpPub group

/**
* @defgroup RoutingNodeSettingGrpPub Routing and node
Expand Down

0 comments on commit ee1abdf

Please sign in to comment.