クラス DocTreeParam

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

public class DocTreeParam extends AbstractDocTree
ソースコメントから、パラメータ情報を取り出す Doclet クラスです。 og.paramLevel タグと og.cryptography タグを切り出します。 これらは、システムパラメータとしてGE12テーブルに設定される値をクラスより抽出する のに使用します。
導入されたバージョン:
JDK11.0,
  • コンストラクタの詳細

    • DocTreeParam

      public DocTreeParam()
      デフォルトコンストラクター
      変更履歴:
      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メソッド)。
      定義:
      run インタフェース内 Doclet
      オーバーライド:
      run クラス内 AbstractDocTree
      パラメータ:
      docEnv - ドックレットを1回呼び出す操作環境
      戻り値:
      正常実行時 true
      変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応
    • writeContents

      protected void writeContents(DocletEnvironment docEnv, DocTreeWriter writer)
      DocletEnvironmentよりコンテンツを作成します。
      定義:
      writeContents クラス内 AbstractDocTree
      パラメータ:
      docEnv - ドックレットの最上位
      writer - DocTreeWriterオブジェクト
      変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応, 8.0.1.0 (2021/10/29) titleを改行か『。』までの文字列を切り出す。, 8.0.2.1 (2021/12/10) コメント分割で『。』と半角の『。』の両方対応しておく。, 8.5.6.1 (2024/03/29) SystemData.java,BuildNumber.javaでseqが重複になるので、修正
    • getSupportedOptions

      public Set<? extends Doclet.Option> getSupportedOptions()
      サポートされているすべてのオプションを返します。
      定義:
      getSupportedOptions インタフェース内 Doclet
      オーバーライド:
      getSupportedOptions クラス内 AbstractDocTree
      戻り値:
      サポートされているすべてのオプションを含むセット、存在しない場合は空のセット