Copilot commented on code in PR #165:
URL:
https://github.com/apache/maven-toolchains-plugin/pull/165#discussion_r3624142086
##########
src/site/apt/toolchains/custom.apt:
##########
@@ -51,9 +51,7 @@ Custom Toolchains
which is an internal requirement,
* a
{{{/ref/current/maven-core/apidocs/org/apache/maven/toolchain/ToolchainFactory.html}<<<org.apache.maven.toolchain.ToolchainFactory>>>}},
- provided as Plexus component: Plexus
{{{http://plexus.codehaus.org/plexus-containers/plexus-component-annotations/}<<<@Component>>>}}
- annotation in the class is extracted by
{{{http://plexus.codehaus.org/plexus-containers/plexus-component-metadata/}<<<plexus-component-metadata>>>}}
- plugin.
+ provided as {{{https://maven.apache.org/maven-jsr330.html}JSR-330
component}} <<<@Named>>> with the name of the toolchain and <<<@Singleton>>>
annotation.
Review Comment:
The phrasing "@Named with the name of the toolchain" is a bit ambiguous
(it’s the toolchain *type/hint*, e.g. `@Named("custom")`, not an arbitrary
display name) and the sentence reads awkwardly without an explicit “annotated
with …”. Clarifying this will help readers implement a compatible
`ToolchainFactory`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
