Doxygen マニュアル
このマニュアルは 3つのパートに分かれています。 それぞれのパートは、さらにいくつかのセクションに分かれます。
パート 1 は、ユーザー・マニュアルです。
-
セクション インストール では、 ダウンロード、コンパイル、 インストールの方法を説明します。
-
セクション はじめよう では、最初のドキュメントを素早く生成する方法を説明します。
-
セクション コードのドキュメント付け では、コードにドキュメントを付けるための様々な方法を例示します。
-
セクション リスト では、リストを作成する様々な方法を示します。
-
セクション グループ化 では、グループ化の方法を示します。
-
セクション 式のインクルード では、ドキュメントに式を挿入する方法を示します。
-
セクション グラフと図 では、Doxygen で生成できる図とグラフを説明します。
-
セクション プリプロセス では、Doxygen ではマクロ定義をどのように扱うかを説明します。
-
セクション リンクの自動生成 では、 ファイルや、クラス、メンバーへのリンクをドキュメント内に挿入する方法を示します。
-
セクション 出力フォーマット Doxygenでサポートしている様々な出力形式を生成する方法を示します。
-
セクション カスタマイズ Doxygenが生成する出力のカスタマイズ方法を説明します。
-
セクション custcmd カスタムコマンドの定義と、コメントの中での使い方を説明します。
-
セクション 外部ドキュメントへのリンク では、外部で生成されたドキュメントへのリンクを作成する方法を説明します。
-
セクション よくある質問 では、質問の多い項目についての回答を列挙します。
-
セクション トラブルシューティング では、トラブルへの対処方法を伝えます。
パート 2 は、リファレンス・マニュアルです
-
セクション 特徴 では、Doxygenの能力をざっと示します。
-
セクション Doxygen の履歴 では、 Doxygen 開発中の変遷と今後の方針を示します。
-
セクション Doxygen の使い方 では、
Doxygen
プログラムの使い方を示します。
-
セクション Doxytag の使い方 では、
doxytag
プログラムの使い方を示します。
-
セクション Doxywizard の使い方 では、
doxywizard
プログラムの使い方を示します。
-
セクション Installdox の使い方 タグファイルを使用した場合に Doxygen が生成する
installdox
スクリプトの使い方を示します。
-
セクション 設定 では、ドキュメントを希望通り生成するための設定方法を示します。
-
セクション 特殊コマンド では、ドキュメント内で使用可能な特殊コマンドの概要を示します。
-
セクション HTML コマンド では、ドキュメント内で使用可能なHTMLコマンドの概要を示します。
-
セクション xmlcmds コマンド では、ドキュメント内で使用可能なC#スタイルのXMLコマンドの概要を示します。
パート3では、開発者のための情報を提供します