doxygen - 如何在 Doxygen 中为目录提供描述

Question

我正在与 Doxygen 合作记录我的项目。我知道，通过使用下面的 Doxygen 命令，我们可以对源文件进行描述。

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

有什么方法可以描述 Doxygen 中的目录/文件夹吗？

Answer 1

使用\dirdoxygen 命令。我问了一个类似的问题，如何链接到我展示的目录的文档

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

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