-
Type:
Task
-
Status: Closed
-
Priority:
Minor
-
Resolution: Fixed
-
Affects Version/s: None
-
Fix Version/s: util-4.0.0, generator-1.1.1, portal-3.1.0
-
Labels:
This task involves adding the following configuration to the maven-javadoc-plugin in order to suppress warnings for "missing" @returns descriptions. Much of the Liferay Faces API uses a different style of JavaDoc, using the main description to document the return value rather than duplicating the same information in the @returns description.
pom.xml
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <!-- MJAVADOC-275: Need version 2.8 or higher for release:prepare to generate JavaDoc --> <version>2.10.3</version> <configuration> <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam> </configuration> </plugin>