Doxygen @todo Tag

时间:2012-05-01 17:06:07

标签: formatting doxygen todo

当我在最新版本的doxygen(1.8)的列表中有其他格式化数据时,@todo命令出现了一个奇怪的问题。请考虑以下示例:

/**
@page build_instructions Build Instructions
- Library1
    - @todo Detail build process

    - get source
    - build release/debug version for x64
    - build release/debug version for x86
*/

如果你运行它,你会注意到@todo标记为最后两个列表项添加了额外的缩进(在“获取源”之后)。如果删除@todo标记,则缩进看起来没问题。另外,如果我删除-前面的@todo,则会将其下方的项目封装在一个框中。

这是一个错误吗?如何使@todo标记仅影响一行?

1 个答案:

答案 0 :(得分:3)

我可以确认这一点:你的代码工作在1.5而不是1.8,所以它看起来像一个bug。下面是两种可能的解决方法:

  • 尝试将todo项目作为列表中的最后一个元素,

  • 如果您希望列表中的todo项位于顶部(或最后一个元素以外的任何位置),请尝试在{{后面的每个列表项之间放置一个空行1}} item。