st-tu-dresden / videoshop

SalesPoint sample application
Apache License 2.0
87 stars 246 forks source link

Build fails because of errors in javadoc generation #160

Closed martinmo closed 2 years ago

martinmo commented 2 years ago

Example output:

...
Error:  Generating /home/runner/work/videoshop/videoshop/target/apidocs/videoshop/catalog/CatalogController.html...
Error:  /home/runner/work/videoshop/videoshop/src/main/java/videoshop/catalog/CatalogController.java:38: warning: no comment
Error:  class CatalogController {
Error:  ^
...
martinmo commented 2 years ago

After looking closely, that's not the case. The default setting of <failOnWarnings> in maven-javadoc-plugin is false and we don't change that (I checked this with mvn help:evaluate -Pci).

The culprit is

.../videoshop/src/main/java/videoshop/VideoShop.java:48: error: reference not found
         * @see org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter#addViewControllers(org.springframework.web.servlet.config.annotation.ViewControllerRegistry)
                ^