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

时间:2014-09-23 20:26:37

标签: c++ doxygen

我正在使用doxywizard。在“专家”选项卡下的“输入项目列表”中,在EXAMPLE_PATH中,我包含了两个路径,每个路径都会生成一个.cpp文件。但是,在生成的文档中,我只看到一个,无论顺序如何。

在Doxyfile中,我看到了:

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

我错过了什么?

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

1 个答案:

答案 0 :(得分:2)

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