Skip to content

Commit ff3f168

Browse files
committed
Issue ota4j-team#21: AssertionFailedException - JavaDoc
Adjust Javadoc as the statements about actual/expected values are not valid anymore.
1 parent defb952 commit ff3f168

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

src/main/java/org/opentest4j/AssertionFailedException.java

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,22 @@
1717
package org.opentest4j;
1818

1919
import org.opentest4j.debug.DebugInformation;
20-
import org.opentest4j.debug.ValueDescriptor;
2120

2221
/**
23-
* {@code AssertionFailedError} is an <em>initial draft</em> for a common base class for test-related
24-
* {@link AssertionError AssertionErrors}.
2522
* <p>
26-
* In addition to a message and a cause this class stores the expected and actual values of an assertion using the
27-
* {@link ValueDescriptor} type.
23+
* {@code AssertionFailedException} is an <em>initial draft</em> for a common base class for test-related assertion
24+
* failures.
25+
* </p>
26+
* <dl>
27+
* <dt><strong>WARNING:</strong></dt>
28+
* <dd>this is a <em>work in progress</em> and is therefore guaranteed to undergo heavy revisions in the near future
29+
* based on community feedback.</dd>
30+
* </dl>
2831
* <p>
29-
* <strong>WARNING</strong>: this is a <em>work in progress</em> and is therefore guaranteed to undergo heavy revisions
30-
* in the near future based on community feedback.
3132
*
3233
* @author Sam Brannen
3334
* @author Marc Philipp
35+
* @author Mark Michaelis
3436
* @since 1.0
3537
*/
3638
public class AssertionFailedException extends DebuggableException {

0 commit comments

Comments
 (0)