lablab.jp （日本語版）

私はこのブログを昨晩アップデートできませんでした。さて、いよいよ私達はDoxygen によってXOOPS Cube のソースコードからドキュメントを生成します。

Doxygen は Doxywizard という名前の GUI アプリケーションを備えています:

それはDoxygen のためのコンフィギュレーション・ファイルを生成し、そのコンフィギュレーション・ファイルによってDoxygen を実行します。さらに、Doxywizard にはウィザードとエキスパートという、初級者と上級者のための、２つのセッティング方法があります。PHP プログラムはほとんど高度な設定を必要としないので、ウィザードモードの使用法だけを覚えればよいでしょう。


Doxywizard を実行し、それから、 Wizard ボタンを押します。


あなたがダウンロードした XOOPS Cube のディレクトリを 'Source code directory' にセットしなさい。そして、サブディレクトリを解析するために、 'Scan recursively' オプションをチェックしてください。それからドキュメントを収納するディレクトリを作成し、それを 'Destination directory' にセットしてください。 'Project name' と 'Project version or ID' は自由です。


次に、 Mode タブをクリックしてください。


'All entities' を選択してください。それにより、すべてのエンティティが、それがドキュメントシステムのためのコメントを持っているかどうかに関係なく、ドキュメントのために解析されます。それから、 OK ボタンを押してダイアログを閉じてください。


次に、このセッティングをファイルに保存しなければなりません。Doxywizard は Doxygen を実行させるためにコンフィグレーションファイルを必要とするためです。Doxywizard はあなたが保存したファイルを Doxygen のためのコンフィグレーションファイルとして用います。


次に、 Doxygen がドキュメントを生成するためのテンポラリファイルを作成するディレクトリを指定しなければなりません。あなたの OS のテンポラリ・ディレクトリか、新しいディレクトリを作ってそれを指定するとよいでしょう。

あなたはこれでドキュメント生成のための最低限のセッティングを終えました。最後に、 'Start' ボタンをクリックしてください。ドキュメントがあなたが指定した転送先ディレクトリに生成されるでしょう。

あなたは再度これらのセッティングを行う必要はありません。いつでもコンフィグレーションファイルをロードし、ドキュメントを生成できます。