ConfigWizard: Allow options to declare a default value
Default values can be used in a tool-specific way to implement e.g.
"reset to default" buttons.
@@ -64,6 +64,7 @@ The following table lists the Configuration Wizard Annotations:
// <o>Round-Robin Timeout [ticks] <1-1000>
// \<i> Defines how long a thread will execute before a thread switch.
// \<i> Default: 5
+ // \<d> 5
#ifndef OS_ROBINTOUT
#define OS_ROBINTOUT 5
#endif
@@ -110,6 +111,21 @@ The following table lists the Configuration Wizard Annotations:
Many examples in this table have tooltip examples.
</td>
</tr>
+ <tr>
+ <td>\<d></td>
+ <td>yes</td>
+ <td>Default value for previous item.
+ \code
+ // <o MODE> Operation Mode
+ // <modeOne=> Mode 1
+ // <modeTwo=> Mode 2
+ // <d> modeOne
+ // #define MODE modeTwo
+ \endcode
+ Binary options, such as \<e> and \<q>, use <code>0</code> and <code>1</code> to signify "disabled" and "enabled", respectively.
+ Annotating options with a default value enables tools to implement "reset to default" functionality.
+ </td>
+ </tr>
<tr>
<td>\<c><sup>*</sup></td>
<td>yes</td>
@@ -168,6 +184,7 @@ The following table lists the Configuration Wizard Annotations:
// <o>Round-Robin Timeout [ticks] <1-1000> -- text displayed on screen. Range of [ticks] is [1..1000]
// \<i> Defines how long a thread will execute before a thread switch. -- tooltip info
// \<i> Default: 5 -- tooltip info. Both displayed in one tooltip.
+ // \<d> 5 -- default value
#ifndef OS_ROBINTOUT
#define OS_ROBINTOUT 5
#endif
@@ -316,6 +333,7 @@ The following table lists the Configuration Wizard Annotations:
// <6=> Realtime (highest)
// <i> Defines priority for Timer Thread -- tooltip info
// <i> Default: High -- tooltip info
+ // <d> 5 -- default value
#ifndef OS_TIMERPRIO
#define OS_TIMERPRIO 5
#endif
