2016-05-18 1 views
1

私はプロジェクトを文書化するためにDoxygenと協力しています。私は、以下のDoxygenコマンドを使って、ソースファイルの説明を与えることができます。Doxygenのディレクトリの説明を与える方法

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

Doxygenのディレクトリ/フォルダの説明はありますか?

+0

Dd「特別なコマンド」に関するマニュアルの章、特に\ dirに関する段落を見ていますか? – albert

+0

申し訳ありません、私はDoxygenの特別なコマンドで "\ dir"の定義を見ました...今、私はディレクトリの説明を与えることができます... u @アルベルトに感謝 – sivakarthik

+0

はい、Doxygen \ dirコマンドの助けを借りてディレクトリの説明を提供する... – sivakarthik

答えて

0

\dir doxygenコマンドを使用してください。私は、これはディレクトリの文書を提供するために働く

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

を示している同様の質問how to link to documentation of directoryを尋ねました。私の元々の質問では、\refを使ってディレクトリのドキュメントにリンクするのに問題がありました。より多くの掘削と実験の後、私はそれを働かせることができました。私は私の答えでは Doxygenは\dirコマンドでディレクトリを文書化するときに使用されるパスでかなり許容または柔軟であるが、それは\refコマンドでそれを参照するとかなりピカピカです。

関連する問題