Skip to content

Commit ae421af

Browse files
committed
. d reformatted code and updated markdown snippets
1 parent fe112bc commit ae421af

2 files changed

Lines changed: 37 additions & 28 deletions

File tree

approvaltests/docs/how_to/ConfigureReporters.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ All the [verify](./reference/Verify.md) functions have an overload that takes an
3535
<!-- snippet: configure_reporter_with_options -->
3636
<a id='snippet-configure_reporter_with_options'></a>
3737
```java
38-
Options options = new Options().withReporter(BeyondCompareReporter.INSTANCE);
38+
Options options = new Options().withReporter(ReportWithBeyondCompare.INSTANCE);
3939
Approvals.verify(objectUnderTest, options);
4040
```
4141
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/ApprovalsTest.java#L25-L28' title='Snippet source file'>snippet source</a> | <a href='#snippet-configure_reporter_with_options' title='Start of snippet'>anchor</a></sup>
@@ -49,7 +49,7 @@ At both the class and method level you can use the @UseReporter attribute to set
4949
<!-- snippet: use_reporter_single -->
5050
<a id='snippet-use_reporter_single'></a>
5151
```java
52-
@UseReporter(DiffMergeReporter.class)
52+
@UseReporter(ReportWithDiffMerge.class)
5353
```
5454
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/reporters/GenericDiffReporterTest.java#L23-L25' title='Snippet source file'>snippet source</a> | <a href='#snippet-use_reporter_single' title='Start of snippet'>anchor</a></sup>
5555
<!-- endSnippet -->
@@ -75,8 +75,8 @@ You can also assign a default for an entire package (and all sub-packages) by cr
7575
```java
7676
public class PackageSettings
7777
{
78-
public static TkDiffReporter UseReporter = TkDiffReporter.INSTANCE;
79-
public static CountingReporter FrontloadedReporter = new CountingReporter();
78+
public static ReportWithTkDiffMac UseReporter = ReportWithTkDiffMac.INSTANCE;
79+
public static CountingReporter FrontloadedReporter = new CountingReporter();
8080
}
8181
```
8282
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/packagesettings/PackageSettings.java#L5-L11' title='Snippet source file'>snippet source</a> | <a href='#snippet-use_reporter_package_settings' title='Start of snippet'>anchor</a></sup>

approvaltests/docs/reference/Reporters.md

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,20 @@ Currently the search goes in this order:
2222
<!-- snippet: mac_diff_reporters -->
2323
<a id='snippet-mac_diff_reporters'></a>
2424
```java
25-
BeyondCompareMacReporter.INSTANCE,
26-
DiffMergeMacOsReporter.INSTANCE,
27-
KaleidoscopeDiffReporter.INSTANCE,
28-
P4MergeReporter.INSTANCE,
29-
AraxisMergeReporter.INSTANCE,
30-
KDiff3MacReporter.INSTANCE,
31-
TkDiffReporter.INSTANCE,
32-
IntelliJReporter.INSTANCE,
33-
VisualStudioCodeReporter.INSTANCE
25+
ReportWithDiffMergeMac.INSTANCE,
26+
ReportWithFileMergeMac.INSTANCE,
27+
ReportWithBeyondCompareMac.INSTANCE,
28+
ReportWithKaleidoscopeMac.INSTANCE,
29+
ReportWithKaleidoscope3Mac.INSTANCE,
30+
ReportWithKdiff3Mac.INSTANCE,
31+
ReportWithP4mergeMac.INSTANCE,
32+
ReportWithTkDiffMac.INSTANCE,
33+
ReportWithVisualStudioCodeMac.INSTANCE,
34+
ReportWithAraxisMergeMac.INSTANCE,
35+
ReportWithDiffCommandLineMac.INSTANCE,
36+
ReportWithSublimeMergeMac.INSTANCE
3437
```
35-
<sup><a href='/approvaltests/src/main/java/org/approvaltests/reporters/macosx/MacDiffReporter.java#L13-L23' title='Snippet source file'>snippet source</a> | <a href='#snippet-mac_diff_reporters' title='Start of snippet'>anchor</a></sup>
38+
<sup><a href='/approvaltests/src/main/java/org/approvaltests/reporters/macosx/ReportWithDiffToolOnMac.java#L14-L27' title='Snippet source file'>snippet source</a> | <a href='#snippet-mac_diff_reporters' title='Start of snippet'>anchor</a></sup>
3639
<!-- endSnippet -->
3740

