Skip to content

Commit

Permalink
Issue ota4j-team#21: AssertionFailedException - JavaDoc
Browse files Browse the repository at this point in the history
Adjust Javadoc as the statements about actual/expected values are
not valid anymore.
  • Loading branch information
mmichaelis committed Jul 18, 2016
1 parent defb952 commit ff3f168
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions src/main/java/org/opentest4j/AssertionFailedException.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,22 @@
package org.opentest4j;

import org.opentest4j.debug.DebugInformation;
import org.opentest4j.debug.ValueDescriptor;

/**
* {@code AssertionFailedError} is an <em>initial draft</em> for a common base class for test-related
* {@link AssertionError AssertionErrors}.
* <p>
* In addition to a message and a cause this class stores the expected and actual values of an assertion using the
* {@link ValueDescriptor} type.
* {@code AssertionFailedException} is an <em>initial draft</em> for a common base class for test-related assertion
* failures.
* </p>
* <dl>
* <dt><strong>WARNING:</strong></dt>
* <dd>this is a <em>work in progress</em> and is therefore guaranteed to undergo heavy revisions in the near future
* based on community feedback.</dd>
* </dl>
* <p>
* <strong>WARNING</strong>: this is a <em>work in progress</em> and is therefore guaranteed to undergo heavy revisions
* in the near future based on community feedback.
*
* @author Sam Brannen
* @author Marc Philipp
* @author Mark Michaelis
* @since 1.0
*/
public class AssertionFailedException extends DebuggableException {
Expand Down

0 comments on commit ff3f168

Please sign in to comment.