Polish Javadoc in @Timed & @Repeat

This commit is contained in:
Sam Brannen 2015-07-24 16:51:01 +02:00
parent 8e5244ac3d
commit dede31eeed
2 changed files with 16 additions and 7 deletions

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2013 the original author or authors. * Copyright 2002-2015 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -36,13 +36,19 @@ import static java.lang.annotation.RetentionPolicy.*;
* @author Rod Johnson * @author Rod Johnson
* @author Sam Brannen * @author Sam Brannen
* @since 2.0 * @since 2.0
* @see Timed * @see org.springframework.test.annotation.Timed
* @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner
* @see org.springframework.test.context.junit4.rules.SpringMethodRule
* @see org.springframework.test.context.junit4.statements.SpringRepeat
*/ */
@Documented @Documented
@Retention(RUNTIME) @Retention(RUNTIME)
@Target({ METHOD, ANNOTATION_TYPE }) @Target({ METHOD, ANNOTATION_TYPE })
public @interface Repeat { public @interface Repeat {
/**
* The number of times that the annotated test method should be repeated.
*/
int value() default 1; int value() default 1;
} }

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2013 the original author or authors. * Copyright 2002-2015 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -25,13 +25,13 @@ import static java.lang.annotation.RetentionPolicy.*;
/** /**
* Test-specific annotation to indicate that a test method has to finish * Test-specific annotation to indicate that a test method has to finish
* execution in a {@link #millis() specified time period}. * execution in a {@linkplain #millis() specified time period}.
* *
* <p>If the text execution takes longer than the specified time period, then * <p>If the text execution takes longer than the specified time period, then
* the test is to be considered failed. * the test is considered to have failed.
* *
* <p>Note that the time period includes execution of the test method itself, * <p>Note that the time period includes execution of the test method itself,
* any {@link Repeat repetitions} of the test, and any <em>set up</em> or * any {@linkplain Repeat repetitions} of the test, and any <em>set up</em> or
* <em>tear down</em> of the test fixture. * <em>tear down</em> of the test fixture.
* *
* <p>As of Spring Framework 4.0, this annotation may be used as a * <p>As of Spring Framework 4.0, this annotation may be used as a
@ -40,7 +40,10 @@ import static java.lang.annotation.RetentionPolicy.*;
* @author Rod Johnson * @author Rod Johnson
* @author Sam Brannen * @author Sam Brannen
* @since 2.0 * @since 2.0
* @see Repeat * @see org.springframework.test.annotation.Repeat
* @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner
* @see org.springframework.test.context.junit4.rules.SpringMethodRule
* @see org.springframework.test.context.junit4.statements.SpringFailOnTimeout
*/ */
@Documented @Documented
@Retention(RUNTIME) @Retention(RUNTIME)