如何链接到目录的文档

Question

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

下面是我尝试过的片段.我收到两个警告,没有生成链接.doxygen手册的自动链接部分讨论了与其他成员的链接,但没有提到dirs的链接.是否支持链接到目录文档？如果是这样,我做错了什么或这是一个错误？(我现在正在使用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。然而，在使用绝对路径和 doxygen 配置设置时需要小心STRIP_FROM_PATH。当我使用源树中的工作目录运行 doxygen 时，我可以获得正确的链接引用。但是，当我从与源目录不同的构建目录运行并且需要使用 时STRIP_FROM_PATH，就会遇到问题。

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