Skip to content

Commit e9d13c3

Browse files
authored
Update PH2160 documentation for mock disposal
1 parent 93063bf commit e9d13c3

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

Documentation/Diagnostics/PH2160.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Configure the mock’s protected `Dispose` method explicitly, or use a project-s
2727
Example:
2828

2929
```csharp
30-
mock.Protected().Setup("Dispose", ItExpr.IsAny<bool>()).CallBase();
30+
mock.Protected().Setup("Dispose", ItExpr.IsAny<bool>()).();
3131
```
3232

3333
Any explicit protected setup of `Dispose` is considered acceptable for this rule.
@@ -87,7 +87,7 @@ public class TestClass
8787
public void TestMethod()
8888
{
8989
var mock = new Mock<Worker>();
90-
mock.Protected().Setup("Dispose", ItExpr.IsAny<bool>()).CallBase();
90+
mock.Protected().Setup("Dispose", ItExpr.IsAny<bool>()).();
9191
}
9292
}
9393
```
@@ -96,7 +96,7 @@ public class TestClass
9696
This rule supports an optional `.editorconfig` setting to specify a preferred mock type for disposable concrete classes.
9797

9898
```ini
99-
dotnet_code_quality.PH2160.preferred_disposable_mock_type = MyNamespace.DisposeCallBaseMock
99+
dotnet_code_quality.PH2160.preferred_disposable_mock_type = MyNamespace.DisposableObjectMock
100100
```
101101

102102
When this option is configured, the CodeFix replaces `Mock<T>` with the configured generic type.
@@ -110,7 +110,7 @@ private readonly Mock<MyDisposable> _mock = new Mock<MyDisposable>();
110110
becomes:
111111

112112
```csharp
113-
private readonly MyNamespace.DisposeCallBaseMock<MyDisposable> _mock = new MyNamespace.DisposeCallBaseMock<MyDisposable>();
113+
private readonly MyNamespace.DisposableObjectMock<MyDisposable> _mock = new MyNamespace.DisposableObjectMock<MyDisposable>();
114114
```
115115

116116
This is especially useful for codebases that already use a custom Moq wrapper to ensure disposable concrete classes execute their real `Dispose(bool)` logic.
@@ -123,7 +123,7 @@ The wrapper class could look like this:
123123
public DisposableObjectMock(params object[] args)
124124
: base(args)
125125
{
126-
this.Protected().Setup("Dispose", ItExpr.IsAny<bool>()).CallBase();
126+
this.Protected().Setup("Dispose", ItExpr.IsAny<bool>()).();
127127
}
128128
}
129129
```

0 commit comments

Comments
 (0)