众所周知如何在Doxygen中获取TODO列表,输入:
\todo Item one
\todo Item two
等等,但是当事情已经完成时,如何跟踪这个?
如果我已完成第二项,我不想删除它,我想将其标记为已完成:
\todo Item ono
\done Item two
我该怎么做呢?
我在Doxygen文档中挖了一下,偶然发现了\xrefitem
。它应该是:
命令的概括,例如\ todo和\ bug。它可用于创建用户定义的文本部分,这些部分在出现位置和将生成的相关页面之间自动交叉引用。在相关页面上,将收集相同类型的所有部分。
第一个参数是唯一表示节的类型的标识符。第二个参数是一个带引号的字符串,表示该部分的标题,在该标题下放置作为第四个参数传递的文本。第三个参数(列表标题)用作包含具有相同键的所有项的相关页面的标题。键“todo”,“test”,“bug”和“deprecated”是预定义的。
所以你可以指定一个新的别名,例如你的Doxyfile中的"done"
:
ALIASES + =“done = \ xrefitem done \”已实施TODO \“\”已实施TODO \“”
在您的代码中,您应该能够像所有其他代码一样使用新的"done"
标记:
/// \ done修复了破碎的功能
根据the doxygen manual,\todo
命令没有这样的“逆”。也许你可以保持\todo
并手动将其标记为已完成,不知何故。
不幸的是doxygen的Markdown似乎并不支持 删除线 (显然与Stack Overflow不同),否则这将是一个很好的常见选择。也许您可以使用自定义样式和跨度进行设置。