doxygen - 如何链接到目录文档

Question

我添加了\dir注释来为目录提供其他文档。但是我无法使用我知道的任何doxygen链接技术链接到该目录文档。我的问题是:如何正确链接到目录的文档？

以下是我尝试过的内容的摘要。我收到两个警告，但没有生成链接。 doxygen手册的“自动链接”部分讨论了Links to other members，但未提及指向目录的链接。是否支持链接到目录文档？如果是这样，我是在做错什么还是一个错误？ (我现在正在使用1.8.10。1.8.9.1的行为方式相同。)

这是我尝试过的。我已经记录了使用的目录

/// \dir cpp/vtutil 
///      
/// \brief Brief description of the dir cpp/vtutil goes here
/// 
/// \details A more detailed description goes here. 
///        

我引用目录使用

/// \file   
/// \brief  Implements the vt application class.
/// 
/// This file is in the \ref cpp/vtutil directory.
/// What about #cpp/vtutil

以下是警告:

warning : unable to resolve reference to `cpp/vtutil' for \ref command
warning : explicit link request to 'cpp' could not be resolved

该文档用于目录，但是似乎没有引用它的方法。我衷心感谢您的帮助。

Answer 1

链接到目录的文档页面的正确方法是使用\ref命令。目录不支持使用#的显式链接。

/// \file   
/// \brief  Implements the vt application class.
/// 
/// This file is in the \ref cpp/vtutil directory.

本示例将生成一个指向 cpp/vtutil文件夹的文档的链接。但是，在使用绝对路径和 STRIP_FROM_PATH的doxygen配置设置时，一定要小心。当我在源代码树中的工作目录中运行doxygen时，可以获得正确的链接引用。但是，当我从与源目录不同的构建目录运行时，需要使用 STRIP_FROM_PATH时，就会遇到问题。

对于使用 \dir命令记录目录时使用的路径，Doxygen相当宽容或灵活，但是使用 \ref命令引用目录时，它相当挑剔。