クラス DocTreeParam
java.lang.Object
org.opengion.fukurou.taglet.AbstractDocTree
org.opengion.fukurou.taglet.DocTreeParam
- すべての実装されたインタフェース:
Doclet
ソースコメントから、パラメータ情報を取り出す Doclet クラスです。
og.paramLevel タグと og.cryptography タグを切り出します。
これらは、システムパラメータとしてGE12テーブルに設定される値をクラスより抽出する
のに使用します。
- 導入されたバージョン:
- JDK11.0,
-
ネストされたクラスの概要
クラスから継承されたネストされたクラス/インタフェース org.opengion.fukurou.taglet.AbstractDocTree
AbstractDocTree.AbstractOption
インタフェースから継承されたネストされたクラス/インタフェース jdk.javadoc.doclet.Doclet
Doclet.Option
-
フィールドの概要
クラスから継承されたフィールド org.opengion.fukurou.taglet.AbstractDocTree
EMPTY_LIST, ENCODE, reporter, version
-
コンストラクタの概要
コンストラクタ -
メソッドの概要
修飾子とタイプメソッド説明Set
<? extends Doclet.Option> サポートされているすべてのオプションを返します。boolean
run
(DocletEnvironment docEnv) Doclet のエントリポイントメソッドです(昔の startメソッド)。protected void
writeContents
(DocletEnvironment docEnv, DocTreeWriter writer) DocletEnvironmentよりコンテンツを作成します。クラスから継承されたメソッド org.opengion.fukurou.taglet.AbstractDocTree
blockTagsMap, getBlockTag, getName, getSupportedSourceVersion, getTitleCmnt, init
-
コンストラクタの詳細
-
DocTreeParam
public DocTreeParam()デフォルトコンストラクター- 変更履歴:
- 7.3.0.0 (2021/01/06) PMD refactoring. Each class should declare at least one constructor.
-
-
メソッドの詳細
-
run
Doclet のエントリポイントメソッドです(昔の startメソッド)。- 定義:
run
インタフェース内Doclet
- オーバーライド:
run
クラス内AbstractDocTree
- パラメータ:
docEnv
- ドックレットを1回呼び出す操作環境- 戻り値:
- 正常実行時 true
- 変更履歴:
- 7.3.0.0 (2021/01/06) 新しいJavaDoc対応
-
writeContents
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
サポートされているすべてのオプションを返します。- 定義:
getSupportedOptions
インタフェース内Doclet
- オーバーライド:
getSupportedOptions
クラス内AbstractDocTree
- 戻り値:
- サポートされているすべてのオプションを含むセット、存在しない場合は空のセット
-