Skip to content

Commit

Permalink
ConfigWizard: Allow options to declare a default value
Browse files Browse the repository at this point in the history
Default values can be used in a tool-specific way to implement e.g.
"reset to default" buttons.
  • Loading branch information
asmellby authored and JonatanAntoni committed Feb 11, 2021
1 parent 6cd40bb commit 042305b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CMSIS/DoxyGen/Pack/src/config_wizard.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 042305b

Please sign in to comment.