【发布时间】:2013-07-01 10:47:57
【问题描述】:
众所周知,如何在 Doxygen 中获取 TODO 列表,输入:
\todo Item one
\todo Item two
等等,但是当事情已经完成时,如何跟踪呢?
如果我已经完成了第二项,我不想删除它,我想将其标记为完成:
\todo Item ono
\done Item two
我该怎么做?
【问题讨论】:
标签: c documentation doxygen
众所周知,如何在 Doxygen 中获取 TODO 列表,输入:
\todo Item one
\todo Item two
等等,但是当事情已经完成时,如何跟踪呢?
如果我已经完成了第二项,我不想删除它,我想将其标记为完成:
\todo Item ono
\done Item two
我该怎么做?
【问题讨论】:
标签: c documentation doxygen
我翻遍了 Doxygen 文档并偶然发现了 \xrefitem。应该是:
\todo 和 \bug 等命令的概括。它可以用来 创建自动生成的用户定义文本部分 发生地点和相关页面之间的交叉引用, 这将产生。在相关页面上相同的所有部分 类型将被收集。
第一个参数是一个标识符,唯一地表示 部分的类型。第二个参数是一个带引号的字符串 表示文本作为传递的部分的标题 提出第四个论点。第三个参数(列表标题)用作 包含具有相同键的所有项目的相关页面的标题。这 “todo”、“test”、“bug”和“deprecated”键是预定义的。
所以你可以指定一个新的别名,例如"done" 在你的 Doxyfile 中:
ALIASES += "done=\xrefitem done \"Implemented TODOs\" \"Implemented 待办事项\" "
在您的代码中,您应该能够像所有其他代码一样使用新的"done" 标签:
/// \done 修复了损坏的功能
【讨论】:
根据the doxygen manual,\todo 命令没有这样的“逆”。也许您可以保留\todo 并以某种方式手动将其标记为已完成。
不幸的是,doxygen 的 Markdown 似乎不支持 删除线(显然与 Stack Overflow 不同),否则这将是一个不错的常见选择。也许您可以使用自定义样式和跨度进行设置。
【讨论】: