列表

Doxygen 提供了多种创建项目列表的方式。

使用破折号

通过在一行的开头放置若干列对齐的减号 (-)，将自动生成一个项目符号列表。除了减号，也可以使用加号 (+) 或星号 (*)。

也可以通过使用减号后跟井号 (#) 或使用数字后跟点号来生成编号列表。

当使用减号后跟可选空格，然后是 [ ] 表示未选中的复选框，以及 [x] 或 [X] 表示选中的复选框时，可以创建带有选中或未选中复选框的列表。

允许列表嵌套，嵌套基于项目的缩进。

这是一个例子

  /*! 
   *  A list of events:
   *    - mouse events
   *         -# mouse move event
   *         -# mouse click event\n
   *            More info about the click event.
   *         -# mouse double click event
   *    - keyboard events
   *         1. key down event
   *         2. key up event
   *    - checkbox list
   *         - [ ] unchecked
   *         - [x] checked
   *
   *  More text here.
   */

结果将是

事件列表

• 鼠标事件
  1. 鼠标移动事件
  2. 鼠标点击事件
     有关点击事件的更多信息。
  3. 鼠标双击事件
• 键盘事件
  1. 按键按下事件
  2. 按键抬起事件
• 复选框列表
  • 未选中
  • 已选中

这里有更多文字。

如果在列表内使用制表符进行缩进，请确保配置文件中的 TAB_SIZE 设置为正确的制表符大小。

您可以通过开始一个新的段落或在与要结束的列表相同缩进级别的空行上放置一个点 (.) 来结束列表。

这是一个不言自明的例子

/**
 * Text before the list
 * - list item 1
 *   - sub item 1
 *     - sub sub item 1
 *     - sub sub item 2
 *     . 
 *     The dot above ends the sub sub item list.
 *
 *     More text for the first sub item
 *   .
 *   The dot above ends the first sub item.
 *
 *   More text for the first list item
 *   - sub item 2
 *   - sub item 3
 * - list item 2
 * .
 * More text in the same paragraph.
 *
 * More text in a new paragraph.
 */

使用 HTML 命令

如果您愿意，也可以在文档块内使用 HTML 命令。

这是带有 HTML 命令的上述示例

  /*! 
   *  A list of events:
   *  <ul>
   *  <li> mouse events
   *     <ol>
   *     <li>mouse move event
   *     <li>mouse click event<br>
   *         More info about the click event.
   *     <li>mouse double click event
   *     </ol>
   *  <li> keyboard events
   *     <ol>     
   *     <li>key down event
   *     <li>key up event
   *     </ol>
   *  </ul>
   *  More text here.
   */

注意

在这种情况下，缩进并不重要。

使用 \arg 或 \li

为了与 Qt Software 的内部文档工具 qdoc 和 KDoc 兼容，Doxygen 有两个命令可用于创建简单的非嵌套列表。

有关更多信息，请参阅 \arg 和 \li。

转到下一部分或返回到索引。