UnrealScriptからのドキュメント生成

概要

UDKに含まれるUnrealScript中にはJavadocライクなフォーマットでドキュメントが記述されています。
このページではUnrealScriptからHTML形式のドキュメントを生成する方法を解説します。

以下のリンクで生成済みのドキュメントが閲覧できます。
http://www.codekisk.com/unreal/ut3/scriptref/
しかし、

• 上記のリンクは内容が古い。パフォーマンスに影響が少ないnative関数はUnrealScriptに書き戻されている
• 自作のUnrealScriptに関しても、ドキュメントの生成が可能となる

といった点から、ドキュメント生成は有用であると考えています。

必要なもの

• UnCodeX(237-beta)

http://sourceforge.net/projects/uncodex/files/から入手できます。UnCodeXはUnrealScriptの解析などを行うツールです。

生成手順

• ダウンロードしたUnCodeXを起動する
• 初期設定をするか聞いてくるのでYesをクリック

• "Source Paths"で"Add"ボタンをクリックし、"(UDKのルートディレクトリ\Development\Src"を選択、最後に"OK"ボタンをクリックする

• 先ほど設定したパス内のUnrealScriptを解析するか聞いてくるのでYesをクリック

• UnCodeXが起動し、同時に解析が始まる。進捗はウィンドウ下部のプログレスバーから判断できる。いくつかエラーが出るが問題ない
• メニューバーの"HTML Output"->"Create all files"でドキュメントの生成が始まる

#ref error ：ご指定のファイルが見つかりません。ファイル名を確認して、再度指定してください。 (UnCodeX.png)

• UnCodeXのディレクトリに"UnCodeX-Output"という名前のディレクトリが作成されており、その直下の"index.html"がドキュメントのインデクスとなる。