クラス DocTreeVerCheck

java.lang.Object
org.opengion.fukurou.taglet.AbstractDocTree
org.opengion.fukurou.taglet.DocTreeVerCheck
すべての実装されたインタフェース:
Doclet

public class DocTreeVerCheck extends AbstractDocTree
ソースコメントから、タグ情報を取り出す Doclet クラスです。 パラメータの version に一致する og.rev タグの 書かれたメソッドを、 ピックアップします。 og.rev タグ で、まとめて表示します。 ルールとしては、X.X.X.X だけが引数で渡されますので、 X.X.X.X (YYYY/MM/DD) が コメントとして記載されているとして、処理します。 そして、それ以降の記述の、「。」までを、キーワードとして、まとめます。 キーワード以下は、それぞれのコメントとして、各メソッドの直前に表示します。 このクラスは、RELEASE-NOTES.txt を作成する場合に、変更箇所をピックアップするのに使用します。
導入されたバージョン:
JDK11.0,
  • コンストラクタの詳細

    • DocTreeVerCheck

      public DocTreeVerCheck()
      デフォルトコンストラクター
      変更履歴:
      7.3.0.0 (2021/01/06) PMD refactoring. Each class should declare at least one constructor.
  • メソッドの詳細

    • run

      public boolean run(DocletEnvironment docEnv)
      Doclet のエントリポイントメソッドです(昔の startメソッド)。
      パラメータ:
      docEnv - ドックレットを1回呼び出す操作環境
      戻り値:
      正常実行時 true
      変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応
    • getSupportedOptions

      public Set<? extends Doclet.Option> getSupportedOptions()
      サポートされているすべてのオプションを返します。
      戻り値:
      サポートされているすべてのオプションを含むセット、存在しない場合は空のセット