使用Doxygen输出HTML的完整文件路径

时间:2015-03-11 13:48:12

标签: doxygen

我正在使用\ test特殊命令在Doxygen中创建一个测试列表。我知道我可以点击该部分的类名,然后进入该测试参考的页面。

然而,我想要的是它的测试描述中有一条线是完整的文件路径。

这是否有特殊命令?或者我是否必须在每个评论栏中进行实际输入。下面我展示了我想要的一个例子。

Class myTest
    Perform a set of tests to verify foo & bar.
    located in C:\MyFile

但我想像这样写出我的Doxygen评论:

/** \test
 *   Perform a set of tests to verify foo & bar.
 *   located in:
 *   \fullFilePath
 */

这可能吗?

1 个答案:

答案 0 :(得分:1)

仔细检查了特殊命令,我得出的结论是,没有Doxygen特殊命令可以在问题中给出结果。

Doxygen确实为它知道存在的页面/文件提供自动超链接。因此,为了解决"这个问题 [1] 我添加了创建可导航链接所需的最小路径名称。此解决方案如下所示:

/** \test
 *   Perform a set of tests to verify foo & bar.
 *   located in:
 *   someFolder/myFile.cpp
 */

这适用于文件路径,例如:C:/parentFolder/childFolder/someFolder/myFile.cpp


[1] 最初的问题集中在不必将文件路径输入到每个注释块中。这个解决方案是在没有特殊命令而不必写出完整文件路径(有时可能很长)之间的妥协。