gnodet-bot commented on code in PR #612:
URL: https://github.com/apache/maven-jar-plugin/pull/612#discussion_r4108284465
##########
src/main/java/org/apache/maven/plugins/jar/TestJarMojo.java:
##########
@@ -35,9 +35,16 @@ public class TestJarMojo extends AbstractJarMojo {
/**
* Set this to {@code true} to bypass test-jar generation.
- * Its use is not recommended, but quite convenient on occasion.
+ *
+ * <p>Note: unlike {@code -Dmaven.test.skip=true} (which also skips test
compilation and makes
+ * the test-jar unavailable to downstream modules), this flag suppresses
only the packaging step
+ * while leaving test classes compiled and accessible within the reactor.
+ * Use {@code -DskipTests} or, with Maven 4.1+, {@code --skip-tests}
to skip test
+ * <em>execution</em> without preventing the test-jar from being built.</p>
+ *
+ * @since 2.2
*/
Review Comment:
💡 `@since 2.2` is incorrect — the `skip` field itself predates 2.2 (it's
been in TestJarMojo since the class was created). The current development
version is `4.0.0-beta-2-SNAPSHOT`, and the rest of this codebase uses `@since
4.0.0-beta-2` for new features (see `AbstractJarMojo.java`).
Since the field isn't new — only its property binding changed — the `@since`
tag should either document the property change explicitly or be dropped. The
Javadoc body already describes the new behavior.
```suggestion
* @since 4.0.0-beta-2
```
--
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]
