Skip to content

Commit c8270f9

Browse files
authored
detectOfflineLinks is now false per default for all *jar* mojo issue #1258 (#1259)
* Issue #1258 make detectOfflineLinks false per default for jar mojo --------- Signed-off-by: Olivier Lamy <olamy@apache.org>
1 parent 953e609 commit c8270f9

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ public AbstractJavadocMojo(
496496
* Detect the links for all modules defined in the project.
497497
* <br/>
498498
* If {@code reactorProjects} is defined in a non-aggregator way, it generates default offline links
499-
* between modules based on the defined project's urls. For instance, if a parent project has two projects
499+
* between modules based on the defined project's URLs. For instance, if a parent project has two projects
500500
* <code>module1</code> and <code>module2</code>, the <code>-linkoffline</code> will be:
501501
* <br/>
502502
* The added Javadoc <code>-linkoffline</code> parameter for <b>module1</b> will be
@@ -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: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,25 @@ public JavadocJarMojo(
176176
@Parameter(property = "maven.javadoc.classifier", defaultValue = "javadoc", required = true)
177177
private String classifier;
178178

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

291310
return outputFile;
292311
}
312+
313+
@Override
314+
public boolean isDetectOfflineLinks() {
315+
return detectOfflineLinks;
316+
}
293317
}

0 commit comments

Comments
 (0)