Skip to content

Commit

Permalink
ConfigWizard: Support annotating integer arrays
Browse files Browse the repository at this point in the history
Array must have a fixed length. Makes use of the existing value range
modifier to indicate the type of each array element.
  • Loading branch information
asmellby authored and JonatanAntoni committed Feb 11, 2021
1 parent 8433681 commit 4e1b7a4
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CMSIS/DoxyGen/Pack/src/config_wizard.txt
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,21 @@ The following table lists the Configuration Wizard Annotations:
The example sets a size limit of 126 character. Default string is "Keil Software".
</td>
</tr>
<tr>
<td>\<a.<i>i</i>><sup>*+</sup></td>
<td>yes</td>
<td>Option for array entry and a size of <i>i</i> elements.
\code
// <a.16 PUBLIC_KEY> Public key for signing <0..255> <f.h>
// <d> {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}
#define PUBLIC_KEY {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F}
\endcode
The example makes use of the value range modifier to constrain each array element to byte size, has a default value of all-zero,
and uses the format specifier to ensure it is displayed as hexadecimal in the tool.

GUI tools should support array lengths up to 64 elements.
</td>
</tr>
<tr>
<td><i><b>skip example</b></i>
<br> \<q\em n>;
Expand Down

0 comments on commit 4e1b7a4

Please sign in to comment.