Author: hboutemy
Date: Thu Sep 22 22:25:17 2011
New Revision: 1174427
URL: http://svn.apache.org/viewvc?rev=1174427&view=rev
Log:
improved javadoc
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyVisitor.java
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.java
Thu Sep 22 22:25:17 2011
@@ -24,7 +24,7 @@ import java.net.URL;
import java.util.Set;
/**
- *
+ * Gets the set of classes contained in a library given either as a jar file
or an exploded directory.
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @version $Id$
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ClassFileVisitorUtils.java
Thu Sep 22 22:25:17 2011
@@ -32,7 +32,7 @@ import java.util.jar.JarInputStream;
import org.codehaus.plexus.util.DirectoryScanner;
/**
- *
+ * Utility to visit classes in a library given either as a jar file or an
exploded directory.
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @version $Id$
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/CollectorClassFileVisitor.java
Thu Sep 22 22:25:17 2011
@@ -24,10 +24,11 @@ import java.util.HashSet;
import java.util.Set;
/**
- *
+ * Simply collects the set of visited classes.
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @version $Id$
+ * @see #getClasses()
*/
public class CollectorClassFileVisitor
implements ClassFileVisitor
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DefaultClassAnalyzer.java
Thu Sep 22 22:25:17 2011
@@ -36,9 +36,6 @@ public class DefaultClassAnalyzer
{
// ClassAnalyzer methods --------------------------------------------------
- /*
- * @see
org.apache.maven.shared.dependency.analyzer.ClassAnalyzer#analyze(java.net.URL)
- */
public Set<String> analyze( URL url )
throws IOException
{
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/DependencyAnalyzer.java
Thu Sep 22 22:25:17 2011
@@ -24,7 +24,7 @@ import java.net.URL;
import java.util.Set;
/**
- * DependencyAnalyzer
+ * Gets the set of classes referenced by a library given either as a jar file
or an exploded directory.
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @version $Id$
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalysis.java
Thu Sep 22 22:25:17 2011
@@ -26,7 +26,7 @@ import java.util.Set;
import org.apache.maven.artifact.Artifact;
/**
- *
+ * Project dependencies analysis result.
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @version $Id$
@@ -58,16 +58,25 @@ public class ProjectDependencyAnalysis
// public methods ---------------------------------------------------------
+ /**
+ * Used and declared artifacts.
+ */
public Set<Artifact> getUsedDeclaredArtifacts()
{
return usedDeclaredArtifacts;
}
+ /**
+ * Used but not declared artifacts.
+ */
public Set<Artifact> getUsedUndeclaredArtifacts()
{
return usedUndeclaredArtifacts;
}
+ /**
+ * Unused but declared artifacts.
+ */
public Set<Artifact> getUnusedDeclaredArtifacts()
{
return unusedDeclaredArtifacts;
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.java
Thu Sep 22 22:25:17 2011
@@ -22,7 +22,12 @@ package org.apache.maven.shared.dependen
import org.apache.maven.project.MavenProject;
/**
- *
+ * Analyze a project's declared dependencies and effective classes used to
find which artifacts are:
+ * <ul>
+ * <li>used and declared,</li>
+ * <li>used but not declared,</li>
+ * <li>not used but declared.</li>
+ * </ul>
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @version $Id$
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyClassFileVisitor.java
Thu Sep 22 22:25:17 2011
@@ -28,10 +28,12 @@ import org.apache.maven.shared.dependenc
import org.objectweb.asm.ClassReader;
/**
- *
+ * Computes the set of classes referenced by visited class files, using
+ * <a href="DependencyVisitor.html">DependencyVisitor</a>.
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @version $Id$
+ * @see #getDependencies()
*/
public class DependencyClassFileVisitor
implements ClassFileVisitor
@@ -78,6 +80,10 @@ public class DependencyClassFileVisitor
// public methods ---------------------------------------------------------
+ /**
+ *
+ * @return the set of classes referenced by visited class files
+ */
public Set<String> getDependencies()
{
return dependencies;
Modified:
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyVisitor.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyVisitor.java?rev=1174427&r1=1174426&r2=1174427&view=diff
==============================================================================
---
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyVisitor.java
(original)
+++
maven/shared/trunk/maven-dependency-analyzer/src/main/java/org/apache/maven/shared/dependency/analyzer/asm/DependencyVisitor.java
Thu Sep 22 22:25:17 2011
@@ -33,10 +33,12 @@ import org.objectweb.asm.signature.Signa
import org.objectweb.asm.signature.SignatureVisitor;
/**
+ * Computes the set of classes referenced by visited code.
* Inspired by <code>org.objectweb.asm.depend.DependencyVisitor</code> in the
ASM dependencies example.
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @version $Id$
+ * @see #getClasses()
*/
public class DependencyVisitor
implements AnnotationVisitor, SignatureVisitor, ClassVisitor,
FieldVisitor, MethodVisitor
