Skip to content

Commit 7ba846d

Browse files
committed
Documentation comment for the File requester #11
1 parent 41978af commit 7ba846d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/AngleSharp.Io/Network/FileRequester.cs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,17 @@
77
using System.Threading;
88
using System.Threading.Tasks;
99

10+
/// <summary>
11+
/// Requester to perform file:// requests.
12+
/// </summary>
1013
public class FileRequester : IRequester
1114
{
15+
/// <summary>
16+
/// Performs an asynchronous request that can be cancelled.
17+
/// </summary>
18+
/// <param name="request">The options to consider.</param>
19+
/// <param name="cancel">The token for cancelling the task.</param>
20+
/// <returns>The task that will eventually give the response data.</returns>
1221
public async Task<IResponse> RequestAsync(IRequest request, CancellationToken cancel)
1322
{
1423
var requester = FileWebRequest.Create(request.Address.Href) as FileWebRequest;
@@ -29,6 +38,11 @@ public async Task<IResponse> RequestAsync(IRequest request, CancellationToken ca
2938
return default(IResponse);
3039
}
3140

41+
/// <summary>
42+
/// Checks if the given protocol is supported.
43+
/// </summary>
44+
/// <param name="protocol">The protocol to check for, e.g. file.</param>
45+
/// <returns>True if the protocol is supported, otherwise false.</returns>
3246
public Boolean SupportsProtocol(String protocol)
3347
{
3448
return !String.IsNullOrEmpty(protocol) && protocol.Equals(ProtocolNames.File);

0 commit comments

Comments
 (0)