Значение статического поля Kotlin в документации по методу?

Мне было интересно, есть ли возможность включить значение статического поля класса в документацию метода класса.

Мы можем связать члены класса и параметры с помощью квадратных скобок:

/**
 * Sets the title of the notification dialog using [title]
 *
 * The maximum title length allowed is [MAX_TITLE_LENGTH]
 */
fun setTitle(title: String): NotificationDialog.Builder {
    if(title.length <= MAX_TITLE_LENGTH)
        mTitle = title
    else
        mTitle = title.substring(0, MAX_TITLE_LENGTH)

    return this
}

Цель

Но хотелось бы, чтобы в документации метода было значение MAX_TITLE_LENGTH, а не ссылка на его название.

Для полноты вот мое определение класса:

class Builder(val context: Context) {
    private var mTitle = ""

    /**
     * Sets the title of the notification dialog using [title]
     *
     * The maximum title length allowed is [MAX_TITLE_LENGTH]
     */
    fun setTitle(title: String): NotificationDialog.Builder {
        if(title.length <= MAX_TITLE_LENGTH)
            mTitle = title
        else
            mTitle = title.substring(0, MAX_TITLE_LENGTH)

        return this
    }

    fun build(): NotificationDialog {
        return NotificationDialog(context, mTitle)
    }

    companion object {
        private const val MAX_TITLE_LENGTH = 20
    }
}

Заранее спасибо.


person Trickzter    schedule 07.08.2019    source источник
comment
Я не нашел этот! +1 за это спасибо.   -  person Trickzter    schedule 08.08.2019


Ответы (1)


Ничего подобного нет, потому что KDoc основан на языке разметки. Вместо этого использование скобок позволяет связать свойства класса. Подробнее см. здесь: https://kotlinlang.org/docs/reference/kotlin-doc.html#inline-markup

person mregulski    schedule 07.08.2019
comment
Да, но он также основан на синтаксисе JavaDoc, как вы можете видеть здесь: kotlinlang.org/docs /reference/kotlin-doc.html В stackoverflow.com/questions/11426959/ является примером использования аннотации @value, но в документах говорится, что kotlin не поддерживает это. Поэтому я подумал, что может быть другой способ добиться того, что делает «@value». - person Trickzter; 07.08.2019
comment
Без постобработки html я не думаю, что это возможно прямо сейчас. - person mregulski; 07.08.2019