パッケージ org.opengion.fukurou.taglet

# クラス 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,

- ## ネストされたクラスの概要

  ## クラスから継承されたネストされたクラス/インタフェース org.opengion.fukurou.taglet.AbstractDocTree

  `AbstractDocTree.AbstractOption`

  ## インタフェースから継承されたネストされたクラス/インタフェース jdk.javadoc.doclet.Doclet

  `Doclet.Option`

- ## フィールドの概要

  ### クラスから継承されたフィールド org.opengion.fukurou.taglet.AbstractDocTree

  `EMPTY_LIST, ENCODE, reporter`

- ## コンストラクタの概要

  コンストラクタ
  コンストラクタ
  説明
  `DocTreeVerCheck()`
  デフォルトコンストラクター

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `Set<? extends Doclet.Option>`
  `getSupportedOptions()`
  サポートされているすべてのオプションを返します。
  `boolean`
  `run(DocletEnvironment docEnv)`
  Doclet のエントリポイントメソッドです(昔の startメソッド)。

  ### クラスから継承されたメソッド org.opengion.fukurou.taglet.AbstractDocTree

  `blockTagsMap, getBlockTag, getName, getSupportedSourceVersion, getTitleCmnt, init`

  ### クラスから継承されたメソッド java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## コンストラクタの詳細

  - ### 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()
    サポートされているすべてのオプションを返します。
    戻り値:
      サポートされているすべてのオプションを含むセット、存在しない場合は空のセット