Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #445 from matthewfarwell/67-since2

Fixes #67 no since javadoc
  • Loading branch information...
commit e8b91fa9f797dfe16aff66ed6ad5d6104e5133fe 2 parents c228881 + caefa62
@kcooney kcooney authored
Showing with 63 additions and 13 deletions.
  1. +1 −0  src/main/java/org/junit/After.java
  2. +1 −0  src/main/java/org/junit/AfterClass.java
  3. +1 −0  src/main/java/org/junit/Assert.java
  4. +1 −0  src/main/java/org/junit/Assume.java
  5. +1 −0  src/main/java/org/junit/Before.java
  6. +1 −0  src/main/java/org/junit/BeforeClass.java
  7. +1 −0  src/main/java/org/junit/ClassRule.java
  8. +1 −0  src/main/java/org/junit/ComparisonFailure.java
  9. +1 −0  src/main/java/org/junit/FixMethodOrder.java
  10. +1 −0  src/main/java/org/junit/Ignore.java
  11. +1 −0  src/main/java/org/junit/Rule.java
  12. +1 −0  src/main/java/org/junit/Test.java
  13. +1 −0  src/main/java/org/junit/matchers/JUnitMatchers.java
  14. +1 −3 src/main/java/org/junit/rules/ErrorCollector.java
  15. +1 −0  src/main/java/org/junit/rules/ExpectedException.java
  16. +1 −0  src/main/java/org/junit/rules/ExternalResource.java
  17. +1 −0  src/main/java/org/junit/rules/MethodRule.java
  18. +1 −3 src/main/java/org/junit/rules/RuleChain.java
  19. +1 −0  src/main/java/org/junit/rules/RunRules.java
  20. +1 −0  src/main/java/org/junit/rules/TemporaryFolder.java
  21. +1 −0  src/main/java/org/junit/rules/TestName.java
  22. +1 −0  src/main/java/org/junit/rules/TestRule.java
  23. +1 −0  src/main/java/org/junit/rules/TestWatcher.java
  24. +1 −0  src/main/java/org/junit/rules/TestWatchman.java
  25. +1 −3 src/main/java/org/junit/rules/Timeout.java
  26. +1 −0  src/main/java/org/junit/rules/Verifier.java
  27. +1 −0  src/main/java/org/junit/runner/Computer.java
  28. +1 −0  src/main/java/org/junit/runner/Describable.java
  29. +1 −0  src/main/java/org/junit/runner/Description.java
  30. +1 −0  src/main/java/org/junit/runner/JUnitCore.java
  31. +1 −0  src/main/java/org/junit/runner/Request.java
  32. +1 −0  src/main/java/org/junit/runner/Result.java
  33. +1 −0  src/main/java/org/junit/runner/RunWith.java
  34. +1 −0  src/main/java/org/junit/runner/Runner.java
  35. +1 −0  src/main/java/org/junit/runner/manipulation/Filter.java
  36. +1 −0  src/main/java/org/junit/runner/manipulation/Filterable.java
  37. +1 −0  src/main/java/org/junit/runner/manipulation/NoTestsRemainException.java
  38. +1 −0  src/main/java/org/junit/runner/manipulation/Sortable.java
  39. +1 −1  src/main/java/org/junit/runner/manipulation/Sorter.java
  40. +1 −0  src/main/java/org/junit/runner/notification/Failure.java
  41. +1 −0  src/main/java/org/junit/runner/notification/RunListener.java
  42. +1 −0  src/main/java/org/junit/runner/notification/RunNotifier.java
  43. +1 −0  src/main/java/org/junit/runner/notification/StoppedByUserException.java
  44. +1 −0  src/main/java/org/junit/runners/AllTests.java
  45. +1 −0  src/main/java/org/junit/runners/BlockJUnit4ClassRunner.java
  46. +1 −0  src/main/java/org/junit/runners/JUnit4.java
  47. +1 −0  src/main/java/org/junit/runners/MethodSorters.java
  48. +1 −0  src/main/java/org/junit/runners/Parameterized.java
  49. +1 −0  src/main/java/org/junit/runners/ParentRunner.java
  50. +1 −0  src/main/java/org/junit/runners/Suite.java
  51. +1 −0  src/main/java/org/junit/runners/model/FrameworkField.java
  52. +5 −0 src/main/java/org/junit/runners/model/FrameworkMember.java
  53. +1 −0  src/main/java/org/junit/runners/model/FrameworkMethod.java
  54. +1 −0  src/main/java/org/junit/runners/model/InitializationError.java
  55. +1 −0  src/main/java/org/junit/runners/model/MultipleFailureException.java
  56. +1 −0  src/main/java/org/junit/runners/model/RunnerBuilder.java
  57. +1 −0  src/main/java/org/junit/runners/model/RunnerScheduler.java
  58. +1 −3 src/main/java/org/junit/runners/model/Statement.java
  59. +1 −0  src/main/java/org/junit/runners/model/TestClass.java
