Javadoc

Author: garydgregory

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;

src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java

@@ -115,8 +115,10 @@ public static int findWrapPos(final CharSequence text, final int width, final in
     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);

src/test/java/org/apache/commons/example/cli/AptHelpAppendable.java

@@ -65,6 +65,12 @@ static String filledString(final int len, final char fillChar) {
         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);
     }

src/test/java/org/apache/commons/example/cli/XhtmlHelpAppendable.java

@@ -27,9 +27,17 @@ Licensed to the Apache Software Foundation (ASF) under one or more
 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);
     }