Skip to content

Commit

Permalink
Merge pull request junit-team#445 from matthewfarwell/67-since2
Browse files Browse the repository at this point in the history
Fixes junit-team#67 no since javadoc
  • Loading branch information
kcooney committed Jun 8, 2012
2 parents c228881 + caefa62 commit e8b91fa
Show file tree
Hide file tree
Showing 59 changed files with 63 additions and 13 deletions.
1 change: 1 addition & 0 deletions src/main/java/org/junit/After.java
Expand Up @@ -31,6 +31,7 @@
*
* @see org.junit.Before
* @see org.junit.Test
* @since 4.0
*/

@Retention(RetentionPolicy.RUNTIME)
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/AfterClass.java
Expand Up @@ -34,6 +34,7 @@
*
* @see org.junit.BeforeClass
* @see org.junit.Test
* @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/Assert.java
Expand Up @@ -20,6 +20,7 @@
* </pre>
*
* @see AssertionError
* @since 4.0
*/
public class Assert {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/Assume.java
Expand Up @@ -29,6 +29,7 @@
* ...
* assumeTrue(...);
* </pre>
* @since 4.4
*/
public class Assume {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/Before.java
Expand Up @@ -31,6 +31,7 @@
*
* @see org.junit.BeforeClass
* @see org.junit.After
* @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/BeforeClass.java
Expand Up @@ -28,6 +28,7 @@
* }
* </pre>
* @see org.junit.AfterClass
* @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/ClassRule.java
Expand Up @@ -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})
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/ComparisonFailure.java
Expand Up @@ -6,6 +6,7 @@
* strings.
*
* Inspired by a patch from Alex Chaffee (alex@purpletech.com)
* @since 4.0
*/
public class ComparisonFailure extends AssertionError {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/FixMethodOrder.java
Expand Up @@ -30,6 +30,7 @@
* </pre>
*
* @see org.junit.runners.MethodSorters
* @since 4.11
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/Ignore.java
Expand Up @@ -28,6 +28,7 @@
* }
* </pre>
*
* @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/Rule.java
Expand Up @@ -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})
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/Test.java
Expand Up @@ -41,6 +41,7 @@
* while(true);
* }
* </pre></p>
* @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/matchers/JUnitMatchers.java
Expand Up @@ -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 {
/**
Expand Down
4 changes: 1 addition & 3 deletions src/main/java/org/junit/rules/ErrorCollector.java
@@ -1,6 +1,3 @@
/**
*
*/
package org.junit.rules;

import static org.junit.Assert.assertThat;
Expand Down Expand Up @@ -31,6 +28,7 @@
* }
* }
* </pre>
* @since 4.7
*/
public class ErrorCollector extends Verifier {
private List<Throwable> errors= new ArrayList<Throwable>();
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/ExpectedException.java
Expand Up @@ -78,6 +78,7 @@
* }
* }
* </pre>
* @since 4.7
*/
public class ExpectedException implements TestRule {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/ExternalResource.java
Expand Up @@ -31,6 +31,7 @@
* }
* }
* </pre>
* @since 4.7
*/
public abstract class ExternalResource implements TestRule {
public Statement apply(Statement base, Description description) {
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/MethodRule.java
Expand Up @@ -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 {
Expand Down
4 changes: 1 addition & 3 deletions src/main/java/org/junit/rules/RuleChain.java
@@ -1,6 +1,3 @@
/**
*
*/
package org.junit.rules;

import java.util.ArrayList;
Expand Down Expand Up @@ -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(
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/RunRules.java
Expand Up @@ -5,6 +5,7 @@

/**
* Runs a collection of rules on a statement.
* @since 4.9
*/
public class RunRules extends Statement {
private final Statement statement;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/TemporaryFolder.java
Expand Up @@ -23,6 +23,7 @@
* }
* }
* </pre>
* @since 4.7
*/
public class TemporaryFolder extends ExternalResource {
private final File parentFolder;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/TestName.java
Expand Up @@ -21,6 +21,7 @@
* }
* }
* </pre>
* @since 4.7
*/
public class TestName extends TestWatcher {
private String fName;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/TestRule.java
Expand Up @@ -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 {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/TestWatcher.java
Expand Up @@ -36,6 +36,7 @@
* }
* }
* </pre>
* @since 4.9
*/
public abstract class TestWatcher implements TestRule {
public Statement apply(final Statement base, final Description description) {
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/TestWatchman.java
Expand Up @@ -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 {
Expand Down
4 changes: 1 addition & 3 deletions src/main/java/org/junit/rules/Timeout.java
@@ -1,6 +1,3 @@
/**
*
*/
package org.junit.rules;

import org.junit.internal.runners.statements.FailOnTimeout;
Expand Down Expand Up @@ -32,6 +29,7 @@
* }
* }
* </pre>
* @since 4.7
*/
public class Timeout implements TestRule {
private final int fMillis;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/rules/Verifier.java
Expand Up @@ -24,6 +24,7 @@
* }
* }
* </pre>
* @since 4.7
*/
public abstract class Verifier implements TestRule {
public Statement apply(final Statement base, Description description) {
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/Computer.java
Expand Up @@ -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 {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/Describable.java
Expand Up @@ -3,6 +3,7 @@

/**
* Represents an object that can describe itself
* @since 4.5
*/
public interface Describable {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/Description.java
Expand Up @@ -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;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/JUnitCore.java
Expand Up @@ -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();
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/Request.java
Expand Up @@ -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 {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/Result.java
Expand Up @@ -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;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/RunWith.java
Expand Up @@ -22,6 +22,7 @@
* public class ABCSuite {
* }
* </pre>
* @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/Runner.java
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/manipulation/Filter.java
Expand Up @@ -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 {
/**
Expand Down
Expand Up @@ -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 {

Expand Down
Expand Up @@ -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;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/manipulation/Sortable.java
Expand Up @@ -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 {

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/junit/runner/manipulation/Sorter.java
Expand Up @@ -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> {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runner/notification/Failure.java
Expand Up @@ -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;
Expand Down
Expand Up @@ -30,6 +30,7 @@
* </pre>
* </p>
* @see org.junit.runner.JUnitCore
* @since 4.0
*/
public class RunListener {

Expand Down
Expand Up @@ -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=
Expand Down
Expand Up @@ -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;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runners/AllTests.java
Expand Up @@ -13,6 +13,7 @@
* }
* }
* </pre>
* @since 4.0
*/
public class AllTests extends SuiteMethod {
/**
Expand Down
Expand Up @@ -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> {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runners/JUnit4.java
Expand Up @@ -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 {
/**
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/junit/runners/MethodSorters.java
Expand Up @@ -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,
Expand Down

0 comments on commit e8b91fa

Please sign in to comment.