如何在 Doxygen 中给出目录的描述
How to give description for directory in Doxygen
我正在使用 Doxygen 来记录我的项目。我知道,通过使用下面的 Doxygen 命令,我们可以给出源文件的描述。
/**
* \file example.cpp
* \brief Implementation of example functions
*/
有什么方法可以在 Doxygen 中描述 directory/folder 吗?
使用我展示的\dir
doxygen command. I asked a similar question
/// \dir cpp/vtutil
///
/// \brief Brief description of the dir cpp/vtutil goes here
///
/// \details A more detailed description goes here.
这可以提供目录的文档。在我原来的问题中,我在使用 \ref
到 link 到目录文档时遇到了问题。经过更多的挖掘和试验,我能够让它发挥作用。我在回答中评论说
Doxygen 对使用 \dir
命令记录目录时使用的路径非常宽容或灵活,但在使用 \ref
命令引用它时却相当挑剔。
我正在使用 Doxygen 来记录我的项目。我知道,通过使用下面的 Doxygen 命令,我们可以给出源文件的描述。
/**
* \file example.cpp
* \brief Implementation of example functions
*/
有什么方法可以在 Doxygen 中描述 directory/folder 吗?
使用我展示的\dir
doxygen command. I asked a similar question
/// \dir cpp/vtutil
///
/// \brief Brief description of the dir cpp/vtutil goes here
///
/// \details A more detailed description goes here.
这可以提供目录的文档。在我原来的问题中,我在使用 \ref
到 link 到目录文档时遇到了问题。经过更多的挖掘和试验,我能够让它发挥作用。我在回答中评论说
Doxygen 对使用 \dir
命令记录目录时使用的路径非常宽容或灵活,但在使用 \ref
命令引用它时却相当挑剔。