[#PETALSDISTRIB-397] Force activation of all checks during javadoc generation - Petals Link JIRA

Details

Type: Task
Status: Resolved
Priority: Major
Resolution: Fixed
Affects Version/s: 5.2.0, CP-5.2.0
Fix Version/s: 5.3.0, CP-5.3.0
Component/s: Clients, Components, Container, Registry Overlay, Tools
Security Level: Public

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

This issue blocks:
~~PETALSDISTRIB-419~~ Bump maven-javadoc-plugin to 3.2.0

Activity

Ascending order - Click to sort in descending order

Christophe DENEUX made changes - Tue, 18 Dec 2018 - 09:49:07 +0100

Field	Original Value	New Value
Priority		Major [ 3 ]
Description	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: {code} <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> {code}	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: {code:xml} <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> {code}

Christophe DENEUX made changes - Tue, 18 Dec 2018 - 09:49:39 +0100

Description

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:
{code:xml}
<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>
{code}

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:
{code:xml}
<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>
{code}

Christophe DENEUX made changes - Tue, 18 Dec 2018 - 09:50:01 +0100

Fix Version/s		5.3.0 [ 10908 ]
Fix Version/s		CP-5.3.0 [ 10909 ]

Christophe DENEUX made changes - Tue, 18 Dec 2018 - 12:18:06 +0100

Summary

Force activation of all checks duing javadoc generation

Force activation of all checks during javadoc generation

Christophe DENEUX made changes - Tue, 18 Dec 2018 - 12:18:10 +0100

Status

New [ 10000 ]

Open [ 10002 ]

Christophe DENEUX made changes - Tue, 18 Dec 2018 - 12:18:11 +0100

Status

Open [ 10002 ]

In Progress [ 10003 ]

Christophe DENEUX made changes - Mon, 17 Apr 2023 - 12:21:00 +0200

Status	In Progress [ 10003 ]	Resolved [ 10004 ]
Resolution		Fixed [ 1 ]

Christophe DENEUX made changes - Mon, 17 Apr 2023 - 12:21:13 +0200

Link

This issue blocks ~~PETALSDISTRIB-419~~ [ ~~PETALSDISTRIB-419~~ ]

People

Assignee:

Christophe DENEUX

Reporter:

Christophe DENEUX
Watchers:

0

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