From 5659e497f8322dac3f8838154640c4a2c7f8b896 Mon Sep 17 00:00:00 2001 From: Sander Hautvast Date: Sat, 26 Sep 2015 17:38:33 +0200 Subject: [PATCH] some javadoc --- .../java/nl/jssl/autounit/classanalyser/ClassAnalyser.java | 3 +++ .../nl/jssl/autounit/classanalyser/CoverageAnalyser.java | 5 +++++ .../nl/jssl/autounit/classanalyser/MethodcallExecutor.java | 1 - 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/src/main/java/nl/jssl/autounit/classanalyser/ClassAnalyser.java b/src/main/java/nl/jssl/autounit/classanalyser/ClassAnalyser.java index 0e9b6dc..ff5434c 100644 --- a/src/main/java/nl/jssl/autounit/classanalyser/ClassAnalyser.java +++ b/src/main/java/nl/jssl/autounit/classanalyser/ClassAnalyser.java @@ -8,6 +8,9 @@ import java.util.List; import nl.jssl.autounit.inputs.MethodcallArgumentsFactory; import nl.jssl.autounit.util.LinkedList; +/** + * Analyses the class you want to create tests for. + */ public class ClassAnalyser { private Class testTarget; diff --git a/src/main/java/nl/jssl/autounit/classanalyser/CoverageAnalyser.java b/src/main/java/nl/jssl/autounit/classanalyser/CoverageAnalyser.java index 743db91..6d5ef1f 100644 --- a/src/main/java/nl/jssl/autounit/classanalyser/CoverageAnalyser.java +++ b/src/main/java/nl/jssl/autounit/classanalyser/CoverageAnalyser.java @@ -17,6 +17,11 @@ import org.jacoco.core.runtime.RuntimeData; import nl.jssl.autounit.util.MemoryClassloader; import nl.jssl.autounit.util.SilentObjectCreator; +/** + * When creating tests, increasing coverage indicates a good test. Hence a + * CoverageAnalyser. It uses Jacoco (http://eclemma.org/jacoco/), the java + * interface for eclemma. + */ public class CoverageAnalyser { private final IRuntime runtime; private final RuntimeData data; diff --git a/src/main/java/nl/jssl/autounit/classanalyser/MethodcallExecutor.java b/src/main/java/nl/jssl/autounit/classanalyser/MethodcallExecutor.java index d75285b..cd22ace 100644 --- a/src/main/java/nl/jssl/autounit/classanalyser/MethodcallExecutor.java +++ b/src/main/java/nl/jssl/autounit/classanalyser/MethodcallExecutor.java @@ -8,7 +8,6 @@ import nl.jssl.autounit.util.LinkedList; /** * Executes 1 method using alternating input parameters and yields execution * results. - * */ public class MethodcallExecutor { private T instrumentedTestTarget;