Skip to content

Commit

Permalink
Updated XML Docs for MapLike.
Browse files Browse the repository at this point in the history
  • Loading branch information
KristofferStrube committed Oct 22, 2024
1 parent ab3c10b commit 6532614
Showing 1 changed file with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@
namespace KristofferStrube.Blazor.WebIDL;

/// <summary>
/// Objects implementing an interface that is declared to be maplike represent an ordered map of key–value pairs, initially empty, known as that object’s map entries.
/// Objects implementing the <see cref="IReadonlyMapLike{TMap, TKey, TValue}"/> interface are maplike and have an ordered map of key–value pairs, initially empty, known as that object’s map entries.
/// </summary>
/// <remarks><see href="https://webidl.spec.whatwg.org/#idl-maplike">See the API definition here</see>.</remarks>
public interface IReadonlyMapLike<TMap, TKey, TValue> : IJSWrapper where TMap : IReadonlyMapLike<TMap, TKey, TValue> { }

/// <summary>
/// Extensions used to access members of objects that implement <see cref="IReadonlyMapLike{TMap, TKey, TValue}"/>.
/// </summary>
public static class IReadonlyMapLikeExtensions
{
public static async Task<ulong> GetSizeAsync<TMap, TKey, TValue>(this IReadonlyMapLike<TMap, TKey, TValue> map) where TMap : IReadonlyMapLike<TMap, TKey, TValue>

Check warning on line 16 in src/KristofferStrube.Blazor.WebIDL/Declerations/IReadonlyMapLike.cs

View workflow job for this annotation

GitHub Actions / build

Missing XML comment for publicly visible type or member 'IReadonlyMapLikeExtensions.GetSizeAsync<TMap, TKey, TValue>(IReadonlyMapLike<TMap, TKey, TValue>)'

Check warning on line 16 in src/KristofferStrube.Blazor.WebIDL/Declerations/IReadonlyMapLike.cs

View workflow job for this annotation

GitHub Actions / build

Missing XML comment for publicly visible type or member 'IReadonlyMapLikeExtensions.GetSizeAsync<TMap, TKey, TValue>(IReadonlyMapLike<TMap, TKey, TValue>)'
Expand Down

0 comments on commit 6532614

Please sign in to comment.