Copilot commented on code in PR #15600:
URL: https://github.com/apache/grails-core/pull/15600#discussion_r3138286748
##########
grails-forge/grails-forge-api/src/main/java/org/grails/forge/api/ServletImplDTO.java:
##########
@@ -73,6 +72,7 @@ public ServletImplDTO(ServletImpl servletImpl) {
this.description = messageSource.getMessage(MESSAGE_PREFIX + name +
".description", messageContext, name);
}
+ @NonNull
@Override
@Schema(description = "A description of the GORM Implementation")
public String getDescription() {
Review Comment:
In `ServletImplDTO`, the OpenAPI `@Schema` descriptions around these getters
refer to “GORM Implementation”/“Gorm Implementation”, but this DTO represents
`ServletImpl`. This will produce misleading API docs; update the schema
descriptions for `getDescription()` and `getName()` to reference the Servlet
implementation instead.
##########
grails-forge/grails-forge-api/src/main/java/org/grails/forge/api/preview/PreviewController.java:
##########
@@ -72,7 +72,7 @@ public PreviewController(ProjectGenerator projectGenerator,
ApplicationEventPubl
* @param name The name of the application The name of the application
* @param features The features The chosen features
* @param build The build type (optional, defaults to Gradle)
- * @param reloading the development reloading (jrebel, dev tools, none,
etc)
+ * @param reloading the development reloading (jrebel, spring boot
devtools, none, etc)
Review Comment:
The `@param reloading` Javadoc lists “spring boot devtools” as an example
value, but the API enum values are `devtools`, `jrebel`, and `none` (see
`org.grails.forge.api.DevelopmentReloading#toString()`). Consider updating this
comment to reflect the actual accepted parameter values to avoid confusing API
consumers.
```suggestion
* @param reloading the development reloading (devtools, jrebel, none)
```
--
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]
