search

christophknabe / spring-ddd-bank

A sample project following Domain Driven Design with Spring Data JPA
GNU Lesser General Public License v2.1
509 stars 125 forks source link

Correct Warnings during Site JavaDoc Generation #8

Closed christophknabe closed 2 years ago

christophknabe commented 6 years ago

There are many warnings, as the descriptions of the parameter roles of methods are often written inline in the method main documentation comment. But JavaDoc requires the descriptions each with a separate @param line. All method comments should be corrected.

christophknabe commented 2 years ago

This issue gets higher priority as from Java 8 warnings will prevent the site generation. Also the command for site generation should be documented in the README.

christophknabe commented 2 years ago

Done in git branch issue8-site-generation.