-
- Enclosing interface:
- Doclet
public static interface Doclet.Option
Doclet使用的选项名称,别名,参数和描述的封装。
-
-
Nested Class Summary
Nested Classes Modifier and Type 接口 描述 static class
Doclet.Option.Kind
这种选择。
-
方法摘要
所有方法 接口方法 抽象方法 Modifier and Type 方法 描述 int
getArgumentCount()
返回参数数,该选项将消耗。String
getDescription()
返回该选项的描述。Doclet.Option.Kind
getKind()
返回选项种类。List<String>
getNames()
返回可用于标识该选项的名称列表。String
getParameters()
返回该选项的参数。boolean
process(String option, List<String> arguments)
根据需要处理选项和参数。
-
-
-
方法详细信息
-
getArgumentCount
int getArgumentCount()
返回参数数,该选项将消耗。- 结果
- 消耗的参数数
-
getDescription
String getDescription()
返回该选项的描述。 例如,选项“group”将返回选项的概要,例如“分组文档”。- 结果
- 描述如果设置,否则为空字符串
-
getKind
Doclet.Option.Kind getKind()
返回选项种类。- 结果
- 这种选择的种类
-
getNames
List<String> getNames()
返回可用于标识该选项的名称列表。 例如,对于“-classpath”选项,列表可以是["-classpath", "--class-path"]
,别名为“--class-path”。- 结果
- 该选项的名称
-
getParameters
String getParameters()
返回该选项的参数。 例如“name <p1>:<p2> ..”- 结果
- 参数如果设置,否则为空字符串
-
-