Doxygenの使用ドキュメントを生成します

背景

検索ではffmpegのドキュメントとドキュメントが生成されたDoxygenに基づいていることがわかりました。
学習を容易にするために、ここでは一例として、4.1文書をffmpegの生成します。

Doxygenの紹介

公式サイト:http://www.doxygen.nl/index.html

doxygenはプログラムは、このように文書を仕上げる時間プログラマを削減する、ドキュメントやAPIのリファレンスマニュアルにノートを変換することができ、ドキュメント生成ツールプログラムです。もちろん、このプログラムの注釈は、Doxygenの認識と変換を行うために、書き込みに一定のルールに従う必要があります。

Doxygenの現在のプログラミング言語は、C ++ / Cを備えるなどのJava、Objective-Cの、IDLを扱うことができ、文書形式HTML、XMLから作成することができ、LaTeXの、RTFは、加えて、HTMLなど他のフォーマット、たくさんの由来することができることができますCHM形式、PSやPDF文書を生成することができますLaTeXのツールにパッケージ化。

インストールと使用Doxygenの

次の例のWindwosをインストールして使用するには

インストールのリスト:

あなたがインストールすると、特別な設定を行います。

Doxygenの:ダウンロード、http://doxygen.nl/files/doxygen-1.8.17-setup.exe

HTMLヘルプ:マイクロソフト関係者は、HTML形式のヘルプファイルを生成するために使用されるダウンロード、http://go.microsoft.com/fwlink/p/?linkid=14188

Graphvizの:より良いグラフィックスを描画するために使用することができ、ドットのツールの一種、ダウンロード、https://graphviz.gitlab.io/_pages/Download/windows/graphviz-2.38.msi

Doxygenのベースの設定

doxygenは(GUI)ツールの種類のコマンドライン(CMDツール)ツールとインターフェースを有しています。Windowsで共通のインターフェイスの設定。

オープンDoxywizard(DoxygenのGUIがガラス張り)

実際の状況に基づいて、次の位置に入力し、[次へ]をクリックします。

モード設定モード

ではSelect the desired extraction mode
1. All Entities
2.マークInclude cross-referenced source code in the ouput

Select programing languge the optimize the results for :

対応する言語を選択するために、プロジェクトの実際のニーズによると、

選択してください。Optimize for C or PHP output

クリックしますnext

出力を設定しOputput

ではSelect the output format(s) to generate
1. HTML
2.選択:prepare for compressed HTML(.chm)

チェックを外し Latex

ここでは、ツールのLaTeX出力関連文書を使用するつもりはありません。

クリックしますnext

伝説設定ダイアグラム

Diagrams to generate
選択Use built-in class diagram generator
チェックインDot graphs to generateの下のすべてのアイテム

おすすめ

転載: www.cnblogs.com/schips/p/12199684.html