From 3602f82a2d2db9c9efbaf9c6b1a33def9a9ea725 Mon Sep 17 00:00:00 2001
From: Ken Dombeck <ken.dombeck@target.com>
Date: Tue, 30 Dec 2025 10:52:31 -0600
Subject: [PATCH 1/3] [CLI-352] Correct HelpFormatter Javadoc

---
 .../java/org/apache/commons/cli/help/HelpFormatter.java   | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
index c4081ec4b..c5295a4f7 100644
--- a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
@@ -31,14 +31,14 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  *
  * <pre>
  * Options options = new Options();
- * options.addOption(OptionBuilder.withLongOpt("file").withDescription("The file to be processed").hasArg().withArgName("FILE").isRequired().create('f'));
- * options.addOption(OptionBuilder.withLongOpt("version").withDescription("Print the version of the application").create('v'));
- * options.addOption(OptionBuilder.withLongOpt("help").create('h'));
+ * options.addOption(Option.builder().longOpt("file").desc("The file to be processed").hasArg().argName("FILE").required().option("f").get());
+ * options.addOption(Option.builder().longOpt("version").desc("Print the version of the application").option("v").get());
+ * options.addOption(Option.builder().longOpt("help").option("h").get());
  *
  * String header = "Do something useful with an input file";
  * String footer = "Please report issues at https://example.com/issues";
  *
- * HelpFormatter formatter = new HelpFormatter();
+ * HelpFormatter formatter = HelpFormatter.builder().get();
  * formatter.printHelp("myapp", header, options, footer, true);
  * </pre>
  * <p>

From e98489e582ed63935715ef018b34695ce4b25111 Mon Sep 17 00:00:00 2001
From: Ken Dombeck <ken.dombeck@target.com>
Date: Tue, 30 Dec 2025 13:13:22 -0600
Subject: [PATCH 2/3] [CLI-352] Correct HelpFormatter Javadoc

---
 src/main/java/org/apache/commons/cli/HelpFormatter.java | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index fb9da62e9..3d87edf01 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -44,9 +44,9 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  * </p>
  * <pre>
  * Options options = new Options();
- * options.addOption(OptionBuilder.withLongOpt("file").withDescription("The file to be processed").hasArg().withArgName("FILE").isRequired().create('f'));
- * options.addOption(OptionBuilder.withLongOpt("version").withDescription("Print the version of the application").create('v'));
- * options.addOption(OptionBuilder.withLongOpt("help").create('h'));
+ * options.addOption(Option.builder().longOpt("file").desc("The file to be processed").hasArg().argName("FILE").required().option("f").get());
+ * options.addOption(Option.builder().longOpt("version").desc("Print the version of the application").option("v").get());
+ * options.addOption(Option.builder().longOpt("help").option("h").get());
  *
  * String header = "Do something useful with an input file\n\n";
  * String footer = "\nPlease report issues at https://example.com/issues";

From 63484f7b8bb8501fac17aaded12f186c5b0e562f Mon Sep 17 00:00:00 2001
From: Ken Dombeck <ken.dombeck@target.com>
Date: Tue, 30 Dec 2025 13:27:07 -0600
Subject: [PATCH 3/3] Use overloaded builder method to define option rather
 than specifiying it separately. This will be more consistent with other
 documented uses.

---
 src/main/java/org/apache/commons/cli/HelpFormatter.java     | 6 +++---
 .../java/org/apache/commons/cli/help/HelpFormatter.java     | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index 3d87edf01..febdf4c8f 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -44,9 +44,9 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  * </p>
  * <pre>
  * Options options = new Options();
- * options.addOption(Option.builder().longOpt("file").desc("The file to be processed").hasArg().argName("FILE").required().option("f").get());
- * options.addOption(Option.builder().longOpt("version").desc("Print the version of the application").option("v").get());
- * options.addOption(Option.builder().longOpt("help").option("h").get());
+ * options.addOption(Option.builder("f").longOpt("file").desc("The file to be processed").hasArg().argName("FILE").required().get());
+ * options.addOption(Option.builder("v").longOpt("version").desc("Print the version of the application").get());
+ * options.addOption(Option.builder("h").longOpt("help").get());
  *
  * String header = "Do something useful with an input file\n\n";
  * String footer = "\nPlease report issues at https://example.com/issues";
diff --git a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
index c5295a4f7..f0723706a 100644
--- a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
@@ -31,9 +31,9 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  *
  * <pre>
  * Options options = new Options();
- * options.addOption(Option.builder().longOpt("file").desc("The file to be processed").hasArg().argName("FILE").required().option("f").get());
- * options.addOption(Option.builder().longOpt("version").desc("Print the version of the application").option("v").get());
- * options.addOption(Option.builder().longOpt("help").option("h").get());
+ * options.addOption(Option.builder("f").longOpt("file").desc("The file to be processed").hasArg().argName("FILE").required().get());
+ * options.addOption(Option.builder("v").longOpt("version").desc("Print the version of the application").get());
+ * options.addOption(Option.builder("h").longOpt("help").get());
  *
  * String header = "Do something useful with an input file";
  * String footer = "Please report issues at https://example.com/issues";