Add missing Javadoc to API subprojects #2218
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elharo
approved these changes
Apr 2, 2025
api/maven-api-annotations/src/main/java/org/apache/maven/api/annotations/Config.java
Outdated
Show resolved
Hide resolved
| @@ -24,28 +24,69 @@ | |||
| import java.util.Objects; | |||
| import java.util.Set; | |||
|
|
|||
| /** | |||
There was a problem hiding this 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
| private static class DefaultPathScope extends DefaultExtensibleEnum implements PathScope { | ||
| private final ProjectScope projectScope; | ||
| private final Set<DependencyScope> dependencyScopes; | ||
|
|
||
| /** |
There was a problem hiding this 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
There was a problem hiding this comment.
This whole class is package protected and the classes are even private. Ideally they'd be refactored as records. And they'd become a one line record definition (we may need the toString though).
Having them top-level classes make them more visible (not in the java sense), and I don't think they need to be.
gnodet
force-pushed
the
add-api-javadoc
branch
2 times, most recently
from
d65222b to
c416845
Compare
- Add missing class-level and method-level Javadoc to various classes in api/ subprojects - Add missing type parameter Javadoc to parameterized classes - Fix Javadoc errors by escaping angle brackets in code examples - Fix Javadoc reference errors in TypeRegistry - Remove cross-module references in TypeRegistry Javadoc - Enhance javadoc for Config.Source enum to clarify when properties are evaluated - Add missing package-info.java for org.apache.maven.di.tool package - Enhance existing package-info.java files with more detailed documentation - Ensure consistent Javadoc style across the API
|
source branch deleted |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds missing Javadoc to various classes and interfaces in the API subprojects.
Changes:
These changes improve the API documentation, making it more comprehensive and consistent, which will help developers using the Maven API.