如何在Doxygen中提供目录描述 [英] How to give description for directory in Doxygen

问题描述

我正在与Doxygen合作来记录我的项目。我知道，通过使用以下Doxygen命令，我们可以为源文件提供描述。

I am working with Doxygen to document my project. I know, by using the below Doxygen commands, we can give a description for source files.

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

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

Is there any way to give a description for a directory/folder in Doxygen?

推荐答案

使用 \dir doxygen命令。我问了一个类似的问题，如何链接到我在其中显示的目录文档

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

此功能可提供目录的文档。在我最初的问题中，我在使用 \ref 链接到目录文档时遇到了麻烦。经过更多的挖掘和实验后，我得以使其工作。我在回答中指出，
Doxygen在使用 \dir 命令记录目录时所使用的路径相当宽容或灵活，但在使用该路径时相当挑剔用 \ref 命令引用它。

This works to provide documentation of the directory. In my original question, I was having trouble using \ref to link to the directory documentation. After more digging and experimenting I was able to get it to work. I commented in my answer that Doxygen is pretty forgiving or flexible with the path used when documenting a directory with the \dir command, but it is rather picky when referencing it with the \ref command.

这篇关于如何在Doxygen中提供目录描述的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！