Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MJAVADOC-770] Implement legacy mode for Java 9+ #228

Merged
merged 1 commit into from Sep 6, 2023
Merged

[MJAVADOC-770] Implement legacy mode for Java 9+ #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/it/projects/MJAVADOC-770/invoker.properties
View file
Open in desktop
@@ -0,0 +1,19 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

invoker.goals= package
invoker.java.version = 9+
83 changes: 83 additions & 0 deletions src/it/projects/MJAVADOC-770/pom.xml
View file
Open in desktop
@@ -0,0 +1,83 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.apache.maven.plugins.javadoc.it</groupId>
<artifactId>mjavadoc770</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>

<url>https://issues.apache.org/jira/browse/MJAVADOC-770</url>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.build.targetJdk>9</project.build.targetJdk>
<maven.compiler.source>${project.build.targetJdk}</maven.compiler.source>
<maven.compiler.target>${project.build.targetJdk}</maven.compiler.target>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not maven.compiler.release in javadoc configuration a release options is used.

</properties>

<dependencies>
<dependency>
<groupId>org.apiguardian</groupId>
<artifactId>apiguardian-api</artifactId>
<version>1.1.2</version>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.3.0</version>
<executions>
<execution>
<id>default-jar</id>
<!-- add module name to main artifact -->
<configuration>
<archive>
<manifestEntries combine.children="append">
<Automatic-Module-Name>mjavadoc770</Automatic-Module-Name>
</manifestEntries>
</archive>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>@project.version@</version>
<executions>
<execution>
<id>javadoc</id>
<goals>
<goal>jar</goal>
</goals>
<phase>package</phase>
<configuration>
<legacyMode>true</legacyMode>
<release>${project.build.targetJdk}</release>
<skip>false</skip>
<detectJavaApiLink>false</detectJavaApiLink>
<detectOfflineLinks>false</detectOfflineLinks>
<failOnWarnings>true</failOnWarnings>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
35 changes: 35 additions & 0 deletions src/it/projects/MJAVADOC-770/src/main/java/mjavadoc770/Main.java
View file
Open in desktop
@@ -0,0 +1,35 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package mjavadoc770;

/**
* This is the main class.
*/
public final class Main {
/**
* This is the main method.
*
* @param args The arguments
* @throws Exception if something goes wrong
*/
public static final void main(String ... args) throws Exception {
System.out.println("Hello, World!");
}
}
23 changes: 23 additions & 0 deletions src/it/projects/MJAVADOC-770/verify.groovy
View file
Open in desktop
@@ -0,0 +1,23 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

// new style javadoc has a module summary. legacy mode has not.
def moduleFile = new File( basedir, 'target/apidocs/mjavadoc770/module-summary.html')

assert !moduleFile.exists()
29 changes: 23 additions & 6 deletions src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
View file
Open in desktop
Expand Up @@ -841,6 +841,16 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
@Parameter(property = "verbose", defaultValue = "false")
private boolean verbose;

/**
* Run the javadoc tool in pre-Java 9 (non-modular) style even if the java version is
* post java 9. This allows non-JPMS projects that have moved to newer Java
* versions to create javadocs without having to use JPMS modules.
*
* @since 3.5.1
*/
@Parameter(property = "legacyMode", defaultValue = "false")
private boolean legacyMode;

// ----------------------------------------------------------------------
// Standard Doclet Options - all alphabetical
// ----------------------------------------------------------------------
Expand Down Expand Up @@ -2068,7 +2078,9 @@ protected Map<Path, Collection<String>> getFiles(Collection<Path> sourcePaths) t
} else if (source != null) {
autoExclude = JavaVersion.parse(source).isBefore("9");
} else {
autoExclude = false;
// if legacy mode is active, treat it like pre-Java 9 (exclude module-info),
// otherwise don't auto-exclude anything.
autoExclude = legacyMode;
}

for (Path sourcePath : sourcePaths) {
Expand Down Expand Up @@ -4383,11 +4395,16 @@ private void addJavadocOptions(

Map<String, JavaModuleDescriptor> allModuleDescriptors = new HashMap<>();

boolean supportModulePath = javadocRuntimeVersion.isAtLeast("9");
if (release != null) {
supportModulePath &= JavaVersion.parse(release).isAtLeast("9");
} else if (source != null) {
supportModulePath &= JavaVersion.parse(source).isAtLeast("9");
// do not support the module path in legacy mode
boolean supportModulePath = !legacyMode;

if (supportModulePath) {
supportModulePath &= javadocRuntimeVersion.isAtLeast("9");
if (release != null) {
supportModulePath &= JavaVersion.parse(release).isAtLeast("9");
} else if (source != null) {
supportModulePath &= JavaVersion.parse(source).isAtLeast("9");
}
}

if (supportModulePath) {
Expand Down