diff options
| author | Marc R. Hoffmann <hoffmann@mountainminds.com> | 2011-01-25 19:40:16 +0000 |
|---|---|---|
| committer | Marc R. Hoffmann <hoffmann@mountainminds.com> | 2011-01-25 19:40:16 +0000 |
| commit | 456cb13baa8f60eef812864ed5bbe3c5f858cdbb (patch) | |
| tree | bf86afe6d0454ab48287ace305b4e3c55c5261a3 /org.jacoco.core/src/org/jacoco/core/analysis/Analyzer.java | |
| parent | 935a19fa67556dcdd69ad3c173b3ecfcbd6043b5 (diff) | |
| download | jacoco-456cb13baa8f60eef812864ed5bbe3c5f858cdbb.tar.gz | |
Trac #140: API documentation cleanup.
Diffstat (limited to 'org.jacoco.core/src/org/jacoco/core/analysis/Analyzer.java')
| -rw-r--r-- | org.jacoco.core/src/org/jacoco/core/analysis/Analyzer.java | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/org.jacoco.core/src/org/jacoco/core/analysis/Analyzer.java b/org.jacoco.core/src/org/jacoco/core/analysis/Analyzer.java index 4ed791ce..0028f592 100644 --- a/org.jacoco.core/src/org/jacoco/core/analysis/Analyzer.java +++ b/org.jacoco.core/src/org/jacoco/core/analysis/Analyzer.java @@ -30,7 +30,12 @@ import org.objectweb.asm.ClassReader; import org.objectweb.asm.ClassVisitor;
/**
- * Several APIs to analyze class structures.
+ * An {@link Analyzer} instance processes a set of Java class files and
+ * calculates coverage data for them. For each class file the result is reported
+ * to a given {@link ICoverageVisitor} instance. In addition the
+ * {@link Analyzer} requires a {@link ExecutionDataStore} instance that holds
+ * the execution data for the classes to analyze. The {@link Analyzer} offers
+ * several methods to analyze classes from a variety of sources.
*/
public class Analyzer {
|