This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/master by this push:
new 09b043682 Fix javadoc for MessageUtils and Style
09b043682 is described below
commit 09b0436828966c10cd668b44c007237e63e42861
Author: Guillaume Nodet <[email protected]>
AuthorDate: Fri Jun 23 16:21:36 2023 +0200
Fix javadoc for MessageUtils and Style
---
.../main/java/org/apache/maven/cli/jansi/MessageUtils.java | 14 +++++++++++---
.../src/main/java/org/apache/maven/cli/jansi/Style.java | 2 +-
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git
a/maven-embedder/src/main/java/org/apache/maven/cli/jansi/MessageUtils.java
b/maven-embedder/src/main/java/org/apache/maven/cli/jansi/MessageUtils.java
index 379e1e00e..3d0a5d41f 100644
--- a/maven-embedder/src/main/java/org/apache/maven/cli/jansi/MessageUtils.java
+++ b/maven-embedder/src/main/java/org/apache/maven/cli/jansi/MessageUtils.java
@@ -25,12 +25,20 @@ import org.fusesource.jansi.AnsiConsole;
import org.fusesource.jansi.AnsiMode;
/**
- * Colored message utils, to manage colors consistently across plugins (only
if Maven version is at least 3.5.0).
- * For Maven version before 3.5.0, message built with this util will never add
color.
+ * Colored message utils, to manage colors. This is the core implementation
of the
+ * {@link JansiMessageBuilderFactory} and {@link JansiMessageBuilder} classes.
+ * This class should not be used outside of maven-embedder and the public
+ * {@link org.apache.maven.api.services.MessageBuilderFactory} should be used
instead.
* <p>
* Internally, <a href="http://fusesource.github.io/jansi/">Jansi</a> is used
to render
* <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#Colors">ANSI
colors</a> on any platform.
- * @since 3.1.0
+ * <p>
+ *
+ * @see MessageBuilder
+ * @see org.apache.maven.api.services.MessageBuilderFactory
+ * @see JansiMessageBuilderFactory
+ * @see JansiMessageBuilder
+ * @since 4.0.0
*/
public class MessageUtils {
private static final boolean JANSI;
diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/jansi/Style.java
b/maven-embedder/src/main/java/org/apache/maven/cli/jansi/Style.java
index 194bf64b5..936de8268 100644
--- a/maven-embedder/src/main/java/org/apache/maven/cli/jansi/Style.java
+++ b/maven-embedder/src/main/java/org/apache/maven/cli/jansi/Style.java
@@ -25,7 +25,7 @@ import org.fusesource.jansi.Ansi.Color;
/**
* Configurable message styles.
- * @since 3.1.0
+ * @since 4.0.0
*/
enum Style {
DEBUG("bold,cyan"),