Skip to content

Commit fbb789f

Browse files
Copilotdrewnoakes
andcommitted
Improve INetMQMonitor documentation to describe the abstraction, use inheritdoc in NetMQMonitor
Co-authored-by: drewnoakes <[email protected]>
1 parent dd640a4 commit fbb789f

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

src/NetMQ/Monitoring/INetMQMonitor.cs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44
namespace NetMQ.Monitoring
55
{
66
/// <summary>
7-
/// NetMQMonitor interface, implement to fake the NetMQMonitor in tests.
7+
/// Monitors a <see cref="NetMQSocket"/> for events, raising them via events.
88
/// </summary>
9+
/// <remarks>
10+
/// To run a monitor instance, either:
11+
/// <list type="bullet">
12+
/// <item>Call <see cref="Start"/> (blocking) and <see cref="Stop"/>, or</item>
13+
/// <item>Call <see cref="AttachToPoller{T}"/> and <see cref="DetachFromPoller()"/>.</item>
14+
/// </list>
15+
/// </remarks>
916
public interface INetMQMonitor : IDisposable
1017
{
1118
/// <summary>

src/NetMQ/Monitoring/NetMQMonitor.cs

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,7 @@
77

88
namespace NetMQ.Monitoring
99
{
10-
/// <summary>
11-
/// Monitors a <see cref="NetMQSocket"/> for events, raising them via events.
12-
/// </summary>
13-
/// <remarks>
14-
/// To run a monitor instance, either:
15-
/// <list type="bullet">
16-
/// <item>Call <see cref="Start"/> (blocking) and <see cref="Stop"/>, or</item>
17-
/// <item>Call <see cref="AttachToPoller{T}"/> and <see cref="DetachFromPoller()"/>.</item>
18-
/// </list>
19-
/// </remarks>
10+
/// <inheritdoc />
2011
public class NetMQMonitor : INetMQMonitor
2112
{
2213
private readonly NetMQSocket m_monitoringSocket;

0 commit comments

Comments
 (0)