summaryrefslogtreecommitdiff
path: root/runtime/commonMain/src/kotlinx/serialization/SerialDescriptor.kt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/commonMain/src/kotlinx/serialization/SerialDescriptor.kt')
-rw-r--r--runtime/commonMain/src/kotlinx/serialization/SerialDescriptor.kt5
1 files changed, 4 insertions, 1 deletions
diff --git a/runtime/commonMain/src/kotlinx/serialization/SerialDescriptor.kt b/runtime/commonMain/src/kotlinx/serialization/SerialDescriptor.kt
index ab1ae5af..5c517f27 100644
--- a/runtime/commonMain/src/kotlinx/serialization/SerialDescriptor.kt
+++ b/runtime/commonMain/src/kotlinx/serialization/SerialDescriptor.kt
@@ -71,12 +71,15 @@ package kotlinx.serialization
* )
*
* // Descriptor for such class:
- * SerialDescriptor("my.package.Data", 3) {
+ * SerialDescriptor("my.package.Data") {
* // intField is deliberately ignored by serializer -- not present in the descriptor as well
* element<Long>("_longField") // longField is named as _longField
* element("stringField", listDescriptor<String>())
* }
* ```
+ *
+ * For a classes that are represented as a single primitive value,
+ * [PrimitiveDescriptor] builder function can be used instead.
*/
public interface SerialDescriptor {
/**