Author: krosenvold
Date: Wed Jan 26 22:03:44 2011
New Revision: 1063891
URL: http://svn.apache.org/viewvc?rev=1063891&view=rev
Log:
o Cleaned up javadoc
Modified:
maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/providerapi/SurefireProvider.java
maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/ReporterFactory.java
maven/surefire/trunk/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java
Modified:
maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/providerapi/SurefireProvider.java
URL:
http://svn.apache.org/viewvc/maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/providerapi/SurefireProvider.java?rev=1063891&r1=1063890&r2=1063891&view=diff
==============================================================================
---
maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/providerapi/SurefireProvider.java
(original)
+++
maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/providerapi/SurefireProvider.java
Wed Jan 26 22:03:44 2011
@@ -45,17 +45,20 @@ import java.util.Iterator;
public interface SurefireProvider
{
/**
- * Called when forkmode is pertest, allows the provider to define what
"pertest" will be.
+ * Determines the number of forks.
+ *
+ * Called when forkmode is different from "never" or "always", allows the
provider to define
+ * how to behave for the fork.
*
* @return An iterator that will trigger one fork per item
*/
Iterator getSuites();
/**
- * The test that will be invoked through a fork; used only for
forkmode=pertest, when the classpath
- * scanning happens on the plugin-side. When this is set, the forked
process will run only that test
- * and not scan the classpath
- * @param forkTestSet An item from the iterator in #getSuites
+ * Runs a forked test
+ * @param forkTestSet An item from the iterator in #getSuites. Will be
null for forkmode never or always.
+ * When this is non-null, the forked process will run
only that test
+ * and probably not scan the classpath
* @return A result of the invocation
* @throws org.apache.maven.surefire.report.ReporterException When
reporting fails
* @throws org.apache.maven.surefire.testset.TestSetFailedException When
testset fails
Modified:
maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/ReporterFactory.java
URL:
http://svn.apache.org/viewvc/maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/ReporterFactory.java?rev=1063891&r1=1063890&r2=1063891&view=diff
==============================================================================
---
maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/ReporterFactory.java
(original)
+++
maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/ReporterFactory.java
Wed Jan 26 22:03:44 2011
@@ -29,7 +29,8 @@ public interface ReporterFactory
RunStatistics getGlobalRunStatistics();
/**
- * Creates a (non-thread-safe) reporter
+ * Creates a reporter. The reporter is a singleton that is expected to be
+ * used in the provider.
*
* @return A reporter instance
*/
Modified:
maven/surefire/trunk/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java
URL:
http://svn.apache.org/viewvc/maven/surefire/trunk/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java?rev=1063891&r1=1063890&r2=1063891&view=diff
==============================================================================
---
maven/surefire/trunk/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java
(original)
+++
maven/surefire/trunk/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java
Wed Jan 26 22:03:44 2011
@@ -38,7 +38,7 @@ import org.testng.TestNG;
/**
* Listens for and provides and adaptor layer so that
* TestNG tests can report their status to the current
- * {@link org.apache.maven.surefire.report.ReporterManager}.
+ * {@link org.apache.maven.surefire.report.Reporter}.
*
* @author jkuhnert
* @noinspection ThrowableResultOfMethodCallIgnored
