org.opengion.fukurou.taglet
クラス DocletSpecific
java.lang.Object
org.opengion.fukurou.taglet.DocletSpecific
public final class DocletSpecific
- extends Object
ソースコメントから、タグ情報を取り出す Doclet クラスです。
クラスファイルの仕様を表現する為、og.formSample , og.rev , og.group ,
version , author , since の各タグコメントより値を抽出します。
また、各クラスの継承関係、インターフェース、メソッドなども抽出します。
これらの抽出結果をDB化し、EXCELファイルに帳票出力する事で、クラスファイルの
ソースから仕様書を逆作成します。
- バージョン
- 4.0
- 作成者
- Kazuhiko Hasegawa
- 導入されたバージョン:
- JDK5.0,
メソッドの概要 |
static int |
optionLength(String option)
カスタムオプションを使用するドックレットの必須メソッド optionLength(String) です。 |
static boolean |
start(com.sun.javadoc.RootDoc root)
Doclet のエントリポイントメソッドです。 |
クラス java.lang.Object から継承されたメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
start
public static boolean start(com.sun.javadoc.RootDoc root)
- Doclet のエントリポイントメソッドです。
- パラメータ:
root
- エントリポイントのRootDocオブジェクト
- 戻り値:
- 正常実行時 true
- 変更履歴:
5.5.4.1 (2012/07/06) Tag出力時の CR → BR 変換を行わない様にする。 |
5.7.1.1 (2013/12/13) タグのインデントを止める。 |
optionLength
public static int optionLength(String option)
- カスタムオプションを使用するドックレットの必須メソッド optionLength(String) です。
ドックレットに認識させる各カスタムオプションに、 optionLength がその
オプションを構成する要素 (トークン) の数を返さなければなりません。
このカスタムオプションでは、 -tag オプションそのものと
その値の 2 つの要素で構成されるので、作成するドックレットの
optionLengthメソッドは、 -tag オプションに対して 2 を返さなくては
なりません。また、認識できないオプションに対しては、0 を返します。
- パラメータ:
option
- オプション文字列
- 戻り値:
- 要素(トークン) の数
Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.