DoxyGen文档之六

 

第三章：Lists列表

Doxygen有很多方法来创建项目列表

Using dashes 使用短横杠

在每个行的开始处以“-”打头，以下缩进对齐，列表每项也以“-”打头，下面是个例子

  /*!

   *  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

   *         -# key down event

   *         -# key up event

   *

   *  More text here.

   */

这样就会生成一个事件列表

·mouse events

1.     mouse move event

2.     mouse click event
More info about the click event.

3.     mouse double click event

·keyboard events

1.     key down event

2.     key up event

More text here.

如果你一直使用tabs，那么要检查配置configuration文件中的TAB_SIZE设置是正确的。

使用“.”可以结束一个list，开始一个新的paragraph，必须于需要对应的“-”对齐。

下面是个例子：

/**

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

 */

Using HTML commands 使用HTML命令

如果你喜欢可以考虑在文档块中使用HTML命令。这样可能更自然一些。下面有个例子

   

注意：在此不需要对齐

Using /arg or @li

For compatibility with the Troll Tech's internal documentation tool and with KDoc, doxygen has two commands that can be used to create simple unnested lists.

See /arg and /li for more info.