You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/10/14 19:26:26 UTC
(commons-cli) branch master updated (8677d16 -> e047c33)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-cli.git
from 8677d16 Rename to HelpAppendable since it extends Appendable
new 8ae17af Javadoc: Fix spelling and use wording closer to the type names
new e047c33 Rename tests
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../java/org/apache/commons/cli/help/FilterHelpAppendable.java | 8 ++++++++
src/main/java/org/apache/commons/cli/help/HelpAppendable.java | 7 +++++--
.../help/{TextHelpWriterTest.java => TextHelpAppendableTest.java} | 2 +-
.../cli/{AptHelpWriterTest.java => AptHelpAppendableTest.java} | 2 +-
.../{XhtmlHelpWriterTest.java => XhtmlHelpAppendableTest.java} | 2 +-
5 files changed, 16 insertions(+), 5 deletions(-)
rename src/test/java/org/apache/commons/cli/help/{TextHelpWriterTest.java => TextHelpAppendableTest.java} (99%)
rename src/test/java/org/apache/commons/example/cli/{AptHelpWriterTest.java => AptHelpAppendableTest.java} (99%)
rename src/test/java/org/apache/commons/example/cli/{XhtmlHelpWriterTest.java => XhtmlHelpAppendableTest.java} (99%)
(commons-cli) 01/02: Javadoc: Fix spelling and use wording closer to the type names
Posted by gg...@apache.org.
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 <ga...@gmail.com>
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
*/
(commons-cli) 02/02: Rename tests
Posted by gg...@apache.org.
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 e047c336024f8b5c5bff5bd24ad8beaa7cc9f4d7
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Oct 14 15:26:21 2024 -0400
Rename tests
---
.../cli/help/{TextHelpWriterTest.java => TextHelpAppendableTest.java} | 2 +-
.../example/cli/{AptHelpWriterTest.java => AptHelpAppendableTest.java} | 2 +-
.../cli/{XhtmlHelpWriterTest.java => XhtmlHelpAppendableTest.java} | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/test/java/org/apache/commons/cli/help/TextHelpWriterTest.java b/src/test/java/org/apache/commons/cli/help/TextHelpAppendableTest.java
similarity index 99%
rename from src/test/java/org/apache/commons/cli/help/TextHelpWriterTest.java
rename to src/test/java/org/apache/commons/cli/help/TextHelpAppendableTest.java
index f5f6d6f..0bd43f4 100644
--- a/src/test/java/org/apache/commons/cli/help/TextHelpWriterTest.java
+++ b/src/test/java/org/apache/commons/cli/help/TextHelpAppendableTest.java
@@ -35,7 +35,7 @@ import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
-public final class TextHelpWriterTest {
+public final class TextHelpAppendableTest {
private StringBuilder sb;
private TextHelpAppendable underTest;
diff --git a/src/test/java/org/apache/commons/example/cli/AptHelpWriterTest.java b/src/test/java/org/apache/commons/example/cli/AptHelpAppendableTest.java
similarity index 99%
rename from src/test/java/org/apache/commons/example/cli/AptHelpWriterTest.java
rename to src/test/java/org/apache/commons/example/cli/AptHelpAppendableTest.java
index 5e74bea..1f87a35 100644
--- a/src/test/java/org/apache/commons/example/cli/AptHelpWriterTest.java
+++ b/src/test/java/org/apache/commons/example/cli/AptHelpAppendableTest.java
@@ -32,7 +32,7 @@ import org.apache.commons.cli.help.TextStyle;
import org.apache.commons.io.IOUtils;
import org.junit.jupiter.api.Test;
-public class AptHelpWriterTest {
+public class AptHelpAppendableTest {
private final StringBuilder sb = new StringBuilder();
private final AptHelpAppendable underTest = new AptHelpAppendable(sb);
diff --git a/src/test/java/org/apache/commons/example/cli/XhtmlHelpWriterTest.java b/src/test/java/org/apache/commons/example/cli/XhtmlHelpAppendableTest.java
similarity index 99%
rename from src/test/java/org/apache/commons/example/cli/XhtmlHelpWriterTest.java
rename to src/test/java/org/apache/commons/example/cli/XhtmlHelpAppendableTest.java
index 7a4c4a7..0a8e506 100644
--- a/src/test/java/org/apache/commons/example/cli/XhtmlHelpWriterTest.java
+++ b/src/test/java/org/apache/commons/example/cli/XhtmlHelpAppendableTest.java
@@ -32,7 +32,7 @@ import org.apache.commons.cli.help.TextStyle;
import org.apache.commons.io.IOUtils;
import org.junit.jupiter.api.Test;
-public class XhtmlHelpWriterTest {
+public class XhtmlHelpAppendableTest {
private final StringBuilder sb = new StringBuilder();
private final XhtmlHelpAppendable underTest = new XhtmlHelpAppendable(sb);