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です。