使用 doxygen 获取完成列表

Question

众所周知，如何在 Doxygen 中获取 TODO 列表，输入：

\todo Item one
\todo Item two

等等，但是当某件事完成后，如何跟踪呢？

如果我已经完成了第二项，我不想删除它，我想将其标记为已完成：

\todo Item ono
\done Item two

我该怎么做呢？

Answer 1

我仔细研究了 Doxygen 文档并偶然发现了\xrefitem. 应该是：

\todo 和 \bug 等命令的概括。它可用于创建用户定义的文本部分，这些文本部分会在发生位置和将生成的相关页面之间自动交叉引用。在相关页面上，将收集相同类型的所有部分。

第一个参数是唯一表示节类型的标识符。第二个参数是一个带引号的字符串，表示作为第四个参数传递的文本所在的部分的标题。第三个参数（列表标题）用作包含具有相同键的所有项目的相关页面的标题。键“todo”、“test”、“bug”和“deprecated”是预定义的。

所以你可以指定一个新的别名，例如"done"在你的 Doxyfile 中：

ALIASES += "done=\xrefitem did \"已实现的 TODO\" \"已实现的 TODO\" "

在您的代码中，您应该能够"done"像所有其他标签一样使用新标签：

/// \done 修复了损坏的功能