[
https://issues.apache.org/jira/browse/MSHARED-1079?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Konrad Windszus updated MSHARED-1079:
-------------------------------------
Description:
It is not clear from the javadoc of MessageBuilder
(https://maven.apache.org/shared/maven-shared-utils/apidocs/org/apache/maven/shared/utils/logging/MessageBuilder.html)
that the {{toString()}} method is supposed to be called at the end to get the
content's of the builder.
Please add JavaDoc for the {{toString}} method and in the best case add an
explicit {{build}} method, which just calls {{toString}} internally.
Also it needs to be clarified if the MessageBuilder can be reused after
toString has been called.
was:
It is not clear from the javadoc of MessageBuilder
(https://maven.apache.org/shared/maven-shared-utils/apidocs/org/apache/maven/shared/utils/logging/MessageBuilder.html)
that the {{toString()}} method is supposed to be called at the end to get the
content's of the builder.
Please add JavaDoc for the {{toString}} method and in the best case add an
explicit {{build}} method, which just calls {{toString}} internally.
> Improve JavaDoc of MessageBuilder
> ---------------------------------
>
> Key: MSHARED-1079
> URL: https://issues.apache.org/jira/browse/MSHARED-1079
> Project: Maven Shared Components
> Issue Type: Improvement
> Components: maven-shared-utils
> Affects Versions: maven-shared-utils-3.3.4
> Reporter: Konrad Windszus
> Priority: Major
>
> It is not clear from the javadoc of MessageBuilder
> (https://maven.apache.org/shared/maven-shared-utils/apidocs/org/apache/maven/shared/utils/logging/MessageBuilder.html)
> that the {{toString()}} method is supposed to be called at the end to get
> the content's of the builder.
> Please add JavaDoc for the {{toString}} method and in the best case add an
> explicit {{build}} method, which just calls {{toString}} internally.
> Also it needs to be clarified if the MessageBuilder can be reused after
> toString has been called.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
