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

Commit bcd1e25

Browse files
committed
Cleaning up the docs
1 parent e6202a4 commit bcd1e25

File tree

2 files changed

+15
-24
lines changed

2 files changed

+15
-24
lines changed

src/Microsoft.AspNet.Mvc.Core/Formatters/IOutputFormatter.cs

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,38 +18,22 @@ namespace Microsoft.AspNet.Mvc
1818
/// </summary>
1919
public interface IOutputFormatter
2020
{
21-
/// <summary>
22-
/// Gets the mutable collection of character encodings supported by
23-
/// this <see cref="IOutputFormatter"/> instance. The encodings are
24-
/// used when writing the data.
25-
/// </summary>
26-
List<Encoding> SupportedEncodings { get; }
27-
28-
/// <summary>
29-
/// Gets the mutable collection of <see cref="MediaTypeHeaderValue"/> elements supported by
30-
/// this <see cref="IOutputFormatter"/> instance.
31-
/// </summary>
32-
List<MediaTypeHeaderValue> SupportedMediaTypes { get; }
33-
3421
/// <summary>
3522
/// Determines whether this <see cref="IOutputFormatter"/> can serialize
3623
/// an object of the specified type.
3724
/// </summary>
3825
/// <param name="context">The formatter context associated with the call.</param>
3926
/// <param name="contentType">The desired contentType on the response.</param>
40-
/// <remarks>
41-
/// Subclasses can override this method to determine if the given content can be handled by this formatter.
42-
/// Subclasses should call the base implementation.
43-
/// </remarks>
44-
/// <returns>True if this <see cref="IOutputFormatter"/> is able to serialize the object
45-
/// represent by <paramref name="context"/>'s ObjectResult and supports the passed in
46-
/// <paramref name="contentType"/>.
27+
/// <returns>True if this <see cref="IOutputFormatter"/> supports the passed in
28+
/// <paramref name="contentType"/> and is able to serialize the object
29+
/// represent by <paramref name="context"/>'s Object property.
4730
/// False otherwise.</returns>
4831
bool CanWriteResult(OutputFormatterContext context, MediaTypeHeaderValue contentType);
4932

5033
/// <summary>
51-
/// Writes given <paramref name="value"/> to the HttpResponse <paramref name="response"/> body stream.
34+
/// Writes the object represented by <paramref name="context"/>'s Object property.
5235
/// </summary>
36+
/// <param name="context">The formatter context associated with the call.</param>
5337
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
5438
/// <returns>A Task that serializes the value to the <paramref name="context"/>'s response message.</returns>
5539
Task WriteAsync(OutputFormatterContext context, CancellationToken cancellationToken);

src/Microsoft.AspNet.Mvc.Core/Formatters/OutputFormatter.cs

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,17 @@ namespace Microsoft.AspNet.Mvc
1717
/// </summary>
1818
public abstract class OutputFormatter : IOutputFormatter
1919
{
20-
/// <inheritdoc />
20+
/// <summary>
21+
/// Gets the mutable collection of character encodings supported by
22+
/// this <see cref="OutputFormatter"/> instance. The encodings are
23+
/// used when writing the data.
24+
/// </summary>
2125
public List<Encoding> SupportedEncodings { get; private set; }
2226

23-
/// <inheritdoc />
27+
/// <summary>
28+
/// Gets the mutable collection of <see cref="MediaTypeHeaderValue"/> elements supported by
29+
/// this <see cref="OutputFormatter"/> instance.
30+
/// </summary>
2431
public List<MediaTypeHeaderValue> SupportedMediaTypes { get; private set; }
2532

2633
/// <summary>
@@ -128,7 +135,7 @@ public virtual void WriteResponseContentHeaders(OutputFormatterContext context)
128135
/// <summary>
129136
/// Writes the response body.
130137
/// </summary>
131-
/// <param name="context">The formatter context assoicated with the call.</param>
138+
/// <param name="context">The formatter context associated with the call.</param>
132139
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
133140
/// <returns></returns>
134141
public abstract Task WriteResponseBodyAsync(OutputFormatterContext context,

0 commit comments

Comments
 (0)