dokka icon indicating copy to clipboard operation
dokka copied to clipboard

Resolve reference to a property of argument in kdoc

Open vdshb opened this issue 1 year ago • 0 comments

I can see, that kotlin team is working on better links support in kdoc. I'd like to add a case to the scope which I use from time to time but which is not supported by kdoc yet.

This is a proposal to support properties of arguments resolution in kdoc, e.g.:

data class Config(val isEnabled: Boolean, val driverUrl: String)

/**
 * Works only when [configuration.isEnabled] is `true`.
 */
fun configure(configuration: Config) { /* ... */ }

[configuration] itself is resolved by kdoc engine, but [configuration.isEnabled] is not resolved by kdoc engine.

For me it's pretty common use case.

vdshb avatar Oct 09 '24 15:10 vdshb