2016-03-30 9 views
0

Doxygenの初心者です。 Imは現在、Code Composer Studioを使用して書いているCコードをDoxygenを使って文書化しようとしています。DoxygenとCode Composer Studioの統合

私はそれらのコマンドを少し読んで、Doxygenが.htmlファイルを生成する方法を知ることができました。 コード全体を.htmlファイルにも追加できますか?例えば同様

、私はこのような機能を持っている場合:生成された.htmlのファイルで

/** 
* \file main.c 
* \brief This is brief. 

This is detailed. 
* 
* @author Akshay 
* @param[in] a: Just a test variable 
* @date 7/2/2016 
*/ 

int test(int a) 
{ 
    a=1; /**< load default value of var a as 1 */ 
    a++; /**< increment a*/ 
} 

が、それは同様に(機能テスト()のために)全体のコードを含むことが可能ですか?上の作業プロジェクトイム...など、すべての変数、関数、コードの修正以下の二つの設定オプションについては、ドキュメント内

+0

リンクは* source *コードではなく、* example *コードを表示します。 ['\ example'](http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdexample)をご覧ください。 – Biffen

+0

私は自分のコードがそのような.htmlファイルに表示されるべきだと言いたかったのです。ソースコードを追加する方法はありませんか?サンプルコードのみを追加できますか? –

+0

方法があります:あなたが望むものに応じて、 'SOURCE_BROWSER'、' INLINE_SOURCES'と 'VERBATIM_HEADERS'の組み合わせを使ってソースを含めるようにDoxygenを設定することができます。ただし、Doxygenは通常、*開発者*ではなく*(APIの)*ユーザーのドキュメントを作成するために使用されます。 – Biffen

答えて

0

ルックを追跡するためには複雑すぎるので、私はそれがthisに似た何かをしたい

SOURCE_BROWSER 
INLINE_SOURCES 

インラインソースは、提供されたリンクで必要な機能を実行するものです。

+0

ありがとう。それを見る –

関連する問題