Skip to content

Commit 9df8f19

Browse files
committed
Minor XML docs improvements
1 parent 4755472 commit 9df8f19

File tree

4 files changed

+22
-0
lines changed

4 files changed

+22
-0
lines changed

CommunityToolkit.WinUI/Extensions/Interop/DispatcherQueueProxyHandler1.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,20 @@ internal unsafe struct DispatcherQueueProxyHandler1
8585
return (IDispatcherQueueHandler*)@this;
8686
}
8787

88+
/// <summary>
89+
/// Devirtualized API for <c>IUnknown.AddRef()</c>.
90+
/// </summary>
91+
/// <returns>The updated reference count for the current instance.</returns>
8892
[MethodImpl(MethodImplOptions.AggressiveInlining)]
8993
public uint AddRef()
9094
{
9195
return Interlocked.Increment(ref referenceCount);
9296
}
9397

98+
/// <summary>
99+
/// Devirtualized API for <c>IUnknown.Release()</c>.
100+
/// </summary>
101+
/// <returns>The updated reference count for the current instance.</returns>
94102
[MethodImpl(MethodImplOptions.AggressiveInlining)]
95103
public uint Release()
96104
{

CommunityToolkit.WinUI/Extensions/Interop/DispatcherQueueProxyHandler2.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,20 @@ internal unsafe struct DispatcherQueueProxyHandler2
9292
return (IDispatcherQueueHandler*)@this;
9393
}
9494

95+
/// <summary>
96+
/// Devirtualized API for <c>IUnknown.AddRef()</c>.
97+
/// </summary>
98+
/// <returns>The updated reference count for the current instance.</returns>
9599
[MethodImpl(MethodImplOptions.AggressiveInlining)]
96100
public uint AddRef()
97101
{
98102
return Interlocked.Increment(ref referenceCount);
99103
}
100104

105+
/// <summary>
106+
/// Devirtualized API for <c>IUnknown.Release()</c>.
107+
/// </summary>
108+
/// <returns>The updated reference count for the current instance.</returns>
101109
[MethodImpl(MethodImplOptions.AggressiveInlining)]
102110
public uint Release()
103111
{

CommunityToolkit.WinUI/Extensions/Interop/IDispatcherQueue.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ namespace CommunityToolkit.WinUI.Interop
1414
/// </summary>
1515
internal unsafe struct IDispatcherQueue
1616
{
17+
/// <summary>
18+
/// The vtable pointer for the current instance.
19+
/// </summary>
1720
private readonly void** lpVtbl;
1821

1922
/// <summary>

CommunityToolkit.WinUI/Extensions/Interop/IDispatcherQueueHandler.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ namespace CommunityToolkit.WinUI.Interop
1313
/// </summary>
1414
internal unsafe struct IDispatcherQueueHandler
1515
{
16+
/// <summary>
17+
/// The vtable pointer for the current instance.
18+
/// </summary>
1619
private readonly void** lpVtbl;
1720

1821
/// <summary>

0 commit comments

Comments
 (0)