View
1  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)
View
1  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)
View
1  src/main/java/org/junit/Assert.java
@@ -20,6 +20,7 @@
* </pre>
*
* @see AssertionError
+ * @since 4.0
*/
public class Assert {
/**
View
1  src/main/java/org/junit/Assume.java
@@ -29,6 +29,7 @@
* ...
* assumeTrue(...);
* </pre>
+ * @since 4.4
*/
public class Assume {
/**
View
1  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)
View
1  src/main/java/org/junit/BeforeClass.java
@@ -28,6 +28,7 @@
* }
* </pre>
* @see org.junit.AfterClass
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
View
1  src/main/java/org/junit/ClassRule.java
@@ -79,6 +79,7 @@
* </pre>
*
* For more information and more examples, see {@link org.junit.rules.TestRule}.
+ * @since 4.9
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
View
1  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 {
/**
View
1  src/main/java/org/junit/FixMethodOrder.java
@@ -30,6 +30,7 @@
* </pre>
*
* @see org.junit.runners.MethodSorters
+ * @since 4.11
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
View
1  src/main/java/org/junit/Ignore.java
@@ -28,6 +28,7 @@
* }
* </pre>
*
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
View
1  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})
View
1  src/main/java/org/junit/Test.java
@@ -41,6 +41,7 @@
* while(true);
* }
* </pre></p>
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
View
1  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 {
/**
View
4 src/main/java/org/junit/rules/ErrorCollector.java
@@ -1,6 +1,3 @@
-/**
- *
- */
package org.junit.rules;
import static org.junit.Assert.assertThat;
@@ -31,6 +28,7 @@
* }
* }
* </pre>
+ * @since 4.7
*/
public class ErrorCollector extends Verifier {
private List<Throwable> errors= new ArrayList<Throwable>();
View
1  src/main/java/org/junit/rules/ExpectedException.java
@@ -78,6 +78,7 @@
* }
* }
* </pre>
+ * @since 4.7
*/
public class ExpectedException implements TestRule {
/**
View
1  src/main/java/org/junit/rules/ExternalResource.java
@@ -31,6 +31,7 @@
* }
* }
* </pre>
+ * @since 4.7
*/
public abstract class ExternalResource implements TestRule {
public Statement apply(Statement base, Description description) {
View
1  src/main/java/org/junit/rules/MethodRule.java
@@ -25,6 +25,7 @@
* </ul>
*
* Note that {@link MethodRule} is now deprecated, you should be using {@link TestRule} instead.
+ * @since 4.7
*/
@Deprecated
public interface MethodRule {
View
4 src/main/java/org/junit/rules/RuleChain.java
@@ -1,6 +1,3 @@
-/**
- *
- */
package org.junit.rules;
import java.util.ArrayList;
@@ -40,6 +37,7 @@
* finished middle rule
* finished outer rule
* </pre>
+ * @since 4.10
*/
public class RuleChain implements TestRule {
private static final RuleChain EMPTY_CHAIN= new RuleChain(
View
1  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;
View
1  src/main/java/org/junit/rules/TemporaryFolder.java
@@ -23,6 +23,7 @@
* }
* }
* </pre>
+ * @since 4.7
*/
public class TemporaryFolder extends ExternalResource {
private final File parentFolder;
View
1  src/main/java/org/junit/rules/TestName.java
@@ -21,6 +21,7 @@
* }
* }
* </pre>
+ * @since 4.7
*/
public class TestName extends TestWatcher {
private String fName;
View
1  src/main/java/org/junit/rules/TestRule.java
@@ -39,6 +39,7 @@
* <li>{@link Timeout}: cause test to fail after a set time</li>
* <li>{@link Verifier}: fail test if object state ends up incorrect</li>
* </ul>
+ * @since 4.9
*/
public interface TestRule {
/**
View
1  src/main/java/org/junit/rules/TestWatcher.java
@@ -36,6 +36,7 @@
* }
* }
* </pre>
+ * @since 4.9
*/
public abstract class TestWatcher implements TestRule {
public Statement apply(final Statement base, final Description description) {
View
1  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 {
View
4 src/main/java/org/junit/rules/Timeout.java
@@ -1,6 +1,3 @@
-/**
- *
- */
package org.junit.rules;
import org.junit.internal.runners.statements.FailOnTimeout;
@@ -32,6 +29,7 @@
* }
* }
* </pre>
+ * @since 4.7
*/
public class Timeout implements TestRule {
private final int fMillis;
View
1  src/main/java/org/junit/rules/Verifier.java
@@ -24,6 +24,7 @@
* }
* }
* </pre>
+ * @since 4.7
*/
public abstract class Verifier implements TestRule {
public Statement apply(final Statement base, Description description) {
View
1  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 {
/**
View
1  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 {
/**
View
1  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;
View
1  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();
View
1  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 <code>Request</code> ->
* 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.</p>
+ * @since 4.0
*/
public abstract class Request {
/**
View
1  src/main/java/org/junit/runner/Result.java
@@ -12,6 +12,7 @@
/**
* A <code>Result</code> 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;
View
1  src/main/java/org/junit/runner/RunWith.java
@@ -22,6 +22,7 @@
* public class ABCSuite {
* }
* </pre>
+ * @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
View
1  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)
View
1  src/main/java/org/junit/runner/manipulation/Filter.java
@@ -11,6 +11,7 @@
* {@link org.junit.runner.JUnitCore#run(Request)}. Alternatively, apply a <code>Filter</code> 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 {
/**
View
1  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 {
View
1  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;
View
1  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 {
View
2  src/main/java/org/junit/runner/manipulation/Sorter.java
@@ -8,7 +8,7 @@
* A <code>Sorter</code> orders tests. In general you will not need
* to use a <code>Sorter</code> directly. Instead, use {@link org.junit.runner.Request#sortWith(Comparator)}.
*
- *
+ * @since 4.0
*/
public class Sorter implements Comparator<Description> {
/**
View
1  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;
View
1  src/main/java/org/junit/runner/notification/RunListener.java
@@ -30,6 +30,7 @@
* </pre>
* </p>
* @see org.junit.runner.JUnitCore
+ * @since 4.0
*/
public class RunListener {
View
1  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<RunListener> fListeners=
View
1  src/main/java/org/junit/runner/notification/StoppedByUserException.java
@@ -5,6 +5,7 @@
* test running GUIs should be prepared to catch a <code>StoppedByUserException</code>.
*
* @see org.junit.runner.notification.RunNotifier
+ * @since 4.0
*/
public class StoppedByUserException extends RuntimeException {
private static final long serialVersionUID= 1L;
View
1  src/main/java/org/junit/runners/AllTests.java
@@ -13,6 +13,7 @@
* }
* }
* </pre>
+ * @since 4.0
*/
public class AllTests extends SuiteMethod {
/**
View
1  src/main/java/org/junit/runners/BlockJUnit4ClassRunner.java
@@ -44,6 +44,7 @@
* <li>It is published, and extension and reuse are encouraged, whereas {@code
* JUnit4ClassRunner} was in an internal package, and is now deprecated.
* </ul>
+ * @since 4.5
*/
public class BlockJUnit4ClassRunner extends ParentRunner<FrameworkMethod> {
/**
View
1  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 {
/**
View
1  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,
View
1  src/main/java/org/junit/runners/Parameterized.java
@@ -73,6 +73,7 @@
* names like <code>[1: fib(3)=2]</code>. If you don't use the name parameter,
* then the current parameter index is used as name.
* </p>
+ * @since 4.0
*/
public class Parameterized extends Suite {
/**
View
1  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<T> extends Runner implements Filterable,
Sortable {
View
1  src/main/java/org/junit/runners/Suite.java
@@ -20,6 +20,7 @@
* static {@link junit.framework.Test} <code>suite()</code> method. To use it, annotate a class
* with <code>@RunWith(Suite.class)</code> and <code>@SuiteClasses({TestClass1.class, ...})</code>.
* When you run this class, it will run all the tests in all the suite classes.
+ * @since 4.0
*/
public class Suite extends ParentRunner<Runner> {
/**
View
1  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<FrameworkField> {
private final Field fField;
View
5 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<T extends FrameworkMember<T>> {
/**
* Returns the annotations on this method
View
1  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<FrameworkMethod> {
final Method fMethod;
View
1  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;
View
1  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;
View
1  src/main/java/org/junit/runners/model/RunnerBuilder.java
@@ -34,6 +34,7 @@
* </pre>
*
* @see org.junit.runners.Suite
+ * @since 4.5
*/
public abstract class RunnerBuilder {
private final Set<Class<?>> parents= new HashSet<Class<?>>();
View
1  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 {
/**
View
4 src/main/java/org/junit/runners/model/Statement.java
@@ -1,12 +1,10 @@
-/**
- *
- */
package org.junit.runners.model;
/**
* 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 {
/**
View
1  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;
Please sign in to comment.
Something went wrong with that request. Please try again.