Skip to content

Commit ad908db

Browse files
committed
xml comments
1 parent 1cbc68d commit ad908db

4 files changed

Lines changed: 13 additions & 4 deletions

File tree

src/DiffEngine/DiffRunner_Inline.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ public static async Task<InlineResult> AddInlineAsync(InlinePatch patch, Cancel
7878
/// conflicted entry; the other framework's differing content stays pending.
7979
/// </para>
8080
/// </summary>
81+
/// <param name="sourceFile">The source file holding the call site.</param>
82+
/// <param name="line">The line the snapshot was recorded at, which names the queue entry.</param>
8183
/// <param name="memberName">
8284
/// The member the call site sits in. Optional, and only used where the line no longer names
8385
/// the entry, which is what happens once an accept inserts a literal above it.

src/DiffEngine/Inline/InlineQueue.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,8 @@ public InlineQueue Settle(string key, string? origin) =>
224224
/// framework's still-failing content stays reviewable. A null origin, or an entry whose
225225
/// variants are all unlabeled, settles the whole entry.
226226
/// </summary>
227+
/// <param name="key">The entry's key, naming its source file and recorded line.</param>
228+
/// <param name="origin">The framework moniker of the run that started passing.</param>
227229
/// <param name="member">
228230
/// The member the settled call site sits in, used only when <paramref name="key" /> matches
229231
/// nothing. See <see cref="FindByMember" />.

src/DiffEngine/Protocol/ViewerMessage.cs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
namespace DiffEngine;
22

33
/// <summary>
4-
/// A request to whoever owns the inline queue. <paramref name="Key"/> identifies a queue entry for
5-
/// the verbs that act on one; <paramref name="Body"/> carries an <see cref="InlinePatchFile"/>
6-
/// payload for <see cref="ViewerVerb.Inline"/>.
4+
/// A request to whoever owns the inline queue.
75
/// </summary>
6+
/// <param name="Verb">What the owner is being asked to do.</param>
7+
/// <param name="Key">
8+
/// Identifies a queue entry, for the verbs that act on one.
9+
/// </param>
10+
/// <param name="Body">
11+
/// An <see cref="InlinePatchFile"/> payload, for <see cref="ViewerVerb.Inline"/>.
12+
/// </param>
813
/// <param name="Member">
914
/// The member the call site sits in, on a <see cref="ViewerVerb.Settle"/>. A fallback for the key,
1015
/// which names a line and so stops being true once an accept inserts a literal above it. Optional,

src/Directory.Packages.props

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<PackageVersion Include="Verify.TUnit" Version="31.28.0" />
2121
<PackageVersion Include="SimpleInfoName" Version="3.2.0" />
2222
<PackageVersion Include="Verify" Version="31.28.0" />
23-
<PackageVersion Include="TUnit" Version="1.65.0" />
23+
<PackageVersion Include="TUnit" Version="1.65.31" />
2424
<PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="18.10.0" />
2525
</ItemGroup>
2626
</Project>

0 commit comments

Comments
 (0)