Skip to content

Commit b88dd5f

Browse files
committed
[CLI-303] Doc: "Usage Scenarios" refers to deprecated methods
1 parent e8e4efa commit b88dd5f

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

src/changes/changes.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,9 @@
5858
<action dev="ggregory" type="fix" due-to="Gary Gregory" issue="CLI-283">
5959
CommandLine.addArgs(String) should not allow a null String.
6060
</action>
61+
<action dev="ggregory" type="fix" due-to="Gary Gregory" issue="CLI-303">
62+
Site docs: "Usage Scenarios" refers to deprecated methods.
63+
</action>
6164
<!-- ADD -->
6265
<action type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">
6366
Add github/codeql-action.

src/site/xdoc/usage.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -180,32 +180,32 @@ Option emacs = new Option("emacs",
180180
<p>
181181
The argument options are created using the <code>Option#Builder</code>.
182182
</p>
183-
<source>Option logfile = Option.builder("logfile")
183+
<source>Option logFile = Option.builder("logfile")
184184
.argName("file")
185185
.hasArg()
186186
.desc("use given file for log")
187187
.build();
188188

189-
Option logger = Option.builder("logger")
189+
Option logger = Option.builder("logger")
190190
.argName("classname")
191191
.hasArg()
192192
.desc("the class which it to perform logging")
193193
.build();
194194

195-
Option listener = Option.builder("listener")
195+
Option listener = Option.builder("listener")
196196
.argName("classname")
197197
.hasArg()
198198
.desc("add an instance of class as "
199199
+ "a project listener")
200200
.build();
201201

202-
Option buildfile = Option.builder("buildfile")
202+
Option buildFile = Option.builder("buildfile")
203203
.argName("file")
204204
.hasArg()
205205
.desc("use given buildfile")
206206
.build();
207207

208-
Option find = Option.builde("find")
208+
Option find = Option.builde("find")
209209
.argName("file")
210210
.hasArg()
211211
.desc("search for buildfile towards the "
@@ -215,7 +215,7 @@ Option find = Option.builde("find")
215215
<subsection name="Defining Java Property Option">
216216
<p>
217217
The last option to create is the Java property and it is also created
218-
using the OptionBuilder.
218+
using the Option class' Builder.
219219
</p>
220220
<source>Option property = Option property = Option.builder("D")
221221
.hasArgs()
@@ -282,7 +282,7 @@ options.addOption(property);</source>
282282
the <code>getOptionValue</code> method.
283283
</p>
284284
<source>// has the buildfile argument been passed?
285-
if(line.hasOption("buildfile")) {
285+
if (line.hasOption("buildfile")) {
286286
// initialise the member variable
287287
this.buildfile = line.getOptionValue("buildfile");
288288
}</source>

0 commit comments

Comments
 (0)