Cómo usar @link y @code en kotlin kDoc

Estoy intentando documentar un método e intentar usar @link y @code como en JavaDoc .

Sé que en kotlin hay un kDoc pero no puedo encontrarlos o al less algo similar.

@link y @code no existen en kDoc pero pueden ser reemplazados fácilmente por Inline Markup .

de KotlinDoc Enlace a elementos

Marcado en línea

Para el marcado en línea, KDoc utiliza la syntax Markdown regular, extendida para admitir una syntax abreviada para vincular a otros elementos en el código.

Enlazando a los elementos

Para vincular a otro elemento (class, método, propiedad o parámetro), simplemente ponga su nombre entre corchetes:

Usa el método [foo] para este propósito.

Si desea especificar una label personalizada para el enlace, use la syntax de estilo de reference de networkingucción:

Usa [this method][foo] para este propósito. También puede usar nombres calificados en los enlaces. Tenga en count que, a diferencia de JavaDoc, los nombres calificados siempre usan el carácter de punto para separar los componentes, incluso antes de un nombre de método:

Utilice [kotlin.reflect.KClass.properties] para enumerar las properties de la class. Los nombres en los enlaces se resuelven usando las mismas reglas que si el nombre se usara dentro del elemento que se está documentando. En particular, esto significa que si ha importado un nombre en el file actual, no necesita calificarlo completamente cuando lo usa en un comentario de KDoc.

Tenga en count que KDoc no tiene ninguna syntax para resolver miembros sobrecargados en los enlaces. Dado que la herramienta de generación de documentation de Kotlin coloca la documentation de todas las sobrecargas de una function en la misma página, no es necesario identificar una function sobrecargada específica para que el enlace funcione.

  • ¿Se espera que pueda llamar a una function con un object receptor pasando el object receptor como primer argumento?
  • ¿Las coroutines de kotlin tienen llamada asincrónica con timer?
  • Implementando una interfaz con function parametrizada
  • ¿Cómo get identificadores comprobados en ListView a través de Kotlin?
  • El renderizador de forma libGDX no dibuja después de presionar el button Atrás
  • tornadofx EventBus expande la fila de la tabla usando el object tableview
  • PubNub suscribe Android Kotlin
  • Adaptador de enlace de Android no funciona para CustomView
  • Kotlin, problema de condición de carrera
  • Kotlin constructor con super class
  • Kotlin sintético en adaptador o ViewHolder