Skip to content

Commit a842986

Browse files
authored
Clarify default defines (#1106)
Moved example values after the @brief portion of Doxygen, so the default (empty/undefined) values are visible in Doxygen.
1 parent df1bb7f commit a842986

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

MyConfig.h

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,8 @@
243243
/**
244244
* @def MY_RS485_HWSERIAL
245245
* @brief Define this if RS485 is connected to a hardware serial port.
246+
*
247+
* Example: @code #define MY_RS485_HWSERIAL Serial1 @endcode
246248
*/
247249
//#define MY_RS485_HWSERIAL (Serial1)
248250
/** @}*/ // End of RS485SettingGrpPub group
@@ -1404,7 +1406,9 @@
14041406

14051407
/**
14061408
* @def MY_IP_ADDRESS
1407-
* @brief Static ip address of gateway (if this is not defined, DHCP will be used).
1409+
* @brief Static ip address of gateway. If not defined, DHCP will be used.
1410+
*
1411+
* Example: @code #define MY_IP_ADDRESS 192,168,178,66 @endcode
14081412
*/
14091413
//#define MY_IP_ADDRESS 192,168,178,66
14101414

@@ -1437,6 +1441,8 @@
14371441
* @brief If this is defined, gateway will act as a client trying to contact controller on
14381442
* @ref MY_PORT using this IP address.
14391443
*
1444+
* Example: @code #define MY_CONTROLLER_IP_ADDRESS 192,168,178,254 @endcode
1445+
*
14401446
* If left un-defined, gateway acts as server allowing incoming connections.
14411447
*/
14421448
//#define MY_CONTROLLER_IP_ADDRESS 192,168,178,254
@@ -1535,6 +1541,8 @@
15351541
* @brief Enables SW backed signing functionality and encryption functionality in library and uses
15361542
* provided password as key.
15371543
*
1544+
* Example: @code #define MY_SECURITY_SIMPLE_PASSWD "MyInsecurePassword" @endcode
1545+
*
15381546
* For details on the effects, see the references.
15391547
* @see MY_SIGNING_SIMPLE_PASSWD, MY_ENCRYPTION_SIMPLE_PASSWD
15401548
*/
@@ -1582,6 +1590,8 @@
15821590
* to accommodate the key size in question. A 32 character password is the maximum length. Any
15831591
* password longer than that will be truncated.
15841592
*
1593+
* Example: @code #define MY_SIGNING_SIMPLE_PASSWD "MyInsecurePassword" @endcode
1594+
*
15851595
* @see MY_SECURITY_SIMPLE_PASSWD
15861596
*
15871597
*/
@@ -1659,6 +1669,8 @@
16591669
* the signed message.
16601670
*
16611671
* It is legal to only have one node with a whitelist for this reason but it is not required.
1672+
*
1673+
* Example: @code #define MY_SIGNING_NODE_WHITELISTING {{.nodeId = GATEWAY_ADDRESS,.serial = {0x09,0x08,0x07,0x06,0x05,0x04,0x03,0x02,0x01}}} @endcode
16621674
*/
16631675
//#define MY_SIGNING_NODE_WHITELISTING {{.nodeId = GATEWAY_ADDRESS,.serial = {0x09,0x08,0x07,0x06,0x05,0x04,0x03,0x02,0x01}}}
16641676

@@ -1731,6 +1743,8 @@
17311743
* to accommodate the key size in question. A 16 character password is the maximum length. Any
17321744
* password longer than that will be truncated.
17331745
*
1746+
* Example: @code #define MY_ENCRYPTION_SIMPLE_PASSWD "MyInsecurePassword" @endcode
1747+
*
17341748
* @see MY_SECURITY_SIMPLE_PASSWD
17351749
*/
17361750
//#define MY_ENCRYPTION_SIMPLE_PASSWD "MyInsecurePassword"
@@ -2094,9 +2108,9 @@
20942108
#define MY_GATEWAY_ESP32
20952109
#define MY_GATEWAY_LINUX
20962110
#define MY_GATEWAY_TINYGSM
2097-
#define MY_IP_ADDRESS 192,168,178,66
2111+
#define MY_IP_ADDRESS
20982112
#define MY_USE_UDP
2099-
#define MY_CONTROLLER_IP_ADDRESS 192,168,178,254
2113+
#define MY_CONTROLLER_IP_ADDRESS
21002114
// TinyGSM
21012115
/**
21022116
* @def MY_GSM_APN
@@ -2143,14 +2157,14 @@
21432157
#define MY_DEFAULT_TX_LED_PIN
21442158
#define MY_DEFAULT_RX_LED_PIN
21452159
// signing
2146-
#define MY_SECURITY_SIMPLE_PASSWD "MyInsecurePassword"
2147-
#define MY_SIGNING_SIMPLE_PASSWD "MyInsecurePassword"
2148-
#define MY_ENCRYPTION_SIMPLE_PASSWD "MyInsecurePassword"
2160+
#define MY_SECURITY_SIMPLE_PASSWD
2161+
#define MY_SIGNING_SIMPLE_PASSWD
2162+
#define MY_ENCRYPTION_SIMPLE_PASSWD
21492163
#define MY_SIGNING_ATSHA204
21502164
#define MY_SIGNING_SOFT
21512165
#define MY_SIGNING_REQUEST_SIGNATURES
21522166
#define MY_SIGNING_WEAK_SECURITY
2153-
#define MY_SIGNING_NODE_WHITELISTING {{.nodeId = GATEWAY_ADDRESS,.serial = {0x09,0x08,0x07,0x06,0x05,0x04,0x03,0x02,0x01}}}
2167+
#define MY_SIGNING_NODE_WHITELISTING
21542168
#define MY_DEBUG_VERBOSE_SIGNING
21552169
#define MY_SIGNING_FEATURE
21562170
#define MY_ENCRYPTION_FEATURE
@@ -2159,7 +2173,7 @@
21592173
#define MY_OTA_USE_I2C_EEPROM
21602174
// RS485
21612175
#define MY_RS485
2162-
#define MY_RS485_HWSERIAL (Serial1)
2176+
#define MY_RS485_HWSERIAL
21632177
// RF24
21642178
#define MY_RADIO_RF24
21652179
#define MY_DEBUG_VERBOSE_RF24

0 commit comments

Comments
 (0)