Doxygen中多个源文件的示例

Question

我正在记录一组使用Doxygen一起工作的类，我编写了一个跨多个源文件的示例（所有引自EXAMPLE_PATH）。更准确地说，我写了以下内容：

/*************************************//**
 * Some context...
 *  @example Source1.cpp
 *
 * More context...
 *  @example Source2.cpp
 ****************************************/

问题是输出在Doxygen生成的Example页面中展开了一半（Source1的页面，Source2的另一个页面）。我希望它都在同一个HTML页面上，将上下文和示例代码放在一起作为一个教程：

Some context...
|----------------------------------------------|
| int main()                                   |
| {                                            |
|   //...                                      |
| }                                            |
|----------------------------------------------|

More context...
|----------------------------------------------|
| bool fct()                                   |
| {                                            |
|   //...                                      |
| }                                            |
|----------------------------------------------|

有没有办法实现这个目标？我正在使用Doxygen 1.8.11。

此致

Answer 1

我找到了一个半合法的解决方案：如果您在开头添加@example标记并在之后使用@include，则可行：

/*************************************//**
 * @example "My tutorial"
 * 
 * Some context...
 *  @include Source1.cpp
 *
 * More context...
 *  @include Source2.cpp
 ****************************************/

但是，查看Doxygen的错误输出，我收到以下消息：warning: included file My is not found. Check your EXAMPLE_PATH

解决方案不干净，但暂时可以使用。如果你有更好的建议（即删除警告），请分享，我会接受。