You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
+8Lines changed: 8 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,14 @@ Licensed to the Apache Software Foundation (ASF) under one or more
20
20
21
21
/**
22
22
* 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.
Copy file name to clipboardExpand all lines: src/main/java/org/apache/commons/cli/help/HelpAppendable.java
+5-2Lines changed: 5 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,15 @@ Licensed to the Apache Software Foundation (ASF) under one or more
20
20
importjava.util.Collection;
21
21
22
22
/**
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
24
24
* a Heading.
25
25
* <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
27
27
* by two line breaks, while an XHTML output would print the text surrounded by <p> and </p>.
28
28
* </p>
29
+
* <p>
30
+
* Note the {@link Appendable} documentation on the topics of Unicode and threading, these comments also apply here.
0 commit comments