Как мне пропустить строку в kDoc

Question

В моем kDoc я хочу пустую строку между абзацами. Как мне это сделать? (Также есть где-нибудь полное руководство? Например, как создавать таблицы, маркеры и т. Д.?)

Answer 1

Для пустой строки используйте   с пустыми строками до и после него (обе пустые строки необходимы):

Answer 2

kdoc использует уценку, см. также ссылку на kdoc. В справке также говорится, что для встроенной разметки они используют следующую разметку, но она не выглядит полностью поддерживаемой. Или, по крайней мере, Intellij IDEA (и, следовательно, вероятно, также Android Studio) не отображает его, как описывает ссылка на уценку. Может быть, лучше, когда генерируется через Dokka. Еще не пробовал.

Так что если у вас есть названия (#) или используйте пустую строку, это даст вам соответствующий интервал между строками, например:

# Title (or ### title)

this line has some space before

или просто используя пустую строку:

first line is the summary.

this line is now just written as the second line in your documentation. no space before... but maybe that suffices already...

Если вы разместите <br /> там нужно добавить новую строку, но по крайней мере в Intellij IDEA это не сработало. Однако это сработало при размещении в ``` -код-комментарий. Возможно ошибка... возможно особенность в Intellij IDEA? Было бы хорошо, если бы кто-нибудь мог поиграть с Доккой и дать соответствующий ответ на это, просто хотел бы поделиться тем, что я знаю об этом до сих пор. _{(должен уйти сейчас)}

Answer 3

Dokka действительно обрабатывает пустые строки как разделители абзацев, но игнорирует <br> а также <br/>, Рассмотрим следующий фрагмент KDoc:

/**
 * This is the 1st paragraph.
 *
 * And this is the 2nd one. _IDEA_ indeed ignores any line breaks between
 * paragraphs.
 *
 * # Heading 1
 *
 * This is the text after the heading.
 *
 * ### Heading 3
 *
 * This is the text after the heading.
 * <br>
 * This line is separated with `<br>`.
 * <br/>
 * And this one is separated with `<br/>`.
 */
class C

Вот как это отображается в HTML: