2016-05-18 30 views
1

我正在與Doxygen合作來記錄我的項目。我知道,通過使用下面的Doxygen命令,我們可以給出源文件的描述。如何在Doxygen中提供目錄描述

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

有沒有什麼辦法給Doxygen中的目錄/文件夾的描述?

+0

Dd你可以看看關於「特殊命令」的手冊章節,特別是關於\ dir的段落嗎? – albert

+0

抱歉,剛纔我在Doxygen特殊命令中看到了「\ dir」的定義......現在我可以給出目錄的描述了......謝謝你@albert – sivakarthik

+0

是的,藉助Doxygen \ dir命令,我們可以提供目錄的說明... – sivakarthik

回答

0

使用\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鏈接到目錄文檔。經過更多的挖掘和試驗後,我能夠得到它的工作。我在我的回答中評論道:012xyDoxygen對使用\dir命令記錄目錄時使用的路徑非常寬容或靈活,但在使用\ref命令引用目錄時,它是相當挑剔的。

相關問題