如何在Dokka中创建嵌套列表?

时间:2018-03-14 20:26:50

标签: kotlin kotlin-dokka kdoc

尝试使用非常常规的结构记录一些Kotlin代码:

  1. 编号清单。
    • 使用项目符号列表。
  2. 数字在列表顶层正确继续的位置。
  3. 我认为official Dokka page在页面上甚至没有“list”这个词。谷歌搜索没有找到任何关于如何做到这一点的信息。救命啊!

2 个答案:

答案 0 :(得分:5)

据我所知,嵌套四个空格的附加缩进有效:

/**
 * 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

结果是:

enter image description here

答案 1 :(得分:1)

Dokka使用markdown,它有一些叉子和味道,而且根本没有标准化,但这有效:

/**
 * list:
 * - item1
 * - item2
 *
 * numbered:
 * 1. one
 * 2. two
 */

this is what it will look like