[#711] small fixes in Javadoc and user manual

remkop · Jun 1, 2019 · a8bc98b · a8bc98b
1 parent b077c98
commit a8bc98b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/docs/index.adoc b/docs/index.adoc
@@ -1732,7 +1732,7 @@ interface INegatableOptionTransformer {
  * for example {@code --force}, or {@code -XX:+<option>}
  * @param cmd the command that the option is part of
  * @return the documentation string for the negatable option,
- * for example {@code --[no-]force}, or {@code -XX:[+|-]<option>}
+ * for example {@code --[no-]force}, or {@code -XX:(+|-)<option>}
  */
  String makeSynopsis(String optionName, CommandSpec cmd);
 }
@@ -4070,8 +4070,9 @@ See the link:autocomplete.html[Autocomplete for Java Command Line Applications]
 
 The main `picocli-${version}.jar` is a JPMS module named `info.picocli`.
 
-Starting from picocli 4.0, this jar will be an explicit module instead of an https://openjdk.java.net/projects/jigsaw/spec/sotms/#automatic-modules[automatic module],
-so the `jlink` tool can be used to provide a trimmed binary image that has only the required modules.
+Starting from picocli 4.0, this jar will be an explicit module instead of an automatic module,
+so the https://docs.oracle.com/en/java/javase/12/tools/jlink.html[`jlink` tool] can be used to provide a trimmed binary image that has only the required modules.
+(Note that https://medium.com/azulsystems/using-jlink-to-build-java-runtimes-for-non-modular-applications-9568c5e70ef4[there are ways] to use jlink with non-modular applications.)
 
 Typically, a modular jar includes the `module-info.class` file in its root directory.
 This causes problems for some older tools, which incorrectly process the module descriptor as if it were a normal Java class.

diff --git a/src/main/java/picocli/CommandLine.java b/src/main/java/picocli/CommandLine.java
@@ -4284,7 +4284,7 @@ public interface INegatableOptionTransformer {
  * The returned value should be concise and clearly suggest that both the positive and the negative form are valid option names
  * @param optionName the option name to create a documentation string for, for example {@code --force}, or {@code -XX:+<option>}
  * @param cmd the command that the option is part of
- * @return the documentation string for the negatable option, for example {@code --[no-]force}, or {@code -XX:[+|-]<option>}
+ * @return the documentation string for the negatable option, for example {@code --[no-]force}, or {@code -XX:(+|-)<option>}
  */
  String makeSynopsis(String optionName, CommandSpec cmd);
  }
@@ -4332,13 +4332,13 @@ public static class RegexTransformer implements INegatableOptionTransformer {
  * <tr>
  * <td id="t01">^(-|--)(\w*:)\+(\w(-|\w)*)$</td>
  * <td id="t01">$1$2-$3</td>
- * <td id="t01">$1$2&#x00b1$3</td>
+ * <td id="t01">$1$2&#x00b1;$3</td>
  * <td id="t01">Converts <tt>-XX:+Inline</tt> to <tt>-XX:-Inline</tt></td>
  * </tr>
  * <tr>
  * <td id="t01">^(-|--)(\w*:)\-(\w(-|\w)*)$</td>
  * <td id="t01">$1$2+$3</td>
- * <td id="t01">$1$2&#x00b1$3</td>
+ * <td id="t01">$1$2&#x00b1;$3</td>
  * <td id="t01">Converts <tt>-XX:-Inline</tt> to <tt>-XX:+Inline</tt></td>
  * </tr>
  * </table>
@@ -4400,13 +4400,13 @@ public Builder(RegexTransformer old) {
  * <tr>
  * <td id="t01">^-(\w)$</td>
  * <td id="t01">+$1</td>
- * <td id="t01">&#x00b1$1</td>
+ * <td id="t01">&#x00b1;$1</td>
  * <td id="t01">Converts <tt>-v</tt> to <tt>+v</tt></td>
  * </tr>
  * <tr>
  * <td id="t01">^\+(\w)$</td>
  * <td id="t01">-$1</td>
- * <td id="t01">&#x00b1$1</td>
+ * <td id="t01">&#x00b1;$1</td>
  * <td id="t01">Converts <tt>-v</tt> to <tt>+v</tt></td>
  * </tr>
  * </table>