[java-mvn-enforcer] branch main updated: javadoc

[Rod Widdowson]

This is an automated email from the git hooks/post-receive script.

rdw pushed a commit to branch main
in repository java-mvn-enforcer.

View the commit online:
http://git.shibboleth.net/view/?p=java-mvn-enforcer.git;a=commit;h=2914b18e93837eba239094f17928b51392500adb

The following commit(s) were added to refs/heads/main by this push:
     new 2914b18  javadoc
2914b18 is described below

commit 2914b18e93837eba239094f17928b51392500adb
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Thu Mar 24 15:44:18 2022 +0000

    javadoc
---
 src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java  | 4 ++--
 src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java | 6 +++---
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java b/src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java
index c69f31a..5cba2eb 100644
--- a/src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java
+++ b/src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java
@@ -404,8 +404,8 @@ public class JarEnforcer implements EnforcerRule, MavenLoader{
      * @param version Version
      * @param classifier classifier
      * @param type type
-     * @return a file or null i
-     * @throws Exception
+     * @return a file or null if it could not be resolved
+     * @throws Exception on various issues from the (maven) resolver
      */
     @Nullable public File downloadArtifact(final String groupId, final String artifactId, final String version, final String classifier, final String type) throws Exception {
         final Artifact mavenArtifact = repositorySystem.createArtifactWithClassifier(groupId,artifactId, version, type, classifier);
diff --git a/src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java b/src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java
index 7d3b111..4ec5538 100644
--- a/src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java
+++ b/src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java
@@ -103,9 +103,9 @@ public class M2SigChecker extends BaseSigChecker {
             return result;
         }
 
-        /** Given a path "org/example/extra/artiffactID/version" return the artifact coordinates.
-         * @param path
-         * @return  a pomn artifact
+        /** Given a path "org/example/extra/artifactID/version" return the artifact coordinates.
+         * @param path the path to an artifact. 
+         * @return a suitable {@link PomArtifact}
          */
         private PomArtifact artifactFromPath(Path path) {
             final Path versionDir = path.getParent();

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.