latest release v1.5.9 - last update 14 Feb 2011 |
はじめよう実行ファイル 実行ファイル オプションとして、実行ファイル 以下の図は、ツール間の関係およびそれらの間の情報の流れを示します (複雑なように見えますが、完全を目指しているからに過ぎません): Doxygen information flow ステップ 1: 設定ファイルを生成するdoxygen は、設定ファイルを使用して、すべての設定を決定します。 各プロジェクトは、それぞれに設定ファイルが必要です。 プロジェクトは、単一のソースファイルだけでも構成できますが、 再帰的にスキャンできる完全なソースツリーでもあります。 設定ファイルの作成を単純化するために、 doxygen に設定ファイルのテンプレートを作成させることもできます。 これには、コマンドラインから doxygen -g <config-file> ここで <config-file> は設定ファイルの名前です。 ファイル名が省略された場合は、 設定ファイルのフォーマットは、(単純な) Makefile のフォーマットに類似しています。それは、次のような、いくつかの代入文(タグ)からなります:
生成された設定ファイルのほとんどのタグは、デフォルトの値のままにしておくことができます。 設定ファイルについての詳細については、セクション 設定 を参照してください。 テキストエディタを使って設定ファイルを編集したくない場合は、doxywizard を参照してください。 このGUIフロントエンドでは、doxygen の設定ファイルの生成、読み込み、書き込みができ、ダイアログでオプションを設定できます。 少しの C/C++ ソースとヘッダーファイルからなる小さなプロジェクトでは、 INPUT タグは空のままにできます。この場合 doxygen はカレントディレクトリのソースを検索します。 ソースディレクトリまたはツリーからなる大きいプロジェクトの場合、 ルートディレクトリまたは複数ディレクトリを INPUT タグに指定し、1つ以上のファイルパターンを FILE_PATTERNS タグに追加します(例えば EXCLUDE_PATTERNS = */test/* doxygenは、ファイルの拡張子を見て解析方法を決めます。 もし既存の (従って doxygen がわかるドキュメントは一切付いていない) プロジェクトに対して doxygen を使い始めた場合でも、その構造や、ドキュメント化の結果についてその意味を理解できます。 それには、設定ファイルで、EXTRACT_ALL タグを EXTRACT_ALL が 既存のソフトウェア作品を解析するに当たっては、ソースファイル中での、(ドキュメント付けられている) 実体とその定義とのクロスリファレンスを取ることが役に立ちます。 SOURCE_BROWSER を ステップ 2: doxygen を実行するドキュメントを生成するには、次のように入力します。 doxygen <config-file> 設定しだいで、出力ディレクトリの中に、 デフォルトの出力先ディレクトリは、 HTML 出力 生成された HTML ドキュメントを見るには、HTML ブラウザで HTML セクションのいくつかの機能 (GENERATE_TREEVIEW など) は、DHTML と Javascript をサポートするブラウザを必要とします。 検索エンジン (SEARCHENGINE を参照) を使う計画があるなら、PHP 対応のウェブサーバー (例えばapache、PHPモジュールインストール済み) を介してHTML 出力を見てください。 LaTeX 出力 生成された ドキュメントは、まず コンパイラ (作者は最新の teTeX ディストリビューションを使います) を使ってコンパイルする必要があります。 生成されたドキュメントをコンパイルする手順を簡素化するために、
一枚のページに 2ページ分を表示させるには、代わりに、 ghostscript インタプリタをインストールしてあれば、PDF への変換も可能です。 PDF 出力を最良形で見るには、 PDF_HYPERLINKS タグと USE_PDFLATEX タグを RTF 出力doxygenは、RTF 出力を、refman.rtf と呼ばれる単一のファイルに合成します。 このファイルは Microsoft Word にインポートできるように最適化されています。 フィールドを使ってエンコードされる情報があります。 実際の値を表示するには、すべて選択 (編集 - すべて選択) してから、フィールド更新 (右クリックしてドロップダウン・メニューからオプションを選びます) してください。 XML 出力XML 出力は、Doxygenが集めた情報の塊で、それを構造化したものです。 クラス、名前空間、ファイルなど各要素にXML ファイルがあり、index.xml と呼ばれるインデックス・ファイルがあります。 combine.xsltというXSLT スクリプトファイルも生成されるので、XML ファイルを単一のファイルに合成できます。 Doxygen は、2つの XML スキーマファイル、index.xml用のindex.xsd と要素用のcompound.xsd を生成します 。 このスキーマファイルには、含まれる要素とそれらの属性、および構造を記述されます。 すなわち、XMLファイルの文法が記述されているので、確認したり、XSLTスクリプトの操作に使うことができます。 addon/doxmlparser ディレクトリにはパーサーライブラリがあり、XML出力を漸進的に読むために使えます。(ライブラリのインタフェースを知るには、addon/doxmlparser/include/doxmlintf.h を参照してください) Man ページ出力生成された man ページは、 ステップ 3: ソースのドキュメント付けソースにドキュメントを付けることをステップ 3 として提示していますが、新しいプロジェクトでは、もちろんステップ 1 でやるべきことです。 ここでは、コードはすでに記述されていて、その API 及び内部についてドキュメントを生成したいという状況を想定して、話を進めます。 設定ファイルで、EXTRACT_ALL オプションが
ファイルの前にドキュメント・ブロックを置く方法はないので、2番目のオプションしか使えません。 もちろん、ファイルメンバー(関数、変数、typedef、define) には明示的な構造化コマンドは必要ありません。特殊ドキュメント・ブロックをその前後に入れます。 特殊ドキュメントブロック内のテキストは、解析されてから、HTML や のファイルに書き出されます。 解析 (parsing) では、次のステップが実行されます:
|
|
This page was last modified on 14 Feb 2011.
© 1997-2010 Dimitri van Heesch, first release 27 oct 1997.
© 2001 OKA Toshiyuki (Japanese translation). © 2006-2011 TSUJI Takahiro (Japanese translation). © 2006-2011 TAKAGI Nobuhisa (Japanese translation). |