Uploaded image for project: 'PUBLIC - Liferay Faces'
  1. PUBLIC - Liferay Faces
  2. FACES-3126

Suppress maven-javadoc-plugin warnings for "missing" @returns

    Details

      Description

      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>
      

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: