search

zutnop / telekom-workflow-engine

An embeddable Java framework for running long-lived business processes
MIT License
27 stars 14 forks source link

Fix all javadoc errors #7

Open zutnop opened 7 years ago

zutnop commented 7 years ago

When building and releasing with java 8, the doclint generates lots of javadoc errors and thus the release builds fail.

Example bugs:

[ERROR] C:\TWE\telekom-workflow-engine\telekom-workflow-engine\src\main\java\ee\telekom\workflow\api\ElementUtil.java:28: warning: no @param for outputElement [ERROR] public static OutputMapping createOutputMapping( Element outputElement ){ [ERROR] ^ [ERROR] C:\TWE\telekom-workflow-engine\telekom-workflow-engine\src\main\java\ee\telekom\workflow\api\ElementUtil.java:28: warning: no @return [ERROR] public static OutputMapping createOutputMapping( Element outputElement ){ [ERROR] ^ [ERROR] C:\TWE\telekom-workflow-engine\telekom-workflow-engine\src\main\java\ee\telekom\workflow\api\ElementUtil.java:51: warning: no @param for arguments [ERROR] public static InputMapping<?>[] createArrayMapping( Object[] arguments ){ [ERROR] ^ [ERROR] C:\TWE\telekom-workflow-engine\telekom-workflow-engine\src\main\java\ee\telekom\workflow\api\ElementUtil.java:51: warning: no @return [ERROR] public static InputMapping<?>[] createArrayMapping( Object[] arguments ){ [ERROR] ^

zutnop commented 7 years ago

As a workaround, I added

<properties>
  <additionalparam>-Xdoclint:none</additionalparam>
</properties>

to all pom.xml-s "release" profile.

When javadoc errors are fixed, remove!

zutnop commented 4 years ago

To able to build the project with JDK 11, I upgraded maven-javadoc-plugin version. This also meant that the additionalparam needed to be changed to this:

<configuration>
  <doclint>none</doclint>
</configuration>