3841

@@ -41,29 +44,35 @@ VisualStudioCodeReporter.INSTANCE
4144
<!-- snippet: windows_diff_reporters -->
4245
<a id='snippet-windows_diff_reporters'></a>
4346
```java
44-
TortoiseDiffReporter.INSTANCE,
45-
BeyondCompareReporter.INSTANCE,
46-
WinMergeReporter.INSTANCE,
47-
AraxisMergeReporter.INSTANCE,
48-
CodeCompareReporter.INSTANCE,
49-
KDiff3WindowsReporter.INSTANCE,
50-
IntelliJReporter.INSTANCE,
51-
VisualStudioCodeReporter.INSTANCE
47+
ReportWithBeyondCompare3Windows.INSTANCE,
48+
ReportWithBeyondCompare4Windows.INSTANCE,
49+
ReportWithBeyondCompare5Windows.INSTANCE,
50+
ReportWithTortoiseImageDiffWindows.INSTANCE,
51+
ReportWithTortoiseTextDiffWindows.INSTANCE,
52+
ReportWithTortoiseGitImageDiffWindows.INSTANCE,
53+
ReportWithTortoiseGitTextDiffWindows.INSTANCE,
54+
ReportWithWinMergeReporterWindows.INSTANCE,
55+
ReportWithAraxisMergeWindows.INSTANCE,
56+
ReportWithCodeCompareWindows.INSTANCE,
57+
ReportWithKdiff3Windows.INSTANCE,
58+
ReportWithVisualStudioCodeWindows.INSTANCE,
59+
ReportWithSublimeMergeWindows.INSTANCE
5260
```
53-
<sup><a href='/approvaltests/src/main/java/org/approvaltests/reporters/windows/WindowsDiffReporter.java#L13-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-windows_diff_reporters' title='Start of snippet'>anchor</a></sup>
61+
<sup><a href='/approvaltests/src/main/java/org/approvaltests/reporters/windows/ReportWithDiffToolOnWindows.java#L14-L28' title='Snippet source file'>snippet source</a> | <a href='#snippet-windows_diff_reporters' title='Start of snippet'>anchor</a></sup>
5462
<!-- endSnippet -->
5563

5664
### Linux
5765

5866
<!-- snippet: linux_diff_reporters -->
5967
<a id='snippet-linux_diff_reporters'></a>
6068
```java
61-
DiffMergeLinuxReporter.INSTANCE,
62-
MeldMergeReporter.INSTANCE,
63-
IntelliJReporter.INSTANCE,
64-
KDiff3LinuxReporter.INSTANCE
69+
ReportWithDiffMergeLinux.INSTANCE,
70+
ReportWithMeldMergeLinux.INSTANCE,
71+
ReportWithKdiff3Linux.INSTANCE,
72+
ReportWithDiffCommandLineLinux.INSTANCE,
73+
ReportWithSublimeMergeLinux.INSTANCE
6574
```
66-
<sup><a href='/approvaltests/src/main/java/org/approvaltests/reporters/linux/LinuxDiffReporter.java#L13-L18' title='Snippet source file'>snippet source</a> | <a href='#snippet-linux_diff_reporters' title='Start of snippet'>anchor</a></sup>
75+
<sup><a href='/approvaltests/src/main/java/org/approvaltests/reporters/linux/ReportWithDiffToolOnLinux.java#L14-L20' title='Snippet source file'>snippet source</a> | <a href='#snippet-linux_diff_reporters' title='Start of snippet'>anchor</a></sup>
6776
<!-- endSnippet -->
6877

6978
## Combining Reporters

0 commit comments

Comments
 (0)