如何在Gradle生成的groovydocs中包含Groovy或Java注释?

时间:2017-10-24 19:46:48

标签: gradle groovy groovydoc

例如,我在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())
}

...当由Gradle的groovydoc任务生成时,产生这个:

Groovydoc generated documentation

但是,我希望groovydoc任务能够解析方法注释并将其显示为Spring's API docs

Sring API Docs

有没有办法配置groovydoc Gradle任务来执行此操作,还是需要使用其他库或工具?

0 个答案:

没有答案