From 0e1aca2c28858ac1ad77ef40f704ec1b610c9d65 Mon Sep 17 00:00:00 2001
From: Matthew Farwell
Date: Fri, 1 Jun 2012 20:55:02 +0200
Subject: [PATCH 1/2] Fixes #67 no since javadoc
---
src/main/java/org/junit/After.java | 1 +
src/main/java/org/junit/AfterClass.java | 1 +
src/main/java/org/junit/Assert.java | 1 +
src/main/java/org/junit/Assume.java | 1 +
src/main/java/org/junit/Before.java | 1 +
src/main/java/org/junit/BeforeClass.java | 1 +
src/main/java/org/junit/ClassRule.java | 1 +
src/main/java/org/junit/ComparisonFailure.java | 1 +
src/main/java/org/junit/FixMethodOrder.java | 1 +
src/main/java/org/junit/Ignore.java | 1 +
src/main/java/org/junit/Rule.java | 1 +
src/main/java/org/junit/Test.java | 1 +
src/main/java/org/junit/matchers/JUnitMatchers.java | 1 +
src/main/java/org/junit/rules/ErrorCollector.java | 2 ++
src/main/java/org/junit/rules/ExpectedException.java | 1 +
src/main/java/org/junit/rules/ExternalResource.java | 1 +
src/main/java/org/junit/rules/MethodRule.java | 1 +
src/main/java/org/junit/rules/RuleChain.java | 2 ++
src/main/java/org/junit/rules/RunRules.java | 1 +
src/main/java/org/junit/rules/TemporaryFolder.java | 1 +
src/main/java/org/junit/rules/TestName.java | 1 +
src/main/java/org/junit/rules/TestRule.java | 1 +
src/main/java/org/junit/rules/TestWatcher.java | 1 +
src/main/java/org/junit/rules/TestWatchman.java | 1 +
src/main/java/org/junit/rules/Timeout.java | 2 ++
src/main/java/org/junit/rules/Verifier.java | 1 +
src/main/java/org/junit/runner/Computer.java | 1 +
src/main/java/org/junit/runner/Describable.java | 1 +
src/main/java/org/junit/runner/Description.java | 1 +
src/main/java/org/junit/runner/JUnitCore.java | 1 +
src/main/java/org/junit/runner/Request.java | 1 +
src/main/java/org/junit/runner/Result.java | 1 +
src/main/java/org/junit/runner/RunWith.java | 1 +
src/main/java/org/junit/runner/Runner.java | 1 +
src/main/java/org/junit/runner/manipulation/Filter.java | 1 +
src/main/java/org/junit/runner/manipulation/Filterable.java | 1 +
.../junit/runner/manipulation/NoTestsRemainException.java | 1 +
src/main/java/org/junit/runner/manipulation/Sortable.java | 1 +
src/main/java/org/junit/runner/manipulation/Sorter.java | 2 +-
src/main/java/org/junit/runner/notification/Failure.java | 1 +
src/main/java/org/junit/runner/notification/RunListener.java | 1 +
src/main/java/org/junit/runner/notification/RunNotifier.java | 1 +
.../junit/runner/notification/StoppedByUserException.java | 1 +
src/main/java/org/junit/runners/AllTests.java | 1 +
src/main/java/org/junit/runners/BlockJUnit4ClassRunner.java | 1 +
src/main/java/org/junit/runners/JUnit4.java | 1 +
src/main/java/org/junit/runners/MethodSorters.java | 1 +
src/main/java/org/junit/runners/Parameterized.java | 1 +
src/main/java/org/junit/runners/ParentRunner.java | 1 +
src/main/java/org/junit/runners/Suite.java | 1 +
src/main/java/org/junit/runners/model/FrameworkField.java | 1 +
src/main/java/org/junit/runners/model/FrameworkMember.java | 5 +++++
src/main/java/org/junit/runners/model/FrameworkMethod.java | 1 +
.../java/org/junit/runners/model/InitializationError.java | 1 +
.../org/junit/runners/model/MultipleFailureException.java | 1 +
src/main/java/org/junit/runners/model/RunnerBuilder.java | 1 +
src/main/java/org/junit/runners/model/RunnerScheduler.java | 1 +
src/main/java/org/junit/runners/model/Statement.java | 2 ++
src/main/java/org/junit/runners/model/TestClass.java | 1 +
59 files changed, 67 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/junit/After.java b/src/main/java/org/junit/After.java
index 39aa6e56d14a..82a12bc351a3 100644
--- a/src/main/java/org/junit/After.java
+++ b/src/main/java/org/junit/After.java
@@ -31,6 +31,7 @@
*
* @see org.junit.Before
* @see org.junit.Test
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
diff --git a/src/main/java/org/junit/AfterClass.java b/src/main/java/org/junit/AfterClass.java
index 2d6bc80ac42e..5ebb7af0afea 100644
--- a/src/main/java/org/junit/AfterClass.java
+++ b/src/main/java/org/junit/AfterClass.java
@@ -34,6 +34,7 @@
*
* @see org.junit.BeforeClass
* @see org.junit.Test
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
diff --git a/src/main/java/org/junit/Assert.java b/src/main/java/org/junit/Assert.java
index aa47acc0b146..a15223c7eb1c 100644
--- a/src/main/java/org/junit/Assert.java
+++ b/src/main/java/org/junit/Assert.java
@@ -20,6 +20,7 @@
*
*
* @see AssertionError
+ * @since 4.0
*/
public class Assert {
/**
diff --git a/src/main/java/org/junit/Assume.java b/src/main/java/org/junit/Assume.java
index 7b6c21a823e5..4b33a0651329 100644
--- a/src/main/java/org/junit/Assume.java
+++ b/src/main/java/org/junit/Assume.java
@@ -29,6 +29,7 @@
* ...
* assumeTrue(...);
*
+ * @since 4.4
*/
public class Assume {
/**
diff --git a/src/main/java/org/junit/Before.java b/src/main/java/org/junit/Before.java
index 66b34eeb09e4..78062ab512ee 100644
--- a/src/main/java/org/junit/Before.java
+++ b/src/main/java/org/junit/Before.java
@@ -31,6 +31,7 @@
*
* @see org.junit.BeforeClass
* @see org.junit.After
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
diff --git a/src/main/java/org/junit/BeforeClass.java b/src/main/java/org/junit/BeforeClass.java
index 35b785496272..7e77633a336a 100644
--- a/src/main/java/org/junit/BeforeClass.java
+++ b/src/main/java/org/junit/BeforeClass.java
@@ -28,6 +28,7 @@
* }
*
* @see org.junit.AfterClass
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
diff --git a/src/main/java/org/junit/ClassRule.java b/src/main/java/org/junit/ClassRule.java
index feeab14ba770..96988d95ee89 100644
--- a/src/main/java/org/junit/ClassRule.java
+++ b/src/main/java/org/junit/ClassRule.java
@@ -79,6 +79,7 @@
*
*
* For more information and more examples, see {@link org.junit.rules.TestRule}.
+ * @since 4.9
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
diff --git a/src/main/java/org/junit/ComparisonFailure.java b/src/main/java/org/junit/ComparisonFailure.java
index d37db4fc3af1..b3a5c992aa6e 100644
--- a/src/main/java/org/junit/ComparisonFailure.java
+++ b/src/main/java/org/junit/ComparisonFailure.java
@@ -6,6 +6,7 @@
* strings.
*
* Inspired by a patch from Alex Chaffee (alex@purpletech.com)
+ * @since 4.0
*/
public class ComparisonFailure extends AssertionError {
/**
diff --git a/src/main/java/org/junit/FixMethodOrder.java b/src/main/java/org/junit/FixMethodOrder.java
index 46da0e77a314..59fe3446d043 100644
--- a/src/main/java/org/junit/FixMethodOrder.java
+++ b/src/main/java/org/junit/FixMethodOrder.java
@@ -30,6 +30,7 @@
*
*
* @see org.junit.runners.MethodSorters
+ * @since 4.11
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
diff --git a/src/main/java/org/junit/Ignore.java b/src/main/java/org/junit/Ignore.java
index de530a969b66..b25816d7e73d 100644
--- a/src/main/java/org/junit/Ignore.java
+++ b/src/main/java/org/junit/Ignore.java
@@ -28,6 +28,7 @@
* }
*
*
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
diff --git a/src/main/java/org/junit/Rule.java b/src/main/java/org/junit/Rule.java
index 0f0d08364200..161f9926c780 100644
--- a/src/main/java/org/junit/Rule.java
+++ b/src/main/java/org/junit/Rule.java
@@ -62,6 +62,7 @@
* Note: for backwards compatibility, this annotation may also mark
* fields or methods of type {@link org.junit.rules.MethodRule}, which will be honored. However,
* this is a deprecated interface and feature.
+ * @since 4.7
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
diff --git a/src/main/java/org/junit/Test.java b/src/main/java/org/junit/Test.java
index 23dc78ae7e8d..4fc4df8b59a2 100644
--- a/src/main/java/org/junit/Test.java
+++ b/src/main/java/org/junit/Test.java
@@ -41,6 +41,7 @@
* while(true);
* }
*
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
diff --git a/src/main/java/org/junit/matchers/JUnitMatchers.java b/src/main/java/org/junit/matchers/JUnitMatchers.java
index d22db093d4e3..27a337405cbd 100644
--- a/src/main/java/org/junit/matchers/JUnitMatchers.java
+++ b/src/main/java/org/junit/matchers/JUnitMatchers.java
@@ -10,6 +10,7 @@
/**
* Convenience import class: these are useful matchers for use with the assertThat method, but they are
* not currently included in the basic CoreMatchers class from hamcrest.
+ * @since 4.4
*/
public class JUnitMatchers {
/**
diff --git a/src/main/java/org/junit/rules/ErrorCollector.java b/src/main/java/org/junit/rules/ErrorCollector.java
index 3522a654f415..f8dc8c4a5484 100644
--- a/src/main/java/org/junit/rules/ErrorCollector.java
+++ b/src/main/java/org/junit/rules/ErrorCollector.java
@@ -1,5 +1,6 @@
/**
*
+ * @since 4.7
*/
package org.junit.rules;
@@ -31,6 +32,7 @@
* }
* }
*
+ * @since 4.7
*/
public class ErrorCollector extends Verifier {
private List errors= new ArrayList();
diff --git a/src/main/java/org/junit/rules/ExpectedException.java b/src/main/java/org/junit/rules/ExpectedException.java
index 2ee8bd5c7217..da5c79f21512 100644
--- a/src/main/java/org/junit/rules/ExpectedException.java
+++ b/src/main/java/org/junit/rules/ExpectedException.java
@@ -78,6 +78,7 @@
* }
* }
*
+ * @since 4.7
*/
public class ExpectedException implements TestRule {
/**
diff --git a/src/main/java/org/junit/rules/ExternalResource.java b/src/main/java/org/junit/rules/ExternalResource.java
index 1fe371936388..75e9386b80a5 100644
--- a/src/main/java/org/junit/rules/ExternalResource.java
+++ b/src/main/java/org/junit/rules/ExternalResource.java
@@ -31,6 +31,7 @@
* }
* }
*
+ * @since 4.7
*/
public abstract class ExternalResource implements TestRule {
public Statement apply(Statement base, Description description) {
diff --git a/src/main/java/org/junit/rules/MethodRule.java b/src/main/java/org/junit/rules/MethodRule.java
index 1f57c6dd8a38..1865f841fc65 100644
--- a/src/main/java/org/junit/rules/MethodRule.java
+++ b/src/main/java/org/junit/rules/MethodRule.java
@@ -25,6 +25,7 @@
*
*
* Note that {@link MethodRule} is now deprecated, you should be using {@link TestRule} instead.
+ * @since 4.7
*/
@Deprecated
public interface MethodRule {
diff --git a/src/main/java/org/junit/rules/RuleChain.java b/src/main/java/org/junit/rules/RuleChain.java
index 8af3c0571f3d..f92873865a74 100644
--- a/src/main/java/org/junit/rules/RuleChain.java
+++ b/src/main/java/org/junit/rules/RuleChain.java
@@ -1,5 +1,6 @@
/**
*
+ * @since 4.10
*/
package org.junit.rules;
@@ -40,6 +41,7 @@
* finished middle rule
* finished outer rule
*
+ * @since 4.10
*/
public class RuleChain implements TestRule {
private static final RuleChain EMPTY_CHAIN= new RuleChain(
diff --git a/src/main/java/org/junit/rules/RunRules.java b/src/main/java/org/junit/rules/RunRules.java
index d5905b94df0c..29f98146a379 100644
--- a/src/main/java/org/junit/rules/RunRules.java
+++ b/src/main/java/org/junit/rules/RunRules.java
@@ -5,6 +5,7 @@
/**
* Runs a collection of rules on a statement.
+ * @since 4.9
*/
public class RunRules extends Statement {
private final Statement statement;
diff --git a/src/main/java/org/junit/rules/TemporaryFolder.java b/src/main/java/org/junit/rules/TemporaryFolder.java
index b331f284a210..1e7d3941fc03 100644
--- a/src/main/java/org/junit/rules/TemporaryFolder.java
+++ b/src/main/java/org/junit/rules/TemporaryFolder.java
@@ -23,6 +23,7 @@
* }
* }
*
+ * @since 4.7
*/
public class TemporaryFolder extends ExternalResource {
private final File parentFolder;
diff --git a/src/main/java/org/junit/rules/TestName.java b/src/main/java/org/junit/rules/TestName.java
index c4ab9ced0926..c1fd0800f2a7 100644
--- a/src/main/java/org/junit/rules/TestName.java
+++ b/src/main/java/org/junit/rules/TestName.java
@@ -21,6 +21,7 @@
* }
* }
*
+ * @since 4.7
*/
public class TestName extends TestWatcher {
private String fName;
diff --git a/src/main/java/org/junit/rules/TestRule.java b/src/main/java/org/junit/rules/TestRule.java
index b7760c4f91e8..40404bc7ec1e 100644
--- a/src/main/java/org/junit/rules/TestRule.java
+++ b/src/main/java/org/junit/rules/TestRule.java
@@ -39,6 +39,7 @@
* {@link Timeout}: cause test to fail after a set time
* {@link Verifier}: fail test if object state ends up incorrect
*
+ * @since 4.9
*/
public interface TestRule {
/**
diff --git a/src/main/java/org/junit/rules/TestWatcher.java b/src/main/java/org/junit/rules/TestWatcher.java
index 55f38b3f8ee9..7d9d59baa96f 100644
--- a/src/main/java/org/junit/rules/TestWatcher.java
+++ b/src/main/java/org/junit/rules/TestWatcher.java
@@ -36,6 +36,7 @@
* }
* }
*
+ * @since 4.9
*/
public abstract class TestWatcher implements TestRule {
public Statement apply(final Statement base, final Description description) {
diff --git a/src/main/java/org/junit/rules/TestWatchman.java b/src/main/java/org/junit/rules/TestWatchman.java
index 15daa6419373..1f6b790f4a1e 100644
--- a/src/main/java/org/junit/rules/TestWatchman.java
+++ b/src/main/java/org/junit/rules/TestWatchman.java
@@ -40,6 +40,7 @@
*
* @deprecated {@link MethodRule} is deprecated.
* Use {@link TestWatcher} implements {@link TestRule} instead.
+ * @since 4.7
*/
@Deprecated
public class TestWatchman implements MethodRule {
diff --git a/src/main/java/org/junit/rules/Timeout.java b/src/main/java/org/junit/rules/Timeout.java
index 0f1e1bb8b4dd..417ab34a5419 100644
--- a/src/main/java/org/junit/rules/Timeout.java
+++ b/src/main/java/org/junit/rules/Timeout.java
@@ -1,5 +1,6 @@
/**
*
+ * @since 4.7
*/
package org.junit.rules;
@@ -32,6 +33,7 @@
* }
* }
*
+ * @since 4.7
*/
public class Timeout implements TestRule {
private final int fMillis;
diff --git a/src/main/java/org/junit/rules/Verifier.java b/src/main/java/org/junit/rules/Verifier.java
index 25b3ccdebf94..4ff228fca6d6 100644
--- a/src/main/java/org/junit/rules/Verifier.java
+++ b/src/main/java/org/junit/rules/Verifier.java
@@ -24,6 +24,7 @@
* }
* }
*
+ * @since 4.7
*/
public abstract class Verifier implements TestRule {
public Statement apply(final Statement base, Description description) {
diff --git a/src/main/java/org/junit/runner/Computer.java b/src/main/java/org/junit/runner/Computer.java
index 939f70200a64..93146f0e1623 100644
--- a/src/main/java/org/junit/runner/Computer.java
+++ b/src/main/java/org/junit/runner/Computer.java
@@ -8,6 +8,7 @@
* Represents a strategy for computing runners and suites.
* WARNING: this class is very likely to undergo serious changes in version 4.8 and
* beyond.
+ * @since 4.6
*/
public class Computer {
/**
diff --git a/src/main/java/org/junit/runner/Describable.java b/src/main/java/org/junit/runner/Describable.java
index e59cc013b6e6..6d023f27f4e7 100644
--- a/src/main/java/org/junit/runner/Describable.java
+++ b/src/main/java/org/junit/runner/Describable.java
@@ -3,6 +3,7 @@
/**
* Represents an object that can describe itself
+ * @since 4.5
*/
public interface Describable {
/**
diff --git a/src/main/java/org/junit/runner/Description.java b/src/main/java/org/junit/runner/Description.java
index 97815e9aaf12..cde1e966c4ff 100644
--- a/src/main/java/org/junit/runner/Description.java
+++ b/src/main/java/org/junit/runner/Description.java
@@ -24,6 +24,7 @@
*
* @see org.junit.runner.Request
* @see org.junit.runner.Runner
+ * @since 4.0
*/
public class Description implements Serializable {
private static final long serialVersionUID = 1L;
diff --git a/src/main/java/org/junit/runner/JUnitCore.java b/src/main/java/org/junit/runner/JUnitCore.java
index ba3dd154abc5..d70f03606f13 100644
--- a/src/main/java/org/junit/runner/JUnitCore.java
+++ b/src/main/java/org/junit/runner/JUnitCore.java
@@ -23,6 +23,7 @@
* @see org.junit.runner.Result
* @see org.junit.runner.notification.RunListener
* @see org.junit.runner.Request
+ * @since 4.0
*/
public class JUnitCore {
private final RunNotifier fNotifier= new RunNotifier();
diff --git a/src/main/java/org/junit/runner/Request.java b/src/main/java/org/junit/runner/Request.java
index 310b915be551..dbdb3896edbc 100644
--- a/src/main/java/org/junit/runner/Request.java
+++ b/src/main/java/org/junit/runner/Request.java
@@ -21,6 +21,7 @@
* a {@link org.junit.runner.Runner} is created for each class implied by the Request
->
* the {@link org.junit.runner.Runner} returns a detailed {@link org.junit.runner.Description}
* which is a tree structure of the tests to be run.
+ * @since 4.0
*/
public abstract class Request {
/**
diff --git a/src/main/java/org/junit/runner/Result.java b/src/main/java/org/junit/runner/Result.java
index 4856c803369c..6b2a5d1f46d8 100644
--- a/src/main/java/org/junit/runner/Result.java
+++ b/src/main/java/org/junit/runner/Result.java
@@ -12,6 +12,7 @@
/**
* A Result
collects and summarizes information from running multiple tests.
* All tests are counted -- additional information is collected from tests that fail.
+ * @since 4.0
*/
public class Result implements Serializable {
private static final long serialVersionUID = 1L;
diff --git a/src/main/java/org/junit/runner/RunWith.java b/src/main/java/org/junit/runner/RunWith.java
index 602edf097208..20fd23c3785f 100644
--- a/src/main/java/org/junit/runner/RunWith.java
+++ b/src/main/java/org/junit/runner/RunWith.java
@@ -22,6 +22,7 @@
* public class ABCSuite {
* }
*
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
diff --git a/src/main/java/org/junit/runner/Runner.java b/src/main/java/org/junit/runner/Runner.java
index 39e424f83ac7..c7b8a6bffc20 100644
--- a/src/main/java/org/junit/runner/Runner.java
+++ b/src/main/java/org/junit/runner/Runner.java
@@ -17,6 +17,7 @@
*
* @see org.junit.runner.Description
* @see org.junit.runner.RunWith
+ * @since 4.0
*/
public abstract class Runner implements Describable {
/* (non-Javadoc)
diff --git a/src/main/java/org/junit/runner/manipulation/Filter.java b/src/main/java/org/junit/runner/manipulation/Filter.java
index c0f31b0b40c4..7cefde382757 100644
--- a/src/main/java/org/junit/runner/manipulation/Filter.java
+++ b/src/main/java/org/junit/runner/manipulation/Filter.java
@@ -11,6 +11,7 @@
* {@link org.junit.runner.JUnitCore#run(Request)}. Alternatively, apply a Filter
to
* a {@link org.junit.runner.Runner} before running tests (for example, in conjunction with
* {@link org.junit.runner.RunWith}.
+ * @since 4.0
*/
public abstract class Filter {
/**
diff --git a/src/main/java/org/junit/runner/manipulation/Filterable.java b/src/main/java/org/junit/runner/manipulation/Filterable.java
index 782c0f709b36..708dcbececc2 100644
--- a/src/main/java/org/junit/runner/manipulation/Filterable.java
+++ b/src/main/java/org/junit/runner/manipulation/Filterable.java
@@ -3,6 +3,7 @@
/**
* Runners that allow filtering should implement this interface. Implement {@link #filter(Filter)}
* to remove tests that don't pass the filter.
+ * @since 4.0
*/
public interface Filterable {
diff --git a/src/main/java/org/junit/runner/manipulation/NoTestsRemainException.java b/src/main/java/org/junit/runner/manipulation/NoTestsRemainException.java
index 03fb3bf6edca..ae2743704cd8 100644
--- a/src/main/java/org/junit/runner/manipulation/NoTestsRemainException.java
+++ b/src/main/java/org/junit/runner/manipulation/NoTestsRemainException.java
@@ -2,6 +2,7 @@
/**
* Thrown when a filter removes all tests from a runner.
+ * @since 4.0
*/
public class NoTestsRemainException extends Exception {
private static final long serialVersionUID = 1L;
diff --git a/src/main/java/org/junit/runner/manipulation/Sortable.java b/src/main/java/org/junit/runner/manipulation/Sortable.java
index fec1d0cd6432..85f169c3541c 100644
--- a/src/main/java/org/junit/runner/manipulation/Sortable.java
+++ b/src/main/java/org/junit/runner/manipulation/Sortable.java
@@ -5,6 +5,7 @@
* failed first, you can reduce the average time to the first test failing. Test sorting should not be used to
* cope with order dependencies between tests. Tests that are isolated from each other are less
* expensive to maintain and can be run individually.
+ * @since 4.0
*/
public interface Sortable {
diff --git a/src/main/java/org/junit/runner/manipulation/Sorter.java b/src/main/java/org/junit/runner/manipulation/Sorter.java
index 242df145cc5d..31e56d7660d2 100644
--- a/src/main/java/org/junit/runner/manipulation/Sorter.java
+++ b/src/main/java/org/junit/runner/manipulation/Sorter.java
@@ -8,7 +8,7 @@
* A Sorter
orders tests. In general you will not need
* to use a Sorter
directly. Instead, use {@link org.junit.runner.Request#sortWith(Comparator)}.
*
- *
+ * @since 4.0
*/
public class Sorter implements Comparator {
/**
diff --git a/src/main/java/org/junit/runner/notification/Failure.java b/src/main/java/org/junit/runner/notification/Failure.java
index 501caa5ed1e0..285a0eca4250 100644
--- a/src/main/java/org/junit/runner/notification/Failure.java
+++ b/src/main/java/org/junit/runner/notification/Failure.java
@@ -12,6 +12,7 @@
* will be of a single test. However, if problems are encountered while constructing the
* test (for example, if a {@link org.junit.BeforeClass} method is not static), it may describe
* something other than a single test.
+ * @since 4.0
*/
public class Failure implements Serializable {
private static final long serialVersionUID = 1L;
diff --git a/src/main/java/org/junit/runner/notification/RunListener.java b/src/main/java/org/junit/runner/notification/RunListener.java
index ffe8134a6d16..8cefc082a1ec 100644
--- a/src/main/java/org/junit/runner/notification/RunListener.java
+++ b/src/main/java/org/junit/runner/notification/RunListener.java
@@ -30,6 +30,7 @@
*
*
* @see org.junit.runner.JUnitCore
+ * @since 4.0
*/
public class RunListener {
diff --git a/src/main/java/org/junit/runner/notification/RunNotifier.java b/src/main/java/org/junit/runner/notification/RunNotifier.java
index e702b464837c..953646e5e151 100644
--- a/src/main/java/org/junit/runner/notification/RunNotifier.java
+++ b/src/main/java/org/junit/runner/notification/RunNotifier.java
@@ -17,6 +17,7 @@
* {@link org.junit.runner.Runner#run(RunNotifier)}. Future evolution of this class is likely to
* move {@link #fireTestRunStarted(Description)} and {@link #fireTestRunFinished(Result)}
* to a separate class since they should only be called once per run.
+ * @since 4.0
*/
public class RunNotifier {
private final List fListeners=
diff --git a/src/main/java/org/junit/runner/notification/StoppedByUserException.java b/src/main/java/org/junit/runner/notification/StoppedByUserException.java
index 89be3ba0b74a..8141fa548841 100644
--- a/src/main/java/org/junit/runner/notification/StoppedByUserException.java
+++ b/src/main/java/org/junit/runner/notification/StoppedByUserException.java
@@ -5,6 +5,7 @@
* test running GUIs should be prepared to catch a StoppedByUserException
.
*
* @see org.junit.runner.notification.RunNotifier
+ * @since 4.0
*/
public class StoppedByUserException extends RuntimeException {
private static final long serialVersionUID= 1L;
diff --git a/src/main/java/org/junit/runners/AllTests.java b/src/main/java/org/junit/runners/AllTests.java
index 50c02db8126b..c695098e445d 100644
--- a/src/main/java/org/junit/runners/AllTests.java
+++ b/src/main/java/org/junit/runners/AllTests.java
@@ -13,6 +13,7 @@
* }
* }
*
+ * @since 4.0
*/
public class AllTests extends SuiteMethod {
/**
diff --git a/src/main/java/org/junit/runners/BlockJUnit4ClassRunner.java b/src/main/java/org/junit/runners/BlockJUnit4ClassRunner.java
index 71770632c535..faab01af3d41 100644
--- a/src/main/java/org/junit/runners/BlockJUnit4ClassRunner.java
+++ b/src/main/java/org/junit/runners/BlockJUnit4ClassRunner.java
@@ -44,6 +44,7 @@
* It is published, and extension and reuse are encouraged, whereas {@code
* JUnit4ClassRunner} was in an internal package, and is now deprecated.
*
+ * @since 4.5
*/
public class BlockJUnit4ClassRunner extends ParentRunner {
/**
diff --git a/src/main/java/org/junit/runners/JUnit4.java b/src/main/java/org/junit/runners/JUnit4.java
index 1e1f3479d322..1f9b5d24ef17 100644
--- a/src/main/java/org/junit/runners/JUnit4.java
+++ b/src/main/java/org/junit/runners/JUnit4.java
@@ -11,6 +11,7 @@
* This is the only way this class should be used--any extension that
* depends on the implementation details of this class is likely to break
* in future versions.
+ * @since 4.5
*/
public final class JUnit4 extends BlockJUnit4ClassRunner {
/**
diff --git a/src/main/java/org/junit/runners/MethodSorters.java b/src/main/java/org/junit/runners/MethodSorters.java
index 3c35659f1861..76a8fb7b9c49 100644
--- a/src/main/java/org/junit/runners/MethodSorters.java
+++ b/src/main/java/org/junit/runners/MethodSorters.java
@@ -8,6 +8,7 @@
/**
* Sort the methods into a specified execution order.
* Defines common {@link MethodSorter} implementations.
+ * @since 4.11
*/
public enum MethodSorters {
/** Sorts the test methods by the method name, in lexicographic order,
diff --git a/src/main/java/org/junit/runners/Parameterized.java b/src/main/java/org/junit/runners/Parameterized.java
index 49b9f0d7cea5..8300a5646104 100644
--- a/src/main/java/org/junit/runners/Parameterized.java
+++ b/src/main/java/org/junit/runners/Parameterized.java
@@ -73,6 +73,7 @@
* names like [1: fib(3)=2]
. If you don't use the name parameter,
* then the current parameter index is used as name.
*
+ * @since 4.0
*/
public class Parameterized extends Suite {
/**
diff --git a/src/main/java/org/junit/runners/ParentRunner.java b/src/main/java/org/junit/runners/ParentRunner.java
index 1fef7607a80d..c3efa5b5c3a0 100644
--- a/src/main/java/org/junit/runners/ParentRunner.java
+++ b/src/main/java/org/junit/runners/ParentRunner.java
@@ -47,6 +47,7 @@
* {@code @BeforeClass} and {@code @AfterClass} methods,
* handle annotated {@link ClassRule}s, create a composite
* {@link Description}, and run children sequentially.
+ * @since 4.5
*/
public abstract class ParentRunner extends Runner implements Filterable,
Sortable {
diff --git a/src/main/java/org/junit/runners/Suite.java b/src/main/java/org/junit/runners/Suite.java
index 1b3bb4816ba0..5b10cdb32e68 100644
--- a/src/main/java/org/junit/runners/Suite.java
+++ b/src/main/java/org/junit/runners/Suite.java
@@ -20,6 +20,7 @@
* static {@link junit.framework.Test} suite()
method. To use it, annotate a class
* with @RunWith(Suite.class)
and @SuiteClasses({TestClass1.class, ...})
.
* When you run this class, it will run all the tests in all the suite classes.
+ * @since 4.0
*/
public class Suite extends ParentRunner {
/**
diff --git a/src/main/java/org/junit/runners/model/FrameworkField.java b/src/main/java/org/junit/runners/model/FrameworkField.java
index 8b4bae11c5de..c95c88a2b76c 100644
--- a/src/main/java/org/junit/runners/model/FrameworkField.java
+++ b/src/main/java/org/junit/runners/model/FrameworkField.java
@@ -9,6 +9,7 @@
/**
* Represents a field on a test class (currently used only for Rules in
* {@link BlockJUnit4ClassRunner}, but custom runners can make other uses)
+ * @since 4.7
*/
public class FrameworkField extends FrameworkMember {
private final Field fField;
diff --git a/src/main/java/org/junit/runners/model/FrameworkMember.java b/src/main/java/org/junit/runners/model/FrameworkMember.java
index 7ff365c7a14b..51914af0fd47 100644
--- a/src/main/java/org/junit/runners/model/FrameworkMember.java
+++ b/src/main/java/org/junit/runners/model/FrameworkMember.java
@@ -3,6 +3,11 @@
import java.lang.annotation.Annotation;
import java.util.List;
+/**
+ * Parent class for {@link FrameworkField} and {@link FrameworkMethod}
+ *
+ * @since 4.7
+ */
public abstract class FrameworkMember> {
/**
* Returns the annotations on this method
diff --git a/src/main/java/org/junit/runners/model/FrameworkMethod.java b/src/main/java/org/junit/runners/model/FrameworkMethod.java
index 7614d604d89f..5f3bc2773b19 100644
--- a/src/main/java/org/junit/runners/model/FrameworkMethod.java
+++ b/src/main/java/org/junit/runners/model/FrameworkMethod.java
@@ -14,6 +14,7 @@
* test execution. These methods are usually marked with an annotation (such as
* {@code @Test}, {@code @Before}, {@code @After}, {@code @BeforeClass},
* {@code @AfterClass}, etc.)
+ * @since 4.5
*/
public class FrameworkMethod extends FrameworkMember {
final Method fMethod;
diff --git a/src/main/java/org/junit/runners/model/InitializationError.java b/src/main/java/org/junit/runners/model/InitializationError.java
index 4de9ea74dc3a..d17576df37d3 100644
--- a/src/main/java/org/junit/runners/model/InitializationError.java
+++ b/src/main/java/org/junit/runners/model/InitializationError.java
@@ -5,6 +5,7 @@
/**
* Represents one or more problems encountered while initializing a Runner
+ * @since 4.5
*/
public class InitializationError extends Exception {
private static final long serialVersionUID= 1L;
diff --git a/src/main/java/org/junit/runners/model/MultipleFailureException.java b/src/main/java/org/junit/runners/model/MultipleFailureException.java
index 6d70ca0ac0bd..566197fd7017 100644
--- a/src/main/java/org/junit/runners/model/MultipleFailureException.java
+++ b/src/main/java/org/junit/runners/model/MultipleFailureException.java
@@ -8,6 +8,7 @@
/**
* Collects multiple {@code Throwable}s into one exception.
+ * @since 4.9
*/
public class MultipleFailureException extends Exception {
private static final long serialVersionUID= 1L;
diff --git a/src/main/java/org/junit/runners/model/RunnerBuilder.java b/src/main/java/org/junit/runners/model/RunnerBuilder.java
index 3a334be7280d..2b552d995b2c 100644
--- a/src/main/java/org/junit/runners/model/RunnerBuilder.java
+++ b/src/main/java/org/junit/runners/model/RunnerBuilder.java
@@ -34,6 +34,7 @@
*
*
* @see org.junit.runners.Suite
+ * @since 4.5
*/
public abstract class RunnerBuilder {
private final Set> parents= new HashSet>();
diff --git a/src/main/java/org/junit/runners/model/RunnerScheduler.java b/src/main/java/org/junit/runners/model/RunnerScheduler.java
index fbc25a4a6b6c..6e33145037a9 100644
--- a/src/main/java/org/junit/runners/model/RunnerScheduler.java
+++ b/src/main/java/org/junit/runners/model/RunnerScheduler.java
@@ -5,6 +5,7 @@
* should be run (in serial or parallel)
*
* WARNING: still experimental, may go away.
+ * @since 4.7
*/
public interface RunnerScheduler {
/**
diff --git a/src/main/java/org/junit/runners/model/Statement.java b/src/main/java/org/junit/runners/model/Statement.java
index a7c547851a07..45575bffbc22 100644
--- a/src/main/java/org/junit/runners/model/Statement.java
+++ b/src/main/java/org/junit/runners/model/Statement.java
@@ -1,5 +1,6 @@
/**
*
+ * @since 4.5
*/
package org.junit.runners.model;
@@ -7,6 +8,7 @@
/**
* Represents one or more actions to be taken at runtime in the course
* of running a JUnit test suite.
+ * @since 4.5
*/
public abstract class Statement {
/**
diff --git a/src/main/java/org/junit/runners/model/TestClass.java b/src/main/java/org/junit/runners/model/TestClass.java
index f4cf0eadb12c..b25eb8d077d9 100644
--- a/src/main/java/org/junit/runners/model/TestClass.java
+++ b/src/main/java/org/junit/runners/model/TestClass.java
@@ -18,6 +18,7 @@
/**
* Wraps a class to be run, providing method validation and annotation searching
+ * @since 4.5
*/
public class TestClass {
private final Class> fClass;
From caefa620d3a82613461420987fe8a88fc1e6f988 Mon Sep 17 00:00:00 2001
From: Matthew Farwell
Date: Fri, 1 Jun 2012 21:20:25 +0200
Subject: [PATCH 2/2] Fixes #67 no since javadoc
---
src/main/java/org/junit/rules/ErrorCollector.java | 4 ----
src/main/java/org/junit/rules/RuleChain.java | 4 ----
src/main/java/org/junit/rules/Timeout.java | 4 ----
src/main/java/org/junit/runners/model/Statement.java | 4 ----
4 files changed, 16 deletions(-)
diff --git a/src/main/java/org/junit/rules/ErrorCollector.java b/src/main/java/org/junit/rules/ErrorCollector.java
index f8dc8c4a5484..6e575b421625 100644
--- a/src/main/java/org/junit/rules/ErrorCollector.java
+++ b/src/main/java/org/junit/rules/ErrorCollector.java
@@ -1,7 +1,3 @@
-/**
- *
- * @since 4.7
- */
package org.junit.rules;
import static org.junit.Assert.assertThat;
diff --git a/src/main/java/org/junit/rules/RuleChain.java b/src/main/java/org/junit/rules/RuleChain.java
index f92873865a74..a5564cc568e6 100644
--- a/src/main/java/org/junit/rules/RuleChain.java
+++ b/src/main/java/org/junit/rules/RuleChain.java
@@ -1,7 +1,3 @@
-/**
- *
- * @since 4.10
- */
package org.junit.rules;
import java.util.ArrayList;
diff --git a/src/main/java/org/junit/rules/Timeout.java b/src/main/java/org/junit/rules/Timeout.java
index 417ab34a5419..d78421717660 100644
--- a/src/main/java/org/junit/rules/Timeout.java
+++ b/src/main/java/org/junit/rules/Timeout.java
@@ -1,7 +1,3 @@
-/**
- *
- * @since 4.7
- */
package org.junit.rules;
import org.junit.internal.runners.statements.FailOnTimeout;
diff --git a/src/main/java/org/junit/runners/model/Statement.java b/src/main/java/org/junit/runners/model/Statement.java
index 45575bffbc22..f85827465517 100644
--- a/src/main/java/org/junit/runners/model/Statement.java
+++ b/src/main/java/org/junit/runners/model/Statement.java
@@ -1,7 +1,3 @@
-/**
- *
- * @since 4.5
- */
package org.junit.runners.model;