Skip to content

Commit b35ee1d

Browse files
committed
Issue #1258 make detectOfflineLinks false per default for jar mojo
Signed-off-by: Olivier Lamy <[email protected]>
1 parent 3ca7ae3 commit b35ee1d

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5331,6 +5331,10 @@ private String getFullJavadocGoal() {
53315331
return sb.toString();
53325332
}
53335333

5334+
protected boolean isDetectOfflineLinks() {
5335+
return detectOfflineLinks;
5336+
}
5337+
53345338
/**
53355339
* Using Maven, a Javadoc link is given by <code>${project.url}/apidocs</code>.
53365340
*
@@ -5343,7 +5347,7 @@ private String getFullJavadocGoal() {
53435347
*/
53445348
private List<OfflineLink> getModulesLinks() throws MavenReportException {
53455349
List<MavenProject> aggregatedProjects = reactorProjects;
5346-
if (!detectOfflineLinks || isAggregator() || aggregatedProjects.isEmpty()) {
5350+
if (!isDetectOfflineLinks() || isAggregator() || aggregatedProjects.isEmpty()) {
53475351
return Collections.emptyList();
53485352
}
53495353

src/main/java/org/apache/maven/plugins/javadoc/JavadocJarMojo.java

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ public class JavadocJarMojo extends AbstractJavadocMojo {
9494
*/
9595
private JarArchiver jarArchiver;
9696

97+
98+
9799
// CHECKSTYLE_OFF: ParameterNumber
98100
@Inject
99101
public JavadocJarMojo(
@@ -176,6 +178,25 @@ public JavadocJarMojo(
176178
@Parameter(property = "maven.javadoc.classifier", defaultValue = "javadoc", required = true)
177179
private String classifier;
178180

181+
/**
182+
* Detect the links for all modules defined in the project.
183+
* <br/>
184+
* If {@code reactorProjects} is defined in a non-aggregator way, it generates default offline links
185+
* between modules based on the defined project's urls. For instance, if a parent project has two projects
186+
* <code>module1</code> and <code>module2</code>, the <code>-linkoffline</code> will be:
187+
* <br/>
188+
* The added Javadoc <code>-linkoffline</code> parameter for <b>module1</b> will be
189+
* <code>/absolute/path/to/</code><b>module2</b><code>/target/site/apidocs</code>
190+
* <br/>
191+
* The added Javadoc <code>-linkoffline</code> parameter for <b>module2</b> will be
192+
* <code>/absolute/path/to/</code><b>module1</b><code>/target/site/apidocs</code>
193+
*
194+
* @see #offlineLinks
195+
* @since 2.6
196+
*/
197+
@Parameter(property = "detectOfflineLinks", defaultValue = "false")
198+
private boolean detectOfflineLinks;
199+
179200
/** {@inheritDoc} */
180201
@Override
181202
protected void doExecute() throws MojoExecutionException {
@@ -290,4 +311,10 @@ private File generateArchive(File javadocFiles, String jarFileName) throws Archi
290311

291312
return outputFile;
292313
}
314+
315+
@Override
316+
public boolean isDetectOfflineLinks() {
317+
return detectOfflineLinks;
318+
}
319+
293320
}

0 commit comments

Comments
 (0)