2011-01-19 5 views
3

私のC++(Qt)プロジェクトのJavaScript APIを文書化するためにDoxygenを使用します。このアイデアは、JavaScriptインターフェイス用の特定のドキュメンテーションと、いつものC++クラス用のドキュメントを書くことです。 一例(datasource.dox)は次のようになります。JavaScript APIを文書化するためにDoxygenで関数ドキュメントを指定する

\addtogroup JavaScriptAPI 
@{ 
... 
\class DataSource 
\brief DataSource is the .... some doc goes here .... 

\section formats Supported formats 
.... 

\fn isOpen() 
\brief returns true if the data source is currently open... 
... 
@} 

生成されたヘルプには、素敵なw.r.t.に見えますクラス記述(または 'object'-description)が、関数のドキュメント(isOpen()、...)がありません。 Doxygenは次のような警告メッセージを作成します: 警告:文書化された関数 `bool isOpen 'は宣言されていないか、定義されていません。

質問:私は何とかdoxygenに\ fn-d関数の説明を強制することができますか? doxygenは私のためにすべてのそれらのメンバーのインデックスを作成した場合、それはここにリストされているJavaScriptを使用しました。doxygenを使用するための

答えて

関連する問題