feat: adding the Serialize classes page #3097
Conversation
| @@ -0,0 +1,505 @@ | |||
| [//]: # (title: Serialize classes) | |||
|
|
|||
| The [`@Serializable`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serializable/) annotation in Kotlin enables the serialization of all properties in classes defined by the primary constructor. | |||
There was a problem hiding this comment.
nice, good point - changed it to properties with backing fields here as well 👍
| ``` | ||
| {kotlin-runnable="true"} | ||
|
|
||
| ### Set default values for optional properties |
There was a problem hiding this comment.
Summing up all commentaries above, I think this section should be put much earlier — before dropping nulls and mentioning that initializers are not always called for optionals. I think it even worth its own sub-section in the navigation pane on the right. E.g.:
- Optional properties
- setting default value
- default values are dropped by default (example with null)
- initializer is not always called
- controlling behavior with @EncodeDefault
- making properties @Required
There was a problem hiding this comment.
I really like the idea 👍 I restructured it
I'm a bit unsure about @Required and @Transient. They mention default values, but I think those might be a better fit in ## Customize class serialization.
But moving everything else about Optional properties solves a lot of issues 👍
There was a problem hiding this comment.
Transient indeed fits into ## Customize class serialization.. @Required directly affects properties with optional values (and doesn't make sense without one), so I think it's still better to place it here.
| @@ -0,0 +1,505 @@ | |||
| [//]: # (title: Serialize classes) | |||
|
|
|||
| The [`@Serializable`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization/-serializable/) annotation in Kotlin enables the serialization of all properties in classes defined by the primary constructor. | |||
There was a problem hiding this comment.
nice, good point - changed it to properties with backing fields here as well 👍
sandwwraith
left a comment
sandwwraith
left a comment
There was a problem hiding this comment.
I do not know whether we'll finish whole review before mid-December (I expect next release of serialization there), but we can leave opt-in note for now and delete it later.
Besides that, please fix "Defines..." wording and my other comment and we're good to go
This is the fourth part of the Kotlin Serialization rewrite task.
Related YouTract ticket is here: KT-81889 [Docs] Create a Serialize classes page for kotlinx.serialization