gnodet-bot commented on code in PR #13267:
URL: https://github.com/apache/maven/pull/13267#discussion_r4119062251
##########
api/maven-api-core/src/main/java/org/apache/maven/api/DependencyScope.java:
##########
@@ -73,6 +73,21 @@ public enum DependencyScope {
/**
* Provided.
+ * <p>
+ * A dependency required for compilation and testing that is expected to
be provided at runtime
+ * by the JDK or the runtime environment/container.
+ * <p>
+ * <b>Transitivity and classpath behavior:</b>
+ * <ul>
+ * <li><b>Downstream transitivity:</b> Dependencies in this scope are
not transitive to projects
+ * that depend on this project.</li>
+ * <li><b>Upstream transitivity:</b> Transitive {@code compile} and
{@code runtime} dependencies
+ * of a provided dependency are included and assigned effective
{@code provided} scope.</li>
+ * <li><b>Omitted dependencies:</b> Transitive {@code provided} and
{@code test} dependencies of
+ * a provided dependency are omitted.</li>
Review Comment:
💡 **Javadoc style nit:** The `<p>` tags here use the "bare paragraph
separator" style (just `<p>` on its own line). While valid, the Maven
codebase's Checkstyle configuration may flag this. Verify it passes `mvn
checkstyle:check` on this module.
Also, the other scope constants in this enum use minimal one-line Javadoc
(e.g., `COMPILE` = `Compile, runtime and test.`). Consider filing a follow-up
issue to bring the other scopes up to the same documentation level as
`PROVIDED` here — or do it in this PR to avoid inconsistency.
--
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]
