Как сделать вложенный список в Dokka?
Попытка задокументировать некоторый код Kotlin с довольно обычной структурой:
- Нумерованный список.
- С маркированным подсписком.
- Где цифры продолжают правильно на верхнем уровне списка.
То, что я считаю официальной страницей Dokka, даже не имеет слова "список" на странице. Погуглите туда-сюда, не найдя никакой информации о том, как это сделать. Помогите!
2 ответа
Насколько я вижу, вложение с дополнительным отступом четырех пробелов работает:
/**
* 1. A numbered list.
* * With a bulleted sublist.
* 1. Where the numbers continue correctly at the top level of the list.
*/
val foo: Int = 0
Результат:
Докка использует уценку, которая имеет некоторые вилки и ароматы и не стандартизирована вообще, но это работает:
/**
* list:
* - item1
* - item2
*
* numbered:
* 1. one
* 2. two
*/