gnodet-bot commented on code in PR #2210:
URL: https://github.com/apache/maven-resolver/pull/2210#discussion_r4312560596
##########
maven-resolver-api/src/main/java/org/eclipse/aether/repository/WorkspaceRepository.java:
##########
@@ -28,6 +28,9 @@
* the contained artifacts is handled by a {@link WorkspaceReader}.
*/
public final class WorkspaceRepository implements ArtifactRepository {
+ /**
+ * The default content type used by the no-arg constructor.
Review Comment:
⚠️ **Misleading description for `ID`**
`ID = "workspace"` is returned by `getId()` — it is the **repository
identifier**, not a content type. The no-arg constructor passes `"workspace"`
as the *type* (to `getContentType()` / `this.type`), but that's a different
field from `ID`. Calling `ID` "the default content type" conflates the two.
```suggestion
/**
* The identifier of this workspace repository type, returned by {@link
#getId()}.
*/
```
##########
maven-resolver-api/src/main/java/org/eclipse/aether/transfer/ChecksumFailureException.java:
##########
@@ -48,6 +52,7 @@ public class ChecksumFailureException extends
RepositoryException {
* @param expected The expected checksum as declared by the hosting
repository, may be {@code null}.
* @param expectedKind The expected checksum kind, may be {@code null}.
* @param actual The actual checksum as computed from the local bytes, may
be {@code null}.
+ * @return The new exception, never {@code null}.
Review Comment:
⚠️ **Wrong Javadoc tag order — `@return` placed after `@since`**
Standard Javadoc tag order is `@param` → `@return` → `@throws` → `@since`.
The new `@return` tag on `mismatch()` (and the three other factory methods
below: `mismatchDetail`, `noneAvailable`, `processingFailure`) is inserted
**after** `@since 2.0.19`, which violates this ordering and will produce
doclint warnings — the exact problem this PR is trying to eliminate.
```suggestion
* @param actual The actual checksum as computed from the local bytes,
may be {@code null}.
* @return The new exception, never {@code null}.
* @since 2.0.19
```
(Same fix needed on `mismatchDetail` at line 71, `noneAvailable` at line
118, and `processingFailure` at line 131 — move `@return` before `@since` in
each.)
--
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]
