This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-cli.git
The following commit(s) were added to refs/heads/master by this push:
new 6f73301 Javadoc
6f73301 is described below
commit 6f733018d3b49e9f6fee09d26a6bfb9fc538cac8
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Oct 14 16:33:18 2024 -0400
Javadoc
---
.../java/org/apache/commons/cli/help/FilterHelpAppendable.java | 5 +++--
.../java/org/apache/commons/cli/help/TextHelpAppendable.java | 6 ++++--
.../java/org/apache/commons/example/cli/AptHelpAppendable.java | 6 ++++++
.../org/apache/commons/example/cli/XhtmlHelpAppendable.java | 10 +++++++++-
4 files changed, 22 insertions(+), 5 deletions(-)
diff --git
a/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
b/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
index 9d19110..ee10517 100644
--- a/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
+++ b/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
@@ -39,9 +39,10 @@ public abstract class FilterHelpAppendable implements
HelpAppendable {
protected final Appendable output;
/**
- * Constructs an instance using the provided Appendable instance.
+ * Constructs an appendable filter built on top of the specified
underlying appendable.
*
- * @param output the Appendable instance to write to.
+ * @param output the underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
+ * without an underlying stream.
*/
protected FilterHelpAppendable(final Appendable output) {
this.output = output;
diff --git a/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
b/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
index 10e432e..076fe79 100644
--- a/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
+++ b/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
@@ -115,8 +115,10 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
private final TextStyle.Builder styleBuilder;
/**
- * Construct from an output.
- * @param output the Appendable to write the output to.
+ * Constructs an appendable filter built on top of the specified
underlying appendable.
+ *
+ * @param output the underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
+ * without an underlying stream.
*/
public TextHelpAppendable(final Appendable output) {
super(output);
diff --git
a/src/test/java/org/apache/commons/example/cli/AptHelpAppendable.java
b/src/test/java/org/apache/commons/example/cli/AptHelpAppendable.java
index 463e416..ae155c0 100644
--- a/src/test/java/org/apache/commons/example/cli/AptHelpAppendable.java
+++ b/src/test/java/org/apache/commons/example/cli/AptHelpAppendable.java
@@ -65,6 +65,12 @@ public class AptHelpAppendable extends FilterHelpAppendable {
return new String(padding);
}
+ /**
+ * Constructs an appendable filter built on top of the specified
underlying appendable.
+ *
+ * @param output the underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
+ * without an underlying stream.
+ */
public AptHelpAppendable(final Appendable output) {
super(output);
}
diff --git
a/src/test/java/org/apache/commons/example/cli/XhtmlHelpAppendable.java
b/src/test/java/org/apache/commons/example/cli/XhtmlHelpAppendable.java
index 5b1a843..62e85f1 100644
--- a/src/test/java/org/apache/commons/example/cli/XhtmlHelpAppendable.java
+++ b/src/test/java/org/apache/commons/example/cli/XhtmlHelpAppendable.java
@@ -27,9 +27,17 @@ import org.apache.commons.cli.help.TableDefinition;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.text.StringEscapeUtils;
-/** An example XML helpAppendable */
+/**
+ * A class to write XHTML formatted text.
+ */
public class XhtmlHelpAppendable extends FilterHelpAppendable {
+ /**
+ * Constructs an appendable filter built on top of the specified
underlying appendable.
+ *
+ * @param output the underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
+ * without an underlying stream.
+ */
public XhtmlHelpAppendable(final Appendable output) {
super(output);
}
