Skip to content

Commit 775479a

Browse files
author
Joanna May
committed
fix: inheritdoc warnings
1 parent 6c0a20f commit 775479a

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

Chickensoft.LogicBlocks/src/ILogicBlockBinding.cs

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,23 @@ namespace Chickensoft.LogicBlocks;
66
/// <typeparam name="TState">Logic block state type.</typeparam>
77
public interface ILogicBlockBinding<TState>
88
where TState : StateLogic<TState> {
9-
internal void MonitorInput<TInputType>(in TInputType input)
10-
where TInputType : struct;
9+
/// <summary>Called when the logic block receives an input.</summary>
10+
/// <param name="input">Input received.</param>
11+
/// <typeparam name="TInput">Type of the input.</typeparam>
12+
internal void MonitorInput<TInput>(in TInput input)
13+
where TInput : struct;
14+
15+
/// <summary>Called when the logic block changes state.</summary>
16+
/// <param name="state">New state.</param>
1117
internal void MonitorState(TState state);
18+
19+
/// <summary>Called when the logic block produces an output.</summary>
20+
/// <param name="output">Output received.</param>
21+
/// <typeparam name="TOutput">Type of the output.</typeparam>
1222
internal void MonitorOutput<TOutput>(in TOutput output)
1323
where TOutput : struct;
24+
25+
/// <summary>Called when the logic block encounters an exception.</summary>
26+
/// <param name="exception">Exception encountered.</param>
1427
internal void MonitorException(Exception exception);
1528
}

0 commit comments

Comments
 (0)