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
commit 8ae17afe6431095f145196c406f232e0ceaf298c Author: Gary Gregory <[email protected]> AuthorDate: Mon Oct 14 15:25:20 2024 -0400 Javadoc: Fix spelling and use wording closer to the type names Add documentation --- .../java/org/apache/commons/cli/help/FilterHelpAppendable.java | 8 ++++++++ src/main/java/org/apache/commons/cli/help/HelpAppendable.java | 7 +++++-- 2 files changed, 13 insertions(+), 2 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 85c32d4..9d19110 100644 --- a/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java +++ b/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java @@ -20,6 +20,14 @@ import java.io.IOException; /** * An abstract implementation of {@link HelpAppendable} that writes output to an {@link Appendable} instance. + * <p> + * This class is the superclass of all classes that filter help appendables. These appendable sit on top of an existing appendable (the <em>underlying</em> + * appendable) which it uses as its basic sink of data, but possibly transforming the data along the way or providing additional functionality. + * </p> + * <p> + * The class {@code FilterHelpAppendable} itself simply overrides all methods of {@code HelpAppendable} with versions that pass all requests to the underlying + * appendable. Subclasses of {@code FilterHelpAppendable} may further override some of these methods as well as provide additional methods and fields. + * </p> * * @since 1.10.0 */ diff --git a/src/main/java/org/apache/commons/cli/help/HelpAppendable.java b/src/main/java/org/apache/commons/cli/help/HelpAppendable.java index 24a6b58..f6a8da2 100644 --- a/src/main/java/org/apache/commons/cli/help/HelpAppendable.java +++ b/src/main/java/org/apache/commons/cli/help/HelpAppendable.java @@ -20,12 +20,15 @@ import java.io.IOException; import java.util.Collection; /** - * The definition of a semantic scribe. The semantic scribe write string to output based on the semantic meaning of the type of string. e.g. a Paragraph versus + * Defines a semantic scribe. The semantic scribe appends text to an output based on the semantic meaning of the type of string. For example, a Paragraph versus * a Heading. * <p> - * The representation of the semantics is dependant upon the format being output. For example the plain text output for a paragraph may print the text followed + * The representation of the semantics is dependent upon the format being output. For example, the plain text output for a paragraph may print the text followed * by two line breaks, while an XHTML output would print the text surrounded by <p> and </p>. * </p> + * <p> + * Note the {@link Appendable} documentation on the topics of Unicode and threading, these comments also apply here. + * </p> * * @since 1.10.0 */
