Petals Distribution

Force activation of all checks during javadoc generation

Details

  • Description:
    Hide

    During build, when generating Javadoc:

    • if built with JDK 8 Oracle, all javadoc checks are activated by default,
    • if built with OpenJDK 8, javadoc checks are not activated.

    So the built result depends on the JDK used. To avoid this, we should define ourself to activate javadoc checks through the configuration of the maven-javadoc-plugin.

    In the same time, we could upgrade version of maven-javadoc-plugin:

    <properties>
   <maven-javadoc-plugin.version>3.0.1</maven-javadoc-plugin.version>
</properties>

<plugin>
   ...
    <artifactId>maven-javadoc-plugin</artifactId>
   <version>${maven-javadoc-plugin.version}</version>
   <configuration>
      <doclint>all</doclint>
   </configuration>
   <executions>
      ...
   </executions>
</plugin>
    Show
    During build, when generating Javadoc:
    • if built with JDK 8 Oracle, all javadoc checks are activated by default,
    • if built with OpenJDK 8, javadoc checks are not activated.
    So the built result depends on the JDK used. To avoid this, we should define ourself to activate javadoc checks through the configuration of the maven-javadoc-plugin. In the same time, we could upgrade version of maven-javadoc-plugin: 
    <properties>
   <maven-javadoc-plugin.version>3.0.1</maven-javadoc-plugin.version>
</properties>

<plugin>
   ...
    <artifactId>maven-javadoc-plugin</artifactId>
   <version>${maven-javadoc-plugin.version}</version>
   <configuration>
      <doclint>all</doclint>
   </configuration>
   <executions>
      ...
   </executions>
</plugin>
  • Environment:
    -

Issue Links

Depends
 

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Christophe DENEUX added a comment - Mon, 17 Apr 2023 - 12:21:00 +0200

Javadoc checks activated by svn#43166

maven-javadoc-plugin bumped to 3.2.0 by svn#43542 (PETALSDISTRIB-419)

Show
Christophe DENEUX added a comment - Mon, 17 Apr 2023 - 12:21:00 +0200 Javadoc checks activated by svn#43166 maven-javadoc-plugin bumped to 3.2.0 by svn#43542 (PETALSDISTRIB-419)

People

Dates

  • Created:
    Tue, 18 Dec 2018 - 09:48:45 +0100
    Updated:
    Mon, 17 Apr 2023 - 12:21:13 +0200
    Resolved:
    Mon, 17 Apr 2023 - 12:21:00 +0200
Atlassian JIRA (v4.1.2#531) | Report a problem | Request a feature | Contact administrators
Powered by a free Atlassian JIRA open source license for Petals ESB. Try JIRA - bug tracking software for your team.