desruisseaux commented on code in PR #2180:
URL: https://github.com/apache/maven/pull/2180#discussion_r2010550105


##########
api/maven-api-core/src/main/java/org/apache/maven/api/SourceRoot.java:
##########
@@ -26,13 +26,23 @@
 /**
  * A root directory of source files.
  * The sources may be Java main classes, test classes, resources or anything 
else identified by the scope.
+ *
+ * <h2>Default values</h2>
+ * The default implementation of all methods in this interface match the 
default values
+ * documented in {@code maven.mdo} (the <abbr>POM</abbr> model).
  */
 public interface SourceRoot {
     /**
      * {@return the root directory where the sources are stored}.
      * The path is relative to the <abbr>POM</abbr> file.
+     *
+     * <h4>Default implementation</h4>
+     * The default value is <code>src/{@linkplain #scope() scope}/{@linkplain 
#language() language}</code>

Review Comment:
   Currently, this is called "scope" with two recognized values: `main` or 
`test`. I agree that there is a risk of confusion with dependency scopes. 
However, the "scope" term is already used in different contexts. Maven core 
currently has:
   
   * `ProjectScope` with `main` and `test` (the scopes in question above).
   * `DependencyScope` with `compile`, `runtime`, `provided`, `test`, etc.
   * `PathScope` with `main-compile`, `main-runtime`, `test-compile` and 
`test-runtime`.
   *  `Scope` for lifecycle and visibility of objects in the dependency 
injection system.
   *  `SessionScope` (internal)
   * `MojoExecutionScope` (internal)
   
   I agree that users would see only dependency scopes and project scopes. We 
could rename the latter. However, we could also said that a scope is like 
`name` or a `id` properties: they are used for different kinds of objects, and 
their meaning depend on the object where they appear.



-- 
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: issues-unsubscr...@maven.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to