doxygenドキュメントを書くには？ [閉鎖]

まずdoxygenをインストールします（あなたのOSディストリビューションにパッケージがあるでしょう）。次に、ソースツリーの最上位ディレクトリで次を実行します。

doxywizard Doxyfile

これは基本的にdoxygenを進めるための一連の命令であるDoxyfileを生成する簡単な方法を提供します。私はサブディレクトリに出力するように設定したいと思いますdoc/html。

次に、ソースコードにdoxygenコメントを追加します。次のようにファイルの上部にコメントを付ける必要があります。

//! \file myfile.h This is my header file

次に、個々のシンボルに次のようにコメントを付けます。

//! This is my function:
void function();

以下に記載されている他の構文があります。 http://www.doxygen.nl/manual/docblocks.html#specialblock

次に、次を実行します。

doxygen

文書が生成されます。 Webブラウザを起動します。

ああ、そしてソースコードなしでドキュメントファイルが欲しいなら問題ありません。 FILE_PATTERNSにあること.mdを確認するためにdoxygenを設定できます。*.mdUSE_MDFILE_AS_MAINPAGE を Markdown ファイルに設定して、Markdown でホームページを作成することもできます。これらの手順はDoxyfileにありますが、ウィザードで編集することもできます。