Skip to content

Commit e90d659

Browse files
committed
Fixed to attach documentation to properties
Previously, documentation was given for the parameters of the primary constructor, since the properties are the correct target to be referenced. In addition, some broken links and missing documentation for kotlinePropertyNameAsImplicitName have been fixed.
1 parent b2be4ae commit e90d659

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

src/main/kotlin/com/fasterxml/jackson/module/kotlin/KotlinModule.kt

+17-15
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,23 @@ import kotlin.reflect.KClass
1616
fun Class<*>.isKotlinClass(): Boolean = this.isAnnotationPresent(Metadata::class.java)
1717

1818
/**
19-
* @param reflectionCacheSize Default: 512. Size, in items, of the caches used for mapping objects.
20-
* @param nullToEmptyCollection Default: false. Whether to deserialize null values for collection properties as
21-
* empty collections.
22-
* @param nullToEmptyMap Default: false. Whether to deserialize null values for a map property to an empty
23-
* map object.
24-
* @param nullIsSameAsDefault Default false. Whether to treat null values as absent when deserializing, thereby
25-
* using the default value provided in Kotlin.
26-
* @param singletonSupport Default: DISABLED. Mode for singleton handling.
27-
* See {@link com.fasterxml.jackson.module.kotlin.SingletonSupport label}
28-
* @param strictNullChecks Default: false. Whether to check deserialized collections. With this disabled,
29-
* the default, collections which are typed to disallow null members
30-
* (e.g. List<String>) may contain null values after deserialization. Enabling it
31-
* protects against this but has significant performance impact.
32-
* @param useJavaDurationConversion Default: false. Whether to use [java.time.Duration] as a bridge for [kotlin.time.Duration].
33-
* This allows use Kotlin Duration type with [com.fasterxml.jackson.datatype.jsr310.JavaTimeModule].
19+
* @property reflectionCacheSize Default: 512. Size, in items, of the caches used for mapping objects.
20+
* @property nullToEmptyCollection Default: false. Whether to deserialize null values for collection properties as
21+
* empty collections.
22+
* @property nullToEmptyMap Default: false. Whether to deserialize null values for a map property to an empty
23+
* map object.
24+
* @property nullIsSameAsDefault Default false. Whether to treat null values as absent when deserializing, thereby
25+
* using the default value provided in Kotlin.
26+
* @property singletonSupport Default: DISABLED. Mode for singleton handling.
27+
* See {@link com.fasterxml.jackson.module.kotlin.SingletonSupport label}
28+
* @property strictNullChecks Default: false. Whether to check deserialized collections. With this disabled,
29+
* the default, collections which are typed to disallow null members
30+
* (e.g. List<String>) may contain null values after deserialization. Enabling it
31+
* protects against this but has significant performance impact.
32+
* @property kotlinPropertyNameAsImplicitName Default: false. Whether to use the Kotlin property name as the implicit name.
33+
* See [KotlinFeature.KotlinPropertyNameAsImplicitName] for details.
34+
* @property useJavaDurationConversion Default: false. Whether to use [java.time.Duration] as a bridge for [kotlin.time.Duration].
35+
* This allows use Kotlin Duration type with [com.fasterxml.jackson.datatype.jsr310.JavaTimeModule].
3436
*/
3537
class KotlinModule @Deprecated(
3638
level = DeprecationLevel.ERROR,

0 commit comments

Comments
 (0)