Add missing doc comments (#8035)
This commit is contained in:
parent
d1ee93b94b
commit
414d8a514f
|
|
@ -9,7 +9,6 @@ using System.Text;
|
||||||
using System.Text.Encodings.Web;
|
using System.Text.Encodings.Web;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using Microsoft.AspNetCore.Http;
|
using Microsoft.AspNetCore.Http;
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
|
||||||
using Microsoft.Extensions.FileProviders;
|
using Microsoft.Extensions.FileProviders;
|
||||||
|
|
||||||
namespace Microsoft.AspNetCore.StaticFiles
|
namespace Microsoft.AspNetCore.StaticFiles
|
||||||
|
|
@ -23,6 +22,10 @@ namespace Microsoft.AspNetCore.StaticFiles
|
||||||
|
|
||||||
private HtmlEncoder _htmlEncoder;
|
private HtmlEncoder _htmlEncoder;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Constructs the <see cref="HtmlDirectoryFormatter"/>.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="encoder">The character encoding representation to use.</param>
|
||||||
public HtmlDirectoryFormatter(HtmlEncoder encoder)
|
public HtmlDirectoryFormatter(HtmlEncoder encoder)
|
||||||
{
|
{
|
||||||
if (encoder == null)
|
if (encoder == null)
|
||||||
|
|
|
||||||
|
|
@ -12,11 +12,19 @@ namespace Microsoft.AspNetCore.StaticFiles
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class StaticFileResponseContext
|
public class StaticFileResponseContext
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Constructs the <see cref="StaticFileResponseContext"/>.
|
||||||
|
/// </summary>
|
||||||
[Obsolete("Use the constructor that passes in the HttpContext and IFileInfo parameters: StaticFileResponseContext(HttpContext context, IFileInfo file)", false)]
|
[Obsolete("Use the constructor that passes in the HttpContext and IFileInfo parameters: StaticFileResponseContext(HttpContext context, IFileInfo file)", false)]
|
||||||
public StaticFileResponseContext()
|
public StaticFileResponseContext()
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Constructs the <see cref="StaticFileResponseContext"/>.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="context">The request and response information.</param>
|
||||||
|
/// <param name="file">The file to be served.</param>
|
||||||
public StaticFileResponseContext(HttpContext context, IFileInfo file)
|
public StaticFileResponseContext(HttpContext context, IFileInfo file)
|
||||||
{
|
{
|
||||||
if (file == null)
|
if (file == null)
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ using Microsoft.AspNetCore.Mvc.Routing;
|
||||||
namespace Microsoft.AspNetCore.Mvc.Abstractions
|
namespace Microsoft.AspNetCore.Mvc.Abstractions
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Describes a MVC action.
|
/// Describes an MVC action.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class ActionDescriptor
|
public class ActionDescriptor
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -68,6 +68,9 @@ namespace Microsoft.AspNetCore.Mvc.ApplicationModels
|
||||||
Selectors = new List<SelectorModel>(other.Selectors.Select(s => new SelectorModel(s)));
|
Selectors = new List<SelectorModel>(other.Selectors.Select(s => new SelectorModel(s)));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The actions on this controller.
|
||||||
|
/// </summary>
|
||||||
public IList<ActionModel> Actions { get; }
|
public IList<ActionModel> Actions { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
@ -90,8 +93,14 @@ namespace Microsoft.AspNetCore.Mvc.ApplicationModels
|
||||||
|
|
||||||
string ICommonModel.Name => ControllerName;
|
string ICommonModel.Name => ControllerName;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The name of this controller.
|
||||||
|
/// </summary>
|
||||||
public string ControllerName { get; set; }
|
public string ControllerName { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The type of this controller.
|
||||||
|
/// </summary>
|
||||||
public TypeInfo ControllerType { get; }
|
public TypeInfo ControllerType { get; }
|
||||||
|
|
||||||
public IList<PropertyModel> ControllerProperties { get; }
|
public IList<PropertyModel> ControllerProperties { get; }
|
||||||
|
|
@ -120,6 +129,9 @@ namespace Microsoft.AspNetCore.Mvc.ApplicationModels
|
||||||
|
|
||||||
public IList<SelectorModel> Selectors { get; }
|
public IList<SelectorModel> Selectors { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The DisplayName of this controller.
|
||||||
|
/// </summary>
|
||||||
public string DisplayName
|
public string DisplayName
|
||||||
{
|
{
|
||||||
get
|
get
|
||||||
|
|
|
||||||
|
|
@ -105,6 +105,11 @@ namespace Microsoft.AspNetCore.Mvc.Localization
|
||||||
protected virtual LocalizedHtmlString ToHtmlString(LocalizedString result) =>
|
protected virtual LocalizedHtmlString ToHtmlString(LocalizedString result) =>
|
||||||
new LocalizedHtmlString(result.Name, result.Value, result.ResourceNotFound);
|
new LocalizedHtmlString(result.Name, result.Value, result.ResourceNotFound);
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Creates a new <see cref="LocalizedHtmlString"/> for a <see cref="LocalizedString"/>.
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="result">The <see cref="LocalizedString"/>.</param>
|
||||||
|
/// <param name="arguments">The value arguments which will be used in construting the message.</param>
|
||||||
protected virtual LocalizedHtmlString ToHtmlString(LocalizedString result, object[] arguments) =>
|
protected virtual LocalizedHtmlString ToHtmlString(LocalizedString result, object[] arguments) =>
|
||||||
new LocalizedHtmlString(result.Name, result.Value, result.ResourceNotFound, arguments);
|
new LocalizedHtmlString(result.Name, result.Value, result.ResourceNotFound, arguments);
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -9,6 +9,9 @@ using Newtonsoft.Json.Serialization;
|
||||||
|
|
||||||
namespace Microsoft.Extensions.DependencyInjection
|
namespace Microsoft.Extensions.DependencyInjection
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Extension methods for Mvc.Newtonsoft.Json options.
|
||||||
|
/// </summary>
|
||||||
public static class MvcNewtonsoftJsonOptionsExtensions
|
public static class MvcNewtonsoftJsonOptionsExtensions
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,9 @@ using Microsoft.Extensions.Options;
|
||||||
|
|
||||||
namespace Microsoft.Extensions.DependencyInjection
|
namespace Microsoft.Extensions.DependencyInjection
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Extension methods for adding Newtonsoft.Json to <see cref="MvcCoreBuilder"/>.
|
||||||
|
/// </summary>
|
||||||
public static class NewtonsoftJsonMvcCoreBuilderExtensions
|
public static class NewtonsoftJsonMvcCoreBuilderExtensions
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue