Powered by SmartDoc

7 Javadoc 用ドックレットの使用方法

このStar SHOWには、Javadocツールによるドキュメントから、ソースへのリンクを設けられるようにSHOWドックレットを付属しています。このドックレットを使用すると、各クラスドキュメントの関連項目の下に、Sourceの項が追加され、SHOWにより生成されたHTMLへのリンクが作成されます。生成されるソースのHTMLは、各クラスドキュメントと同じディレクトリに、source_filename.htmlという名前で生成されます。

なお、このドックレットを使用する場合、通常のSHOWのHTML生成で設定できるオプション(行番号、カスタマイザなど)は現在のところ指定できるようにはなっていません。これは次のバージョン以降で対応する予定です。

7.1 使用方法

以下は付属する起動スクリプトあるいはバッチファイルを使用することによるドックレットの使用方法です。

7.1.1 Windows 系

SHOWドックレットを使用するように通常のjavadocツールに対するオプションをセットしたバッチファイルがINST_DIRにshowdoc.batという名前で含まれます。この引数に、通常javadocを使用するときと同様に、オプションをセットすれば使用できます。すなわち、これまでjavadoc [OPTIONS]のように実行していたものをshowdoc.bat [OPTIONS]とタイプすることで使用可能です。なお、バッチファイルは、INST_DIRにおいて使用することが前提となった内容です。インストール先に応じて、バッチファイルの-docletpathの引数lib\sshowdlt.jarの部分をINST_DIR\lib\sshowdlt.jarに変更してください。また、このバッチファイルを使用し、オプションを与える場合、引数の数が9個に制限されますので注意してください。

7.1.2 Unix 系

SHOWドックレットを使用するように通常のjavadocツールに対するオプションをセットしたスクリプトがINST_DIRにshowdoc.shという名前で含まれます。この引数に、通常javadocを使用するときと同様に、オプションをセットすれば使用できます。すなわち、これまでjavadoc [OPTIONS]のように実行していたものをshowdoc.sh [OPTIONS]とタイプすることで使用可能です。なお、スクリプトは、INST_DIRにおいて使用することが前提となった内容です。インストール先に応じて、スクリプトの-docletpathの引数lib/sshowdlt.jarの部分をINST_DIR/lib/sshowdlt.jarに変更してください。