JavaScript is disabled on your browser.
JavaScript is disabled on your browser.
Detail:
Field |
Constr |
Method
Enclosing interface:
Doclet
public static interface Doclet.Option
An encapsulation of option name, aliases, parameters and descriptions
as used by the Doclet.
Nested Class Summary
Nested Classes
Modifier and Type
Interface
Description
static class
Doclet.Option.Kind
The kind of an option.
Method Detail
getDescription
String getDescription()
Returns the description of the option. For instance, the option "group", would
return the synopsis of the option such as, "groups the documents".
Returns:
description if set, otherwise an empty String
getNames
List <String > getNames()
Returns the list of names that may be used to identify the option. For instance, the
list could be ["-classpath", "--class-path"]
for the
option "-classpath", with an alias "--class-path".
Returns:
the names of the option
process
boolean process(String option,
List <String > arguments)
Processes the option and arguments as needed. This method will
be invoked if the given option name matches the option.
Parameters:
option
- the option
arguments
- a list encapsulating the arguments
Returns:
true if operation succeeded, false otherwise
JavaScript is disabled on your browser.
Detail:
Field |
Constr |
Method
Report a bug or suggest an enhancement For further API reference and developer documentation see the Java SE Documentation , which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries. Copyright © 1993, 2018, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA. All rights reserved. Use is subject to license terms and the documentation redistribution policy .
Scripting on this page tracks web page traffic, but does not change the content in any way.