Skip to content

Commit 8ae17af

Browse files
committed
Javadoc: Fix spelling and use wording closer to the type names
Add documentation
1 parent 8677d16 commit 8ae17af

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ Licensed to the Apache Software Foundation (ASF) under one or more
2020

2121
/**
2222
* An abstract implementation of {@link HelpAppendable} that writes output to an {@link Appendable} instance.
23+
* <p>
24+
* 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>
25+
* appendable) which it uses as its basic sink of data, but possibly transforming the data along the way or providing additional functionality.
26+
* </p>
27+
* <p>
28+
* The class {@code FilterHelpAppendable} itself simply overrides all methods of {@code HelpAppendable} with versions that pass all requests to the underlying
29+
* appendable. Subclasses of {@code FilterHelpAppendable} may further override some of these methods as well as provide additional methods and fields.
30+
* </p>
2331
*
2432
* @since 1.10.0
2533
*/

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,15 @@ Licensed to the Apache Software Foundation (ASF) under one or more
2020
import java.util.Collection;
2121

2222
/**
23-
* 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
23+
* 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
2424
* a Heading.
2525
* <p>
26-
* 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
26+
* 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
2727
* by two line breaks, while an XHTML output would print the text surrounded by &lt;p&gt; and &lt;/p&gt;.
2828
* </p>
29+
* <p>
30+
* Note the {@link Appendable} documentation on the topics of Unicode and threading, these comments also apply here.
31+
* </p>
2932
*
3033
* @since 1.10.0
3134
*/

0 commit comments

Comments
 (0)