dokka icon indicating copy to clipboard operation
dokka copied to clipboard

@See or link usage

Open MakarenkoVlad opened this issue 2 years ago • 1 comments

Is there any correct way to link functions/classes in doc and then see this link in gfm markdown?

MakarenkoVlad avatar Jul 29 '22 14:07 MakarenkoVlad

Hi! Yeah, there doesn't seem to be anything special about it. What sort of problem are you having with it?

Code:

/**
 * @see [IllegalArgumentException] exception
 */
class Class {}

Produces:


//dokka-debug-kts/me.beresnev.dokka.debug.internal/Class

Class

[jvm]
class Class

See also

jvm

kotlin.IllegalArgumentException exception

Constructors

Class [jvm]
fun Class()

IgnatBeresnev avatar Aug 03 '22 11:08 IgnatBeresnev

Closing as resolved. Please let us know if you have any more questions

IgnatBeresnev avatar Aug 17 '22 17:08 IgnatBeresnev