You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2017/06/04 18:06:52 UTC
[06/50] maven git commit: [MNG-6176] Fix javadoc *errors* in
maven-compat
[MNG-6176] Fix javadoc *errors* in maven-compat
Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/b12905ce
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/b12905ce
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/b12905ce
Branch: refs/heads/mvn-3.5.1/MNG-6174
Commit: b12905ce02ec0e58b475bbc1d920a6801224c02f
Parents: 52eecc4
Author: Stephen Connolly <st...@gmail.com>
Authored: Sat Mar 18 12:04:38 2017 +0000
Committer: Stephen Connolly <st...@gmail.com>
Committed: Sat Mar 18 12:34:45 2017 +0000
----------------------------------------------------------------------
maven-compat/pom.xml | 22 --------------------
.../maven/artifact/ArtifactScopeEnum.java | 2 +-
.../resolver/ResolutionListenerForDepMgmt.java | 4 ++--
.../org/apache/maven/project/ModelUtils.java | 15 ++++++-------
.../AbstractStringBasedModelInterpolator.java | 8 ++-----
.../ModelInterpolationException.java | 4 +---
.../interpolation/ModelInterpolator.java | 2 --
.../repository/MetadataResolutionResult.java | 2 +-
.../repository/metadata/MetadataGraph.java | 4 ++--
.../apache/maven/project/ModelUtilsTest.java | 18 +++++++++-------
.../inheritance/t09/ProjectInheritanceTest.java | 8 +++----
.../repository/LegacyRepositorySystemTest.java | 1 +
.../conflict/FarthestConflictResolverTest.java | 4 ++--
.../conflict/NearestConflictResolverTest.java | 4 ++--
.../conflict/NewestConflictResolverTest.java | 4 ++--
.../conflict/OldestConflictResolverTest.java | 4 ++--
pom.xml | 4 ----
17 files changed, 41 insertions(+), 69 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/pom.xml
----------------------------------------------------------------------
diff --git a/maven-compat/pom.xml b/maven-compat/pom.xml
index 7af138d..bfd2b47 100644
--- a/maven-compat/pom.xml
+++ b/maven-compat/pom.xml
@@ -132,26 +132,4 @@ under the License.
</plugins>
</build>
- <profiles>
- <profile>
- <id>javadoc8</id>
- <activation>
- <jdk>!1.7</jdk>
- </activation>
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <!-- There's no maintenance on maven-compat -->
- <additionalparam>-Xdoclint:none</additionalparam>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
- </profile>
- </profiles>
</project>
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java b/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java
index 4460a07..83edd2b 100644
--- a/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java
+++ b/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java
@@ -20,7 +20,7 @@ package org.apache.maven.artifact;
*/
/**
- * Type safe reincarnation of Artifact scope. Also supplies the <code>DEFAULT_SCOPE<code> as well
+ * Type safe reincarnation of Artifact scope. Also supplies the {@code DEFAULT_SCOPE} as well
* as convenience method to deal with scope relationships.
*
* @author <a href="oleg@codehaus.org">Oleg Gusakov</a>
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ResolutionListenerForDepMgmt.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ResolutionListenerForDepMgmt.java b/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ResolutionListenerForDepMgmt.java
index 6ca4fe7..6cf06b1 100644
--- a/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ResolutionListenerForDepMgmt.java
+++ b/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ResolutionListenerForDepMgmt.java
@@ -23,7 +23,7 @@ import org.apache.maven.artifact.Artifact;
/**
* Do not use!
- * <p/>
+ * <p>
* Should only be implemented by DebugResolutionListener. Remove this
* when the ResolutionListener interface deprecation of the manageArtifact
* method (and the [yet to be done] addition of these methods to that
@@ -40,4 +40,4 @@ public interface ResolutionListenerForDepMgmt
void manageArtifactSystemPath( Artifact artifact,
Artifact replacement );
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/main/java/org/apache/maven/project/ModelUtils.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/main/java/org/apache/maven/project/ModelUtils.java b/maven-compat/src/main/java/org/apache/maven/project/ModelUtils.java
index faf224b..fb99593 100644
--- a/maven-compat/src/main/java/org/apache/maven/project/ModelUtils.java
+++ b/maven-compat/src/main/java/org/apache/maven/project/ModelUtils.java
@@ -40,15 +40,16 @@ public final class ModelUtils
/**
* This should be the resulting ordering of plugins after merging:
- * <p/>
+ * <p>
* Given:
- * <p/>
- * parent: X -> A -> B -> D -> E
- * child: Y -> A -> C -> D -> F
- * <p/>
+ * <pre>
+ * parent: X -> A -> B -> D -> E
+ * child: Y -> A -> C -> D -> F
+ * </pre>
* Result:
- * <p/>
- * X -> Y -> A -> B -> C -> D -> E -> F
+ * <pre>
+ * X -> Y -> A -> B -> C -> D -> E -> F
+ * </pre>
*/
public static void mergePluginLists( PluginContainer childContainer, PluginContainer parentContainer,
boolean handleAsInheritance )
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java b/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java
index b3e94fc..913e2dd 100644
--- a/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java
+++ b/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java
@@ -103,10 +103,6 @@ public abstract class AbstractStringBasedModelInterpolator
this.pathTranslator = pathTranslator;
}
- /**
- * TODO Remove the throws clause.
- * @throws IOException This exception is not thrown any more, and needs to be removed.
- */
protected AbstractStringBasedModelInterpolator()
{
}
@@ -120,7 +116,7 @@ public abstract class AbstractStringBasedModelInterpolator
/**
* Serialize the inbound Model instance to a StringWriter, perform the regex replacement to resolve
* POM expressions, then re-parse into the resolved Model instance.
- * <br/>
+ * <p>
* <b>NOTE:</b> This will result in a different instance of Model being returned!!!
*
* @param model The inbound Model instance, to serialize and reference for expression resolution
@@ -189,7 +185,7 @@ public abstract class AbstractStringBasedModelInterpolator
* <li>If the value is null, but the context contains the expression, don't replace the expression string
* with the value, and continue to find other expressions.</li>
* <li>If the value is null, get it from the model properties.</li>
- * <li>
+ * </ul>
*/
public String interpolate( String src,
Model model,
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolationException.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolationException.java b/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolationException.java
index 5b02880..ea60f16 100644
--- a/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolationException.java
+++ b/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolationException.java
@@ -21,8 +21,6 @@ package org.apache.maven.project.interpolation;
/**
* @author jdcasey
- * <p/>
- * Created on Feb 2, 2005
*/
@SuppressWarnings( "serial" )
@Deprecated
@@ -69,4 +67,4 @@ public class ModelInterpolationException
return originalMessage;
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolator.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolator.java b/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolator.java
index e1556ea..036e7f0 100644
--- a/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolator.java
+++ b/maven-compat/src/main/java/org/apache/maven/project/interpolation/ModelInterpolator.java
@@ -27,8 +27,6 @@ import java.util.Map;
/**
* @author jdcasey
- * <p/>
- * Created on Feb 2, 2005
*/
@Deprecated
public interface ModelInterpolator
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java b/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java
index 0071ea4..28fb723 100644
--- a/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java
+++ b/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java
@@ -163,7 +163,7 @@ public class MetadataResolutionResult
/**
* TODO this needs to accept a {@link OverConstrainedVersionException} as returned by
* {@link #getVersionRangeViolation(int)} but it's not used like that in
- * {@link DefaultLegacyArtifactCollector}
+ * {@link org.apache.maven.repository.legacy.resolver.DefaultLegacyArtifactCollector}
*/
public MetadataResolutionResult addVersionRangeViolation( Exception e )
{
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraph.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraph.java b/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraph.java
index 532cd3c..1ae008a 100644
--- a/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraph.java
+++ b/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraph.java
@@ -103,9 +103,9 @@ public class MetadataGraph
* construct graph from a "dirty" tree
*
* @param tree "dirty" tree root
- * @param versionedVertices true if graph nodes should be versioned (different versions -> different nodes)
+ * @param versionedVertices true if graph nodes should be versioned (different versions -> different nodes)
* @param scopedVertices true if graph nodes should be versioned and scoped
- * (different versions and/or scopes -> different nodes)
+ * (different versions and/or scopes -> different nodes)
*
*/
public MetadataGraph( MetadataTreeNode tree, boolean versionedVertices, boolean scopedVertices )
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/test/java/org/apache/maven/project/ModelUtilsTest.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/test/java/org/apache/maven/project/ModelUtilsTest.java b/maven-compat/src/test/java/org/apache/maven/project/ModelUtilsTest.java
index b2750b9..402ae74 100644
--- a/maven-compat/src/test/java/org/apache/maven/project/ModelUtilsTest.java
+++ b/maven-compat/src/test/java/org/apache/maven/project/ModelUtilsTest.java
@@ -94,15 +94,19 @@ public class ModelUtilsTest
/**
* Test that this is the resulting ordering of plugins after merging:
- *
+ * <p>
* Given:
- *
- * parent: X -> A -> B -> D -> E
- * child: Y -> A -> C -> D -> F
- *
+ * </p>
+ * <pre>
+ * parent: X -> A -> B -> D -> E
+ * child: Y -> A -> C -> D -> F
+ * </pre>
+ * <p>
* Result:
- *
- * X -> Y -> A -> B -> C -> D -> E -> F
+ * </p>
+ * <pre>
+ * X -> Y -> A -> B -> C -> D -> E -> F
+ * </pre>
*/
public void testShouldPreserveChildOrderingOfPluginsAfterParentMerge()
{
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java b/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java
index 0dc4ccf..aa492e4 100644
--- a/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java
+++ b/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java
@@ -47,14 +47,14 @@ public class ProjectInheritanceTest
/**
* How the test project is set up:
*
- * 1. dependencyManagement lists dependencies on a & b,
+ * 1. dependencyManagement lists dependencies on a & b,
* with an exclusion on c in b.
* 2. the child project lists a dependency on project a only
* 3. a depends on b (which is transitive to the child project),
* and b depends on c.
*
* We should see that the resulting size of collected artifacts is two:
- * a & b only.
+ * a & b only.
*/
public void testDependencyManagementExclusionsExcludeTransitively()
throws Exception
@@ -87,7 +87,7 @@ public class ProjectInheritanceTest
* now depends upon d, which has a transitive dependency on c. Even though
* we did list an exclusion on c, it was only from within the context of
* project b. We will pick up project c in this case because no
- * restrictions were placed on d. This demonstrates that a, b, c, & d will
+ * restrictions were placed on d. This demonstrates that a, b, c, & d will
* all be collected.
*
* @throws Exception
@@ -116,4 +116,4 @@ public class ProjectInheritanceTest
assertTrue( "maven-test:t09-c is not in the project", map.containsKey( "maven-test:t09-c" ) );
assertTrue( "maven-test:t09-d is not in the project", map.containsKey( "maven-test:t09-d" ) );
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/test/java/org/apache/maven/repository/LegacyRepositorySystemTest.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/test/java/org/apache/maven/repository/LegacyRepositorySystemTest.java b/maven-compat/src/test/java/org/apache/maven/repository/LegacyRepositorySystemTest.java
index 96af590..17dfcfc 100644
--- a/maven-compat/src/test/java/org/apache/maven/repository/LegacyRepositorySystemTest.java
+++ b/maven-compat/src/test/java/org/apache/maven/repository/LegacyRepositorySystemTest.java
@@ -32,6 +32,7 @@ import org.apache.maven.model.Repository;
import org.apache.maven.model.RepositoryPolicy;
import org.apache.maven.plugin.LegacySupport;
import org.apache.maven.repository.RepositorySystem;
+import org.apache.maven.repository.legacy.LegacyRepositorySystem;
import org.codehaus.plexus.ContainerConfiguration;
import org.codehaus.plexus.PlexusConstants;
import org.codehaus.plexus.PlexusTestCase;
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/FarthestConflictResolverTest.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/FarthestConflictResolverTest.java b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/FarthestConflictResolverTest.java
index 5ca3a47..363c7a2 100644
--- a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/FarthestConflictResolverTest.java
+++ b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/FarthestConflictResolverTest.java
@@ -44,7 +44,7 @@ public class FarthestConflictResolverTest
* Tests that <code>a:2.0</code> wins in the scenario:
* <pre>
* a:1.0
- * b:1.0 -> a:2.0
+ * b:1.0 -> a:2.0
* </pre>
*/
public void testDepth()
@@ -59,7 +59,7 @@ public class FarthestConflictResolverTest
/**
* Tests that <code>a:2.0</code> wins in the scenario:
* <pre>
- * b:1.0 -> a:2.0
+ * b:1.0 -> a:2.0
* a:1.0
* </pre>
*/
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NearestConflictResolverTest.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NearestConflictResolverTest.java b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NearestConflictResolverTest.java
index 69d93d2..23683d5 100644
--- a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NearestConflictResolverTest.java
+++ b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NearestConflictResolverTest.java
@@ -44,7 +44,7 @@ public class NearestConflictResolverTest
* Tests that <code>a:1.0</code> wins in the scenario:
* <pre>
* a:1.0
- * b:1.0 -> a:2.0
+ * b:1.0 -> a:2.0
* </pre>
*/
public void testDepth()
@@ -59,7 +59,7 @@ public class NearestConflictResolverTest
/**
* Tests that <code>a:1.0</code> wins in the scenario:
* <pre>
- * b:1.0 -> a:2.0
+ * b:1.0 -> a:2.0
* a:1.0
* </pre>
*/
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolverTest.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolverTest.java b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolverTest.java
index c98f1e1..4cfffc6 100644
--- a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolverTest.java
+++ b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolverTest.java
@@ -44,7 +44,7 @@ public class NewestConflictResolverTest
* Tests that <code>a:2.0</code> wins in the scenario:
* <pre>
* a:1.0
- * b:1.0 -> a:2.0
+ * b:1.0 -> a:2.0
* </pre>
*/
public void testDepth()
@@ -59,7 +59,7 @@ public class NewestConflictResolverTest
/**
* Tests that <code>a:2.0</code> wins in the scenario:
* <pre>
- * b:1.0 -> a:2.0
+ * b:1.0 -> a:2.0
* a:1.0
* </pre>
*/
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolverTest.java
----------------------------------------------------------------------
diff --git a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolverTest.java b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolverTest.java
index cef78f9..8744de2 100644
--- a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolverTest.java
+++ b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolverTest.java
@@ -44,7 +44,7 @@ public class OldestConflictResolverTest
* Tests that <code>a:1.0</code> wins in the scenario:
* <pre>
* a:1.0
- * b:1.0 -> a:2.0
+ * b:1.0 -> a:2.0
* </pre>
*/
public void testDepth()
@@ -60,7 +60,7 @@ public class OldestConflictResolverTest
/**
* Tests that <code>a:1.0</code> wins in the scenario:
* <pre>
- * b:1.0 -> a:2.0
+ * b:1.0 -> a:2.0
* a:1.0
* </pre>
*/
http://git-wip-us.apache.org/repos/asf/maven/blob/b12905ce/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 4ce8a79..8a64bae 100644
--- a/pom.xml
+++ b/pom.xml
@@ -650,10 +650,6 @@ under the License.
<reports>
<report>aggregate</report>
</reports>
- <configuration>
- <!-- There's no maintenance on maven-compat -->
- <additionalparam>-Xdoclint:none</additionalparam>
- </configuration>
</reportSet>
</reportSets>
</plugin>