Skip to content

Commit

Permalink
Fix some javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
skuzzle committed Sep 13, 2022
1 parent ed63ee1 commit 95ec518
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@
* snapshot.assertThat(actual).as(XmlSnapshot.xml).matchesSnapshotStructure();
* }
* </pre>
* <p>
* <h3>Parameterized tests</h3>
*
* <h2>Parameterized tests</h2>
* <p>
* Snapshot tests can be combined with JUnit5's parameterized tests, but only when you
* provide an explicit name for each snapshot assertion. With the default automatic
Expand All @@ -83,14 +83,14 @@
* .assertThat(actual).as...;
* </pre>
*
* <h3>Updating snapshots</h3>
* <h2>Updating snapshots</h2>
* <p>
* Snapshots can become outdated when your code under test changes on purpose. In that
* case you can advice the framework to override existing snapshots with your code under
* test's actual result by placing the annotation {@link ForceUpdateSnapshots} on either
* the whole snapshot test class or on a single test method.
*
* <h3>Orphaned snapshots</h3>
* <h2>Orphaned snapshots</h2>
* <p>
* Snapshot files can become orphans if, for example you rename a test class/method or you
* change the snapshot assertions within a test. This framework comes with a sophisticated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public static JsonSnapshot json(ObjectMapper objectMapper) {
*
* @param objectMapper The ObjectMapper to use for taking snapshots.
* @return A builder for building {@link StructuredData}.
* @deprecated Since 1.4.0 - Use {@link #json(ObjectMapper))} instead.
* @deprecated Since 1.4.0 - Use {@link #json(ObjectMapper)} instead.
*/
@Deprecated(since = "1.4.0", forRemoval = true)
@API(status = Status.DEPRECATED, since = "1.4.0")
Expand Down

0 comments on commit 95ec518

Please sign in to comment.