Skip to content
This repository was archived by the owner on Nov 20, 2018. It is now read-only.

Commit 60f2175

Browse files
committed
Added moar XML docs
1 parent cc537ef commit 60f2175

File tree

2 files changed

+44
-2
lines changed

2 files changed

+44
-2
lines changed

src/Microsoft.AspNet.Http.Abstractions/IFormFile.cs

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,39 @@ namespace Microsoft.AspNet.Http
1212
/// </summary>
1313
public interface IFormFile
1414
{
15+
/// <summary>
16+
/// Gets the raw Content-Type header of the uploaded file.
17+
/// </summary>
1518
string ContentType { get; }
1619

20+
/// <summary>
21+
/// Gets the raw Content-Disposition header of the uploaded file.
22+
/// </summary>
1723
string ContentDisposition { get; }
1824

25+
/// <summary>
26+
/// Gets the header dictionary of the uploaded file.
27+
/// </summary>
1928
IHeaderDictionary Headers { get; }
2029

30+
/// <summary>
31+
/// Gets the file length in bytes.
32+
/// </summary>
2133
long Length { get; }
2234

35+
/// <summary>
36+
/// Gets the name from the Content-Disposition header.
37+
/// </summary>
2338
string Name { get; }
2439

40+
/// <summary>
41+
/// Gets the file name from the Content-Disposition header.
42+
/// </summary>
2543
string FileName { get; }
2644

45+
/// <summary>
46+
/// Opens the request stream for reading the uploaded file.
47+
/// </summary>
2748
Stream OpenReadStream();
2849

2950
/// <summary>
@@ -45,4 +66,4 @@ public interface IFormFile
4566
/// <param name="cancellationToken"></param>
4667
Task SaveAsAsync(string path, CancellationToken cancellationToken);
4768
}
48-
}
69+
}

src/Microsoft.AspNet.Http/Features/FormFile.cs

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,26 +25,47 @@ public FormFile(Stream baseStream, long baseStreamOffset, long length, string na
2525
FileName = fileName;
2626
}
2727

28+
/// <summary>
29+
/// Gets the raw Content-Disposition header of the uploaded file.
30+
/// </summary>
2831
public string ContentDisposition
2932
{
3033
get { return Headers["Content-Disposition"]; }
3134
set { Headers["Content-Disposition"] = value; }
3235
}
3336

37+
/// <summary>
38+
/// Gets the raw Content-Type header of the uploaded file.
39+
/// </summary>
3440
public string ContentType
3541
{
3642
get { return Headers["Content-Type"]; }
3743
set { Headers["Content-Type"] = value; }
3844
}
3945

46+
/// <summary>
47+
/// Gets the header dictionary of the uploaded file.
48+
/// </summary>
4049
public IHeaderDictionary Headers { get; set; }
4150

51+
/// <summary>
52+
/// Gets the file length in bytes.
53+
/// </summary>
4254
public long Length { get; }
4355

56+
/// <summary>
57+
/// Gets the name from the Content-Disposition header.
58+
/// </summary>
4459
public string Name { get; }
4560

61+
/// <summary>
62+
/// Gets the file name from the Content-Disposition header.
63+
/// </summary>
4664
public string FileName { get; }
4765

66+
/// <summary>
67+
/// Opens the request stream for reading the uploaded file.
68+
/// </summary>
4869
public Stream OpenReadStream()
4970
{
5071
return new ReferenceReadStream(_baseStream, _baseStreamOffset, Length);
@@ -86,4 +107,4 @@ public async Task SaveAsAsync(string path, CancellationToken cancellationToken)
86107
}
87108
}
88109
}
89-
}
110+
}

0 commit comments

Comments
 (0)