Update the latest release version 0.1.0 in documentation

quarkiverse · Nov 10, 2024 · 093bd78 · 093bd78
1 parent b86b1a3
commit 093bd78
Show file tree

Hide file tree

Showing 3 changed files with 209 additions and 1 deletion.
diff --git a/docs/modules/ROOT/pages/includes/attributes.adoc b/docs/modules/ROOT/pages/includes/attributes.adoc
@@ -1,3 +1,3 @@
-:project-version: 0
+:project-version: 0.1.0
 
 :examples-dir: ./../examples/
diff --git a/docs/modules/ROOT/pages/includes/quarkus-fury.adoc b/docs/modules/ROOT/pages/includes/quarkus-fury.adoc
@@ -24,6 +24,110 @@ endif::add-copy-button-to-env-var[]
 |boolean
 |`true`
 
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-track-ref]] [.property-path]##link:#quarkus-fury_quarkus-fury-track-ref[`quarkus.fury.track-ref`]##
+
+[.description]
+--
+Whether track shared or circular references.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_TRACK_REF+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_TRACK_REF+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-compatible-mode]] [.property-path]##link:#quarkus-fury_quarkus-fury-compatible-mode[`quarkus.fury.compatible-mode`]##
+
+[.description]
+--
+Set class schema compatible mode.  +
+SCHEMA_CONSISTENT: Class schema must be consistent between serialization peer and deserialization peer.  +
+COMPATIBLE: Class schema can be different between serialization peer and deserialization peer. They can add/delete fields independently.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_COMPATIBLE_MODE+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_COMPATIBLE_MODE+++`
+endif::add-copy-button-to-env-var[]
+--
+a|`schema-consistent`, `compatible`
+|`schema-consistent`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-compress-number]] [.property-path]##link:#quarkus-fury_quarkus-fury-compress-number[`quarkus.fury.compress-number`]##
+
+[.description]
+--
+Use variable length encoding for int/long.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_COMPRESS_NUMBER+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_COMPRESS_NUMBER+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-compress-string]] [.property-path]##link:#quarkus-fury_quarkus-fury-compress-string[`quarkus.fury.compress-string`]##
+
+[.description]
+--
+Whether compress string for small size.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_COMPRESS_STRING+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_COMPRESS_STRING+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-deserialize-nonexistent-class]] [.property-path]##link:#quarkus-fury_quarkus-fury-deserialize-nonexistent-class[`quarkus.fury.deserialize-nonexistent-class`]##
+
+[.description]
+--
+Whether deserialize/skip data of un-existed class. If not enabled, an exception will be thrown if class not exist.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_DESERIALIZE_NONEXISTENT_CLASS+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_DESERIALIZE_NONEXISTENT_CLASS+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-deserialize-nonexistent-enum-value-as-null]] [.property-path]##link:#quarkus-fury_quarkus-fury-deserialize-nonexistent-enum-value-as-null[`quarkus.fury.deserialize-nonexistent-enum-value-as-null`]##
+
+[.description]
+--
+If an enum value doesn't exist, return a null instead of throws exception.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_DESERIALIZE_NONEXISTENT_ENUM_VALUE_AS_NULL+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_DESERIALIZE_NONEXISTENT_ENUM_VALUE_AS_NULL+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
 a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-thread-safe]] [.property-path]##link:#quarkus-fury_quarkus-fury-thread-safe[`quarkus.fury.thread-safe`]##
 
 [.description]

diff --git a/docs/modules/ROOT/pages/includes/quarkus-fury_quarkus.fury.adoc b/docs/modules/ROOT/pages/includes/quarkus-fury_quarkus.fury.adoc
@@ -24,6 +24,110 @@ endif::add-copy-button-to-env-var[]
 |boolean
 |`true`
 
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-track-ref]] [.property-path]##link:#quarkus-fury_quarkus-fury-track-ref[`quarkus.fury.track-ref`]##
+
+[.description]
+--
+Whether track shared or circular references.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_TRACK_REF+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_TRACK_REF+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-compatible-mode]] [.property-path]##link:#quarkus-fury_quarkus-fury-compatible-mode[`quarkus.fury.compatible-mode`]##
+
+[.description]
+--
+Set class schema compatible mode.  +
+SCHEMA_CONSISTENT: Class schema must be consistent between serialization peer and deserialization peer.  +
+COMPATIBLE: Class schema can be different between serialization peer and deserialization peer. They can add/delete fields independently.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_COMPATIBLE_MODE+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_COMPATIBLE_MODE+++`
+endif::add-copy-button-to-env-var[]
+--
+a|`schema-consistent`, `compatible`
+|`schema-consistent`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-compress-number]] [.property-path]##link:#quarkus-fury_quarkus-fury-compress-number[`quarkus.fury.compress-number`]##
+
+[.description]
+--
+Use variable length encoding for int/long.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_COMPRESS_NUMBER+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_COMPRESS_NUMBER+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-compress-string]] [.property-path]##link:#quarkus-fury_quarkus-fury-compress-string[`quarkus.fury.compress-string`]##
+
+[.description]
+--
+Whether compress string for small size.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_COMPRESS_STRING+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_COMPRESS_STRING+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-deserialize-nonexistent-class]] [.property-path]##link:#quarkus-fury_quarkus-fury-deserialize-nonexistent-class[`quarkus.fury.deserialize-nonexistent-class`]##
+
+[.description]
+--
+Whether deserialize/skip data of un-existed class. If not enabled, an exception will be thrown if class not exist.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_DESERIALIZE_NONEXISTENT_CLASS+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_DESERIALIZE_NONEXISTENT_CLASS+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
+a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-deserialize-nonexistent-enum-value-as-null]] [.property-path]##link:#quarkus-fury_quarkus-fury-deserialize-nonexistent-enum-value-as-null[`quarkus.fury.deserialize-nonexistent-enum-value-as-null`]##
+
+[.description]
+--
+If an enum value doesn't exist, return a null instead of throws exception.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_FURY_DESERIALIZE_NONEXISTENT_ENUM_VALUE_AS_NULL+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_FURY_DESERIALIZE_NONEXISTENT_ENUM_VALUE_AS_NULL+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`false`
+
 a|icon:lock[title=Fixed at build time] [[quarkus-fury_quarkus-fury-thread-safe]] [.property-path]##link:#quarkus-fury_quarkus-fury-thread-safe[`quarkus.fury.thread-safe`]##
 
 [.description]