Kotlin / dokka

API documentation engine for Kotlin
https://kotl.in/dokka
Apache License 2.0
3.44k stars 409 forks source link

Links in annotations does not have a correct target #1011

Open MarcinAman opened 4 years ago

MarcinAman commented 4 years ago

Given code:

package example

@Retention(AnnotationRetention.SOURCE)
@Deprecated(message = "Sample deprecation message that is very long and i want to make it even longer because why not")
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.EXPRESSION, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.PROPERTY])
annotation class SampleClass {
}

Placed in example project, in directory: src/jvmMain/kotlin/example/SampleClass.kt

When user generates a GFM output links to annotations are generated incorrectly, for example to: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-retention/-s-o-u-r-c-e/ rather than: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-retention/-s-o-u-r-c-e.html

AristotelispetrosBobas-TomTom commented 2 years ago

Any news on this issue?

IgnatBeresnev commented 2 years ago

@AristotelispetrosBobas-TomTom hi! GFM format is in alpha is is not worked on much at the moment. No updates yet, unfortunately.