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

Question

我正在使用 \test 特殊命令在 Doxygen 中创建一个测试列表。我知道我可以单击该部分的 class 名称，然后转到该测试也作为参考的页面。

然而，我希望在测试说明中有一行是完整的文件路径。

有专门的命令吗？还是我必须将其实际输入到每个评论块中。下面我展示了一个我想要的例子。

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
 */

这可能吗？

Answer 1

在搜索了特殊命令后，我得出的结论是没有 Doxygen 特殊命令可以给出问题中的结果。

Doxygen 确实为它知道存在的 pages/files 提供了自动 hyperlinking。因此，为了 "solve" 这个问题 ^[1] 我添加了创建可导航 link 所需的最少路径名。此解决方案如下所示：

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

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

^[1] 最初的问题集中在不必在每个注释块中输入文件路径。这个解决方案是在没有特殊命令和不必写出完整文件路径（有时可能很长）之间的折衷

Output Full File Path to HTML with Doxygen