Как документировать параметр основного конструктора с помощью Kotlin Dokka

Question

Как документировать параметр основного конструктора с помощью Kotlin Dokka

Допустим, есть класс, первичный конструктор которого имеет параметр param, который я хотел бы разрешить (связать с фактическим параметром) в блоке doc класса.

/** Class A does something using [param]. 

@constructor constructs A with [param].

*/

class A (param: Int)

Однако надпись param выделяется IDE, говоря, что она не может разрешить символ param.

519 1

kotlin kotlin-dokka

1 ответ:

Comments

Ничего не найдено.

hotkey · Accepted Answer · 2017-09-19 16:24:45

На самом деле, dokka правильно находит параметр, если вы ссылаетесь на него с помощью [param] в абзаце @constructor, Вы можете проверить это, проверив URL, который появляется в собранных документах, который выглядит следующим образом:
file:///.../some.package/-a/-init-.html#some.package.A$<init>(kotlin.Int)/param
По-видимому, предупреждение о неразрешенной ссылке является проблемой с поддержкой IDE для KDoc. Пожалуйста, сообщите об этом по адресу kotl.in/issue .

Другой вариант-использовать @param в классе KDoc:
/** 
 * Class A does something using [param]. 
 * @param param means something special.
*/
class A (param: Int)