Doxygenにサンプルを統合するには？

Question

私はすべてのクラスを文書化しましたが、今はこれらのクラスの使い方の例を統合したいと思います。それ、どうやったら出来るの？

Answer 1

doxygen設定で定義されている特別なパスにサンプルコードEXAMPLE_PATHを入れて、@exampleタグを付けてサンプルを挿入することができます。

Doxygenは、例のソースを含む余分なページを生成します。また、サンプルタグを含むクラスのドキュメントからリンクを設定します。また

あなたは小さなコードスニペットを使用したい場合は、このためのドキュメントはここにある@code ... @endcode

でそれらを挿入することができます。 Doxygen documentation？

Answer 2

サンプルファイルをドキュメントに含めるために、@exampleを使用していくつかのエラーがありました。これは私が使用した回避策です。

examplefile.csを、具体的にはコード例のフォルダ/プロジェクトに配置します。 DoxygenのEXCLUDEリスト内のフォルダ プレイス（Expert->入力 - > EXCLUDEin DoxygenのGUIフロントエンド）とEXAMPLE_PATH（DoxygenのGUIフロントエンドでExpert->入力 - > EXAMPLE_PATH）は、このコードブロックのどこか

代わりにに記載ファイル（私は例があるため、ファイルにそれを置く。）

/** @example examplefile.cs 
* A description of the example file, causes the example file to show up in 
* Examples */ 

これは、ファイルはDoxygenのメニューの例の下に現れるようになりますが、プロジェクト内のクラス/ファイルとして表示されませ。

次に、あなたのクラス/機能を文書化：

/** @brief MyClass does something 
* @details I have something more long winded to say about it. See example 
* in examplefile.cs: @include examplefile.cs */ 

これは、MyClassののドキュメントで、それの全体をプリントアウトするサンプルファイルの原因となります。

Answer 3

1. 言語（INPUT = example_list.h \

Doxyfileというのと同じファイルなどexample_list.h 内のすべての例を接続し、それを含めることができ EXAMPLE_PATH = dir_example \

をDoxyfileという方法を追加 - ロシア語） http://www.scale-tech.ru/SimBookmaker/doc/html/examples__list_8h_source.html および http://www.scale-tech.ru/SimBookmaker/doc/html/examples.html

Answer 4

もう1つの方法は、\snippetコマンドを使用することです。 TestClassをで

\section ex1 Example 
\snippet path_to_test_class/TestClass.cpp TestClass example 
\section ex2 Expected output 
\snippet path_to_test_class/TestClass.cpp TestClass expected output 

• ：あなたのヘッダファイルで
  • は次のように書きます。cppのファイル、のようなものがあります：

  //! [OptimizeSpeedOnTrackTest example] 
  Class c; 
  const double res = c.do_something(); 
  //! [OptimizeSpeedOnTrackTest example] 
  //! [OptimizeSpeedOnTrackTest expected output] 
  ASSERT_DOUBLE_EQ(5,res); 
  //! [OptimizeSpeedOnTrackTest expected output] 
  

  path_to_test_classはあなたのEXAMPLE_PATHでなければなりません。

  これはあなたに次を与える：

  • あなたの例では、ドキュメントのためだけに存在しません：彼らは同様にテストカバレッジを提供
  • あなたのテストランナー（&コンパイラが）あなたにそのあなたの例の保険を与えます実際&実行
  • をコンパイルそれは私がそれをしたが、余分なページ内の.cpp-ファイルは全角ですはいTDDワークフローでかなりきれいに