From fb5a8e1fd61fd4e5fa6d974dcdf71c6e8a8553e9 Mon Sep 17 00:00:00 2001 From: Martynas Gurskas Date: Thu, 11 Apr 2024 16:05:05 +0300 Subject: [PATCH] Update docs Signed-off-by: Martynas Gurskas --- CHANGELOG.md | 5 +++++ docs/CONFIGURATION.md | 6 ++++++ 2 files changed, 11 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 18df8b9..5c1aad9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +#### v0.6.0+v0.25.0 + +---- +- Core: Added ability to customize enum variant naming styles +- Core: **BREAKING** Changed default enum variant naming style #### v0.5.0+v0.25.0 ---- diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md index 6dfa65f..68f93df 100644 --- a/docs/CONFIGURATION.md +++ b/docs/CONFIGURATION.md @@ -30,3 +30,9 @@ uniffi-bindgen-cpp path/to/definitions.udl --config path/to/uniffi.toml - `from_custom` (required) - an expression to convert from the custom type into underlying type. `{}` will will be expanded into variable containing the custom value. The expression is used in a return statement, i.e. `return `. + +- `enum_style` - style for enum variant naming, possible options are: + - `"Capitalized"` - producing enum variants named `ENUM_VARIANT` + - `"Google"` - producing enum variants name `kEnumVariant` (default) + +NOTE: the `enum_style` option is separate for bindings and scaffolding generators, to apply this to the scaffolding generator, use the section `[scaffolding.cpp]` instead.