File tree Expand file tree Collapse file tree 1 file changed +21
-0
lines changed
src/main/java/com/github/markusbernhardt/xmldoclet Expand file tree Collapse file tree 1 file changed +21
-0
lines changed Original file line number Diff line number Diff line change 11
11
* @author Manoel Campos
12
12
*/
13
13
public class CustomOption implements Doclet .Option {
14
+ /**
15
+ * The number of arguments this option will consume,
16
+ * which is the number of expected {@link #parameters}.
17
+ */
14
18
private final int argumentCount ;
15
19
private final String description ;
16
20
private final List <String > names ;
21
+
22
+ /**
23
+ * A user-friendly string description of the option's parameters, or the empty string if this option has no parameters.
24
+ * This is used to generate the help message for the option.
25
+ * If the option expectes a file name as parameter, the description may include the word "file"
26
+ * to indicate that.
27
+ *
28
+ * <p>If the option has multiple parameters, this attribute should provide
29
+ * a string representation of all of them, such as: file1 file2</p>
30
+ */
17
31
private final String parameters ;
18
32
19
33
/**
@@ -73,6 +87,13 @@ public String[] getParameterArray() {
73
87
return parameters .split (" " );
74
88
}
75
89
90
+ /**
91
+ * {@inheritDoc}
92
+ * It must check if the given option arguments are valid.
93
+ * @param option {@inheritDoc}
94
+ * @param arguments {@inheritDoc} received during the doclet execution
95
+ * @return if the option has the expected number of arguments and they are valid
96
+ */
76
97
@ Override
77
98
public boolean process (final String option , final List <String > arguments ) {
78
99
throw new UnsupportedOperationException ("Not supported yet." );
You can’t perform that action at this time.
0 commit comments