如何在Doxygen中给出目录的描述

Question

我正在使用Doxygen来记录我的项目。我知道，通过使用下面的Doxygen命令，我们可以给出源文件的描述。

/**
* \file example.cpp
* \brief Implementation of example functions 
*/

有没有办法在Doxygen中为目录/文件夹提供描述？

Answer 1

使用\dir doxygen命令。我问了一个类似的问题how to link to documentation of directory，其中我展示了

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

这可以提供目录的文档。在我原来的问题中，我无法使用\ref链接到目录文档。经过更多的挖掘和实验，我能够让它发挥作用。我在答案中评论说 使用\dir命令记录目录时，Doxygen对于使用的路径非常宽容或灵活，但在使用\ref命令引用目录时，它是相当挑剔的。