Fix javadoc for MessageUtils and Style

This commit is contained in:
Guillaume Nodet 2023-06-23 16:21:36 +02:00
parent a279289bc3
commit 09b0436828
2 changed files with 12 additions and 4 deletions

View File

@ -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;

View File

@ -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"),