Skip to content

Commit da3507c

Browse files
Updated comments for common types.
1 parent 99acfbf commit da3507c

File tree

6 files changed

+13
-12
lines changed

6 files changed

+13
-12
lines changed

src/KristofferStrube.Blazor.FileAPI/Blob.InProcess.cs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44

55
namespace KristofferStrube.Blazor.FileAPI;
66

7-
/// <summary>
8-
/// <see href="https://www.w3.org/TR/FileAPI/#blob-section">Blob browser specs</see>
9-
/// </summary>
7+
/// <inheritdoc/>
108
[IJSWrapperConverter]
119
public class BlobInProcess : Blob, IJSInProcessCreatable<BlobInProcess, Blob>
1210
{

src/KristofferStrube.Blazor.FileAPI/Blob.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@
55
namespace KristofferStrube.Blazor.FileAPI;
66

77
/// <summary>
8-
/// <see href="https://www.w3.org/TR/FileAPI/#blob-section">Blob browser specs</see>
8+
/// A <see cref="Blob"/> object refers to a byte sequence,
9+
/// and has a <see cref="GetSizeAsync"/> attribute which is the total number of bytes in the byte sequence,
10+
/// and a <see cref="GetTypeAsync"/> attribute, which is an ASCII-encoded string in lower case representing the media type of the byte sequence.
911
/// </summary>
12+
/// <remarks><see href="https://www.w3.org/TR/FileAPI/#blob-section">See the API definition here</see></remarks>
1013
[IJSWrapperConverter]
1114
public class Blob : BaseJSWrapper, IJSCreatable<Blob>
1215
{

src/KristofferStrube.Blazor.FileAPI/File.InProcess.cs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44

55
namespace KristofferStrube.Blazor.FileAPI;
66

7-
/// <summary>
8-
/// <see href="https://www.w3.org/TR/FileAPI/#file-section">File browser specs</see>
9-
/// </summary>
7+
/// <inheritdoc/>
108
[IJSWrapperConverter]
119
public class FileInProcess : File, IJSInProcessCreatable<FileInProcess, File>
1210
{

src/KristofferStrube.Blazor.FileAPI/File.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@
44
namespace KristofferStrube.Blazor.FileAPI;
55

66
/// <summary>
7-
/// <see href="https://www.w3.org/TR/FileAPI/#file-section">File browser specs</see>
7+
/// A File object is a <see cref="Blob"/> object with a <see cref="GetNameAsync"/> attribute, which is a string;
8+
/// it can be created within the web application via a constructor,
9+
/// or is a reference to a byte sequence from a file from the underlying (OS) file system.
810
/// </summary>
11+
/// <remarks><see href="https://www.w3.org/TR/FileAPI/#file-section">See the API definition here</see></remarks>
912
[IJSWrapperConverter]
1013
public class File : Blob, IJSCreatable<File>
1114
{

src/KristofferStrube.Blazor.FileAPI/FileReader.InProcess.cs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66

77
namespace KristofferStrube.Blazor.FileAPI;
88

9-
/// <summary>
10-
/// <see href="https://www.w3.org/TR/FileAPI/#dfn-filereader">FileReader browser specs</see>
11-
/// </summary>
9+
/// <inheritdoc/>
1210
[IJSWrapperConverter]
1311
public class FileReaderInProcess : FileReader, IJSInProcessCreatable<FileReaderInProcess, FileReader>, IEventTargetInProcess
1412
{

src/KristofferStrube.Blazor.FileAPI/FileReader.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
namespace KristofferStrube.Blazor.FileAPI;
77

88
/// <summary>
9-
/// <see href="https://www.w3.org/TR/FileAPI/#dfn-filereader">FileReader browser specs</see>
9+
/// A reader that can asynchronously start reads of <see cref="Blob"/>s or <see cref="File"/>s and listen for events for its progress until it finishes.
1010
/// </summary>
11+
/// <remarks><see href="https://www.w3.org/TR/FileAPI/#dfn-filereader">See the API definition here</see></remarks>
1112
[IJSWrapperConverter]
1213
public class FileReader : EventTarget, IJSCreatable<FileReader>
1314
{

0 commit comments

Comments
 (0)