Skip to content

Commit

Permalink
Made documentation consistent.
Browse files Browse the repository at this point in the history
  • Loading branch information
mockitoguy committed Jul 24, 2018
1 parent e51245a commit 0fcc2a3
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 22 deletions.
4 changes: 1 addition & 3 deletions src/main/java/org/mockito/Mockito.java
Expand Up @@ -2991,9 +2991,7 @@ public static MockitoSessionBuilder mockitoSession() {
* <li>If a specific stubbing needs to be lenient - use this method</li>
* <li>If a specific mock need to have stubbings lenient - use {@link MockSettings#lenient()}</li>
* <li>If a specific test method / test class needs to have all stubbings lenient
* - configure strictness at the level of JUnit Rule ({@link MockitoRule}), JUnit Runner ({@link MockitoJUnitRunner}),
* Mockito Session ({@link MockitoSession}) or JUnit Jupiter extension</li>
* </ul>
* - configure strictness using our JUnit support ({@link MockitoJUnit} or Mockito Session ({@link MockitoSession})</li>
*
* <h3>Elaborate example</h3>
*
Expand Down
Expand Up @@ -7,9 +7,6 @@
import org.mockito.Mockito;
import org.mockito.MockitoSession;
import org.mockito.exceptions.base.MockitoException;
import org.mockito.junit.MockitoJUnitRunner;
import org.mockito.junit.MockitoRule;
import org.mockito.quality.Strictness;

/**
* This exception indicates presence of unused stubbings.
Expand All @@ -19,15 +16,8 @@
* <ol>
* <li>Declaring specific stubbing as 'lenient' - {@link Mockito#lenient()}</li>
* <li>Declaring specific mock as 'lenient' - {@link org.mockito.MockSettings#lenient()}</li>
* <li>Declaring all mocks in given test class or test method mock as 'lenient' with:
* <ul>
* <li>JUnit rule - {@link MockitoRule#strictness(Strictness)} passing {@link Strictness#LENIENT}.
* Alternatively, use the old API: {@link MockitoRule#silent()}</li>
* <li>JUnit runner - {@link MockitoJUnitRunner.Silent}</li>
* <li>Mockito session - {@link MockitoSession}</li>
* <li>JUnit Jupiter (JUnit5) Mockito extension also has ways to configure strictness</li>
* </ul>
* </li>
* <li>Declaring all mocks in given test class or test method mock as 'lenient' with
* our JUnit support ({@link org.mockito.junit.MockitoJUnit}) or Mockito session ({@link MockitoSession})</li>
* </ol>
*
* <p>
Expand Down
9 changes: 7 additions & 2 deletions src/main/java/org/mockito/junit/MockitoJUnit.java
Expand Up @@ -5,13 +5,18 @@
package org.mockito.junit;

import org.mockito.Incubating;
import org.mockito.quality.Strictness;
import org.mockito.internal.junit.JUnitRule;
import org.mockito.internal.junit.VerificationCollectorImpl;
import org.mockito.internal.util.ConsoleMockitoLogger;
import org.mockito.quality.Strictness;

/**
* The JUnit rule can be used instead of {@link MockitoJUnitRunner}. See {@link MockitoRule}.
* Mockito supports JUnit via:
* <li>
* <ul>JUnit Rules - see {@link MockitoRule}</ul>
* <ul>JUnit runners - see {@link MockitoJUnitRunner}</ul>
* <ul><a href="http://javadoc.io/page/org.mockito/mockito-junit-jupiter/latest/org/mockito/junit/jupiter/MockitoExtension.html">JUnit Jupiter extension</a></ul>
* </li>
*
* @since 1.10.17
*/
Expand Down
8 changes: 3 additions & 5 deletions src/main/java/org/mockito/quality/Strictness.java
Expand Up @@ -9,15 +9,14 @@
import org.mockito.exceptions.misusing.PotentialStubbingProblem;
import org.mockito.exceptions.misusing.UnnecessaryStubbingException;
import org.mockito.internal.junit.JUnitRule;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoJUnitRunner;
import org.mockito.junit.MockitoRule;

/**
* Configures the "strictness" of Mockito, affecting the behavior of stubbings and verification.
* "Strict stubbing" is a new feature in Mockito 2 that drives cleaner tests and better productivity.
* The easiest way to use it is via Mockito's JUnit support ({@link MockitoRule}, {@link MockitoJUnitRunner})
* or our JUnit Jupiter (JUnit5) extension.
* If you cannot use Rules or Runners try {@link MockitoSession}.
* The easiest way to leverage it is via Mockito's JUnit support ({@link MockitoJUnit}) or Mockito Session ({@link MockitoSession}).
* <p>
* How strictness influences the behavior of the test?
* <ol>
Expand Down Expand Up @@ -71,8 +70,7 @@ public enum Strictness {
* Offers best combination of flexibility and productivity.
* Highly recommended.
* Planned as default for Mockito v3.
* Enable it via {@link MockitoRule}, {@link MockitoJUnitRunner}, JUnit Jupiter (JUnit5) extension
* or {@link MockitoSession}.
* Enable it via our JUnit support ({@link MockitoJUnit}) or {@link MockitoSession}.
* <p>
* Adds following behavior:
* <ul>
Expand Down

0 comments on commit 0fcc2a3

Please sign in to comment.