From 47f2f451e3a55434915ce0b33be473148787b5c2 Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Tue, 7 Aug 2018 09:22:33 +1200 Subject: [PATCH] EnableEndpointRouting documentation (#8220) --- .../MvcOptions.cs | 29 ++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/src/Microsoft.AspNetCore.Mvc.Core/MvcOptions.cs b/src/Microsoft.AspNetCore.Mvc.Core/MvcOptions.cs index eb80659155..cafe4e746e 100644 --- a/src/Microsoft.AspNetCore.Mvc.Core/MvcOptions.cs +++ b/src/Microsoft.AspNetCore.Mvc.Core/MvcOptions.cs @@ -68,7 +68,34 @@ namespace Microsoft.AspNetCore.Mvc }; } - // REVIEW: Add documentation + /// + /// Gets or sets a value that determines if routing should use endpoints internally, or if legacy routing + /// logic should be used. Endpoint routing is used to match HTTP requests to MVC actions, and to generate + /// URLs with . + /// + /// + /// The default value is if the version is + /// or later; otherwise. + /// + /// + /// + /// This property is associated with a compatibility switch and can provide a different behavior depending on + /// the configured compatibility version for the application. See for + /// guidance and examples of setting the application's compatibility version. + /// + /// + /// Configuring the desired value of the compatibility switch by calling this property's setter will take + /// precedence over the value implied by the application's . + /// + /// + /// If the application's compatibility version is set to or + /// lower then this setting will have the value unless explicitly configured. + /// + /// + /// If the application's compatibility version is set to or + /// higher then this setting will have the value unless explicitly configured. + /// + /// public bool EnableEndpointRouting { get => _enableEndpointRouting.Value;