RDCNWebs/rdkt
4
0
Fork 0
mirror of https://github.com/RDCN-Community-Developers/rdkt.git synced 2026-09-05 01:35:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

Minor docs change.

Browse Source
This commit is contained in:
23333
2026-03-12 03:41:28 +08:00
parent a3236fb8bf
commit 752042526c
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/src/commonMain/kotlin/cn/rdlevel/rdkt/core/serialization/FieldFlatteningSerializer.kt
+2 -2
View File
@@ -24,14 +24,14 @@ public annotation class Flatten
* *
* When serializing, the fields annotated with [Flatten] will be flattened into the parent JSON object. * When serializing, the fields annotated with [Flatten] will be flattened into the parent JSON object.
* When deserializing, the fields annotated with [Flatten] will be deserialized from the parent JSON object, * When deserializing, the fields annotated with [Flatten] will be deserialized from the parent JSON object,
* with elements that do not belong to any non-flattened fields. * with elements that do not belong to any non-flattened fields or [JsonClassDiscriminator] of the base class.
* *
* It's recommended to annotate classes that need to be flattened with [JsonIgnoreUnknownKeys][kotlinx.serialization.json.JsonIgnoreUnknownKeys] * It's recommended to annotate classes that need to be flattened with [JsonIgnoreUnknownKeys][kotlinx.serialization.json.JsonIgnoreUnknownKeys]
* when there are multiple flattened fields, so that fields that only belong to some classes can be ignored when deserializing other classes. * when there are multiple flattened fields, so that fields that only belong to some classes can be ignored when deserializing other classes.
* *
* This serializer only supports JSON encoding and decoding. * This serializer only supports JSON encoding and decoding.
* *
* @param tSerializer The serializer, usually the [generated one][kotlinx.serialization.KeepGeneratedSerializer], for the type T that this serializer will delegate to. * @param tSerializer The serializer, usually the [generated one][kotlinx.serialization.KeepGeneratedSerializer], for the type [T] that this serializer will delegate to.
*/ */
@OptIn(ExperimentalSerializationApi::class) @OptIn(ExperimentalSerializationApi::class)
@RDKTInternalAPI @RDKTInternalAPI