search

jakartaee / rest

Jakarta RESTful Web Services
Other
354 stars 114 forks source link

Bugfix/978 checkstyle extended #1026

Closed ascheman closed 2 years ago

ascheman commented 2 years ago

Most checkstyle problems of #978 are resolved by this patch.

Two open complaints require deeper discussion (will comment in #978)!

Requesting fast-track review as this PR does neither change API nor spec.

spericas commented 2 years ago

Could we fix these as part of this PR?

[WARNING] Javadoc Warnings
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:137: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:176: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:322: warning: @param "T" has already been specified
[WARNING] * @param <T>     the entity type
[WARNING] ^
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:349: warning: @return has already been specified
[WARNING] * @return the updated builder.
[WARNING] ^
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:374: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^
mkarg commented 2 years ago

Could we fix these as part of this PR?

[WARNING] Javadoc Warnings
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:137: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:176: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:322: warning: @param "T" has already been specified
[WARNING] * @param <T>     the entity type
[WARNING] ^
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:349: warning: @return has already been specified
[WARNING] * @return the updated builder.
[WARNING] ^
[WARNING] /Users/spericas/Projects/eclipse/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:374: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^

@jelemux is already preparing a PR for this.

ascheman commented 2 years ago

Personally I would have rather deleted the else branch completely and probably leave only a comment that there might be more cases to be implemented in the future. But I have no background why the original developer (@andymc12?) wrote it this way.

andymc12 commented 2 years ago

Personally I would have rather deleted the else branch completely and probably leave only a comment that there might be more cases to be implemented in the future. But I have no background why the original developer (@andymc12?) wrote it this way.

I'm fine with removing the else block and just mentioning that the user should handle other file types.

mkarg commented 2 years ago

@ascheman Gerd, can you please solve the conflict? Thanks.