Update docs

Signed-off-by: Martynas Gurskas <martynas.gurskas@nordsec.com>
NordSecurity · Apr 11, 2024 · 3a5b586 · 3a5b586
1 parent b5db753
commit 3a5b586
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+#### v0.6.0+v0.25.0
+
+----
+- Core: Added ability to customize enum variant naming styles
+- Core: **BREAKING** Changed default enum variant naming style to `kEnumVariant`
+
 #### v0.5.0+v0.25.0
 
 ----

diff --git 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 <expression(value);>`.
+
+- `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.