c++ - 如何在 Doxygen 中拥有多个示例?

标签 c++ doxygen

我正在使用 doxywizard。在 Expert 选项卡下,在 Input item-list 的 EXAMPLE_PATH 中,我包含了两个路径,每个路径都指向一个 .cpp 文件。但是,在生成的文档中,无论顺序如何,我只看到了一个。

在 Doxyfile 中,我看到了这个:

EXAMPLE_PATH           = ../../../Inria/rkd/Samaras/final/code/main_boost.cpp \
                         ../../../Inria/rkd/Samaras/final/code/main.cpp

我错过了什么?

如果有直接编辑 Doxyfile 的解决方案,我会很感兴趣。

最佳答案

EXAMPLE_PATH 列出了您存储示例文件的目录。 如果要为特定类添加示例,可以在类的头文件中引用。

EXAMPLE_PATH = ../../../Inria/rkd/Samaras/final/code

/** \example main_boost.cpp
 * This is an example of how to use main_boost.
 */

/** \example main.cpp
 * This is an example of how to use main.
 */

在此处查看更多信息:http://www.doxygen.nl/manual/commands.html#cmdexample

关于c++ - 如何在 Doxygen 中拥有多个示例?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/26004151/

相关文章:

c++ - 在 Android 上进行实时图形编程的最佳语言是什么?

c++ - 为什么编译器在定义类似的模板特化时不会报错?

doxygen - 如何使doxygen在html中使用节编号

数学:doxygen 中的场

c++ - 无法生成调用图 doxygen/graphviz

C++ 多态性和可变参数模板

c++ - 有关保护 DLL 代码的任何提示?

c++ - 将共享指针添加到 vector 时出错

c - Doxygen:成员 my_function 的参数未(全部)记录在案

c++ - 如何使用 doxygen 记录 C++ 模板和模板元函数?