【问题标题】:Doxygen's page across multiple comments block跨多个评论块的 Doxygen 页面
【发布时间】:2015-10-08 10:17:54
【问题描述】:

为了为我的 Catch 测试编写文档,我想做这样的事情:

/// \page TEST_CALCULATOR Test Calculator
/// Testing is so cool... !
SCENARIO("Compute things...") {
    /// Test a simple formula :
    /// \code
    WHEN("23 2 + 3 +") {
       // here is the tested code
    }
    /// \endcode
}

这个想法是有一个编译源文件和一个包含与源实现相关的代码示例的文档。

关键是,Doxygen 似乎并没有为此创建一个完整的页面。生成的页面只包含“Testing is so cool...!”。 关于如何做这样的事情的任何想法?

非常感谢!

【问题讨论】:

  • \page 命令在其注释块的末尾停止,这不是我想要的行为。除了仅在源文件的文档中显示之外,其余部分都运行良好。

标签: c doxygen


【解决方案1】:

你应该使用'example'标签。

http://www.doxygen.nl/manual/commands.html#cmdexample

【讨论】:

  • 是的,但它包括整个文件的内容。实际上,我想在同一个文件中编写与场景一样多的部分(以避免源和文档之间的错误关联)。
猜你喜欢
  • 1970-01-01
  • 2012-11-18
  • 1970-01-01
  • 2020-05-12
  • 1970-01-01
  • 2012-06-26
  • 1970-01-01
  • 2011-12-12
  • 1970-01-01
相关资源
最近更新 更多