elharo commented on code in PR #2218:
URL: https://github.com/apache/maven/pull/2218#discussion_r2024837313
##########
api/maven-api-annotations/src/main/java/org/apache/maven/api/annotations/Config.java:
##########
@@ -24,18 +24,45 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+/**
+ * Annotation used to mark fields that represent configuration properties.
+ * This annotation provides metadata about how the configuration property
+ * should be handled, including its source, type, default value, and whether
it's read-only.
+ *
+ * @since 4.0.0
+ */
@Experimental
@Documented
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface Config {
+ /**
+ * Specifies the source of the configuration property.
Review Comment:
What is a "source" here? Anything we can say beyond the class name?
##########
api/maven-api-core/src/main/java/org/apache/maven/api/ExtensibleEnums.java:
##########
@@ -24,28 +24,69 @@
import java.util.Objects;
import java.util.Set;
+/**
Review Comment:
Not for this PR, but I wonder if we should have a different name here to
avoid confusion with Java enums, which these aren't
##########
api/maven-api-core/src/main/java/org/apache/maven/api/ExtensibleEnums.java:
##########
@@ -66,37 +107,73 @@ public String toString() {
}
}
+ /**
+ * Implementation of the PathScope interface.
+ */
private static class DefaultPathScope extends DefaultExtensibleEnum
implements PathScope {
private final ProjectScope projectScope;
private final Set<DependencyScope> dependencyScopes;
+ /**
Review Comment:
again not for this PR, but why is this all in one class? It feels like these
should be split out to different classes
--
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]
