[MDEP-669] Optimize the documentation of <outputProperty> of build-classpath-mojo

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: build-classpath
• Labels: up-for-grabs
• Assignee: Unassigned
• Reporter: Xinrong Meng
• Created: 15/Jan/20 20:37
• Updated: 21/Oct/23 13:04

Description

The documentation in https://maven.apache.org/plugins/maven-dependency-plugin/build-classpath-mojo.html#outputProperty is relatively confusing.

 

`A property to set to the content of the classpath string.` would give users illusions that they can use this parameter to modify the content of the classpath string, rather than set the content of the classpath string to some property.

 

As far as I'm concerned, I wanted to embed classifier information in the displayed classpath string, and I misunderstood this parameter until I checked the source code of how it is defined.

 

All in all, it would be great we could explicitly point it out that this parameter sets the content of the classpath string to some property.

Issue Links

• links to: GitHub Pull Request #283