Skip to content

Commit a9aa676

Browse files
committed
docs: add new documentation of 'EnumValues' attribute
The new attribute can be used for C++ enums to instruct the generator to create a helper function that returns unique enum values. Signed-off-by: Patryk Wrobel <183546751+pwrobeldev@users.noreply.github.com>
1 parent 185a289 commit a9aa676

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

docs/lime_attributes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,7 @@ quotes need to be backslash-escaped, as in the example.
214214
in C++ generated code. For example, `@Cpp(Type="std::chrono::steady_clock::time_point") Date` will use monotonic clock
215215
time point type, instead of the system clock time point type which is used by default.
216216
* **ToString**: marks an enumeration to have a helper `to_string()` function generated, mapping the enum to string.
217+
* **EnumValues**: marks an enumeration to have a helper `<ENUM_NAME>_enumerators()` function generated. It returns array of unique enum values.
217218
* **Skip** \[**=** **"**_CustomTag_**"** \]: marks an element to be skipped (not generated) in C++. Can be applied to
218219
`field constuctor` or `const` elements only. Optionally, if custom tag is specified, the element is only skipped if
219220
that tag was defined (see `@Skip` above).

0 commit comments

Comments
 (0)