0

For example, I have the following code in UserController.groovy:

/**
 * Retrieves all users from the database.
 *
 * @return A list of all users from the database.
 */
@GetMapping
@ApiOperation(value = 'Retrieves all users from the database.')
ResponseEntity<List<UserEntity>> get() {
    ResponseEntity.ok().body(userService.getAllUsers())
}

...which, when generated by Gradle's groovydoc task, produces this:

Groovydoc generated documentation

However, I would like the groovydoc task to be able to parse method annotations and display them like Spring's API docs:

Sring API Docs

Is there a way to configure the groovydoc Gradle task to do that, or do I need to use another library or tool?

homersimpson
  • 4,124
  • 4
  • 29
  • 39

0 Answers0