huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Address PR comments in product code 

- XML comment improvements
This commit is contained in:
Doug Bunting 2014-11-11 19:37:14 -08:00
parent 2982c72547
commit 6313a9682e
5 changed files with 40 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Microsoft.AspNet.Mvc.Core/Rendering/Html/DefaultHtmlGenerator.cs
View File

@ -185,7 +185,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <inheritdoc /> /// <inheritdoc />
public TagBuilder GenerateRouteForm( public TagBuilder GenerateRouteForm(
[NotNull]ViewContext viewContext, [NotNull] ViewContext viewContext,
string routeName, string routeName,
object routeValues, object routeValues,
string method, string method,
@ -810,7 +810,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
if (string.IsNullOrEmpty(method)) if (string.IsNullOrEmpty(method))
{ {
// Occurs only when called from a tag helper. // Occurs only when called from a tag helper.
method = FormMethod.Post.ToString(); method = FormMethod.Post.ToString().ToLowerInvariant();
} }
// For tag helpers, htmlAttributes will be null; replaceExisting value does not matter. // For tag helpers, htmlAttributes will be null; replaceExisting value does not matter.

8
src/Microsoft.AspNet.Mvc.Core/Rendering/Html/HtmlHelper.cs
View File

@ -617,7 +617,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the
/// <paramref name="actionName"/> method will process the request. /// the action with name <paramref name="actionName"/> will process the request.
/// </summary> /// </summary>
/// <param name="actionName">The name of the action method.</param> /// <param name="actionName">The name of the action method.</param>
/// <param name="controllerName">The name of the controller.</param> /// <param name="controllerName">The name of the controller.</param>
@ -661,8 +661,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. The route with name <paramref name="routeName"/>
/// <paramref name="routeName"/> route will forward the request to an action method. /// generates the &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>
/// <param name="routeValues"> /// <param name="routeValues">
@ -894,7 +894,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
protected virtual string GenerateValue(string name, object value, string format, bool useViewData) protected virtual string GenerateValue(string name, object value, string format, bool useViewData)
{ {
var fullName = DefaultHtmlGenerator.GetFullHtmlFieldName(ViewContext, name); var fullName = DefaultHtmlGenerator.GetFullHtmlFieldName(ViewContext, name);
var attemptedValue = var attemptedValue =
(string)DefaultHtmlGenerator.GetModelStateValue(ViewContext, fullName, typeof(string)); (string)DefaultHtmlGenerator.GetModelStateValue(ViewContext, fullName, typeof(string));
string resolvedValue; string resolvedValue;

8
src/Microsoft.AspNet.Mvc.Core/Rendering/Html/IHtmlGenerator.cs
View File

@ -49,8 +49,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
string name); string name);
/// <summary> /// <summary>
/// Generate a &lt;form&gt; element. When the user submits the form, the <paramref name="actionName"/> method /// Generate a &lt;form&gt; element. When the user submits the form, the action with name
/// will process the request. /// <paramref name="actionName"/> will process the request.
/// </summary> /// </summary>
/// <param name="viewContext">A <see cref="ViewContext"/> instance for the current scope.</param> /// <param name="viewContext">A <see cref="ViewContext"/> instance for the current scope.</param>
/// <param name="actionName">The name of the action method.</param> /// <param name="actionName">The name of the action method.</param>
@ -78,8 +78,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
object htmlAttributes); object htmlAttributes);
/// <summary> /// <summary>
/// Generate a &lt;form&gt; element. When the user submits the form, the <paramref name="routeName"/> route /// Generate a &lt;form&gt; element. The route with name <paramref name="routeName"/> generates the
/// will forward the request to an action method. /// &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="viewContext">A <see cref="ViewContext"/> instance for the current scope.</param> /// <param name="viewContext">A <see cref="ViewContext"/> instance for the current scope.</param>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>

55
src/Microsoft.AspNet.Mvc.Core/Rendering/HtmlHelperFormExtensions.cs
View File

@ -9,9 +9,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
public static class HtmlHelperFormExtensions public static class HtmlHelperFormExtensions
{ {
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, /// Renders a &lt;form&gt; start tag to the response. The &lt;form&gt;'s <c>action</c> attribute value will
/// the request will be processed by same action. That is the rendered URL will match the current /// match the current request.
/// request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <returns> /// <returns>
@ -29,7 +28,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the
/// current action method will process the request. /// current action will process the request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="method">The HTTP method for processing the form, either GET or POST.</param> /// <param name="method">The HTTP method for processing the form, either GET or POST.</param>
@ -47,7 +46,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the
/// current action method will process the request. /// current action will process the request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="method">The HTTP method for processing the form, either GET or POST.</param> /// <param name="method">The HTTP method for processing the form, either GET or POST.</param>
@ -73,7 +72,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the
/// current action method will process the request. /// current action will process the request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="routeValues"> /// <param name="routeValues">
@ -96,8 +95,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the action with name
/// <paramref name="actionName"/> method will process the request. /// <paramref name="actionName"/> will process the request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="actionName">The name of the action method.</param> /// <param name="actionName">The name of the action method.</param>
@ -118,8 +117,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the action with name
/// <paramref name="actionName"/> method will process the request. /// <paramref name="actionName"/> will process the request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="actionName">The name of the action method.</param> /// <param name="actionName">The name of the action method.</param>
@ -148,8 +147,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the action with name
/// <paramref name="actionName"/> method will process the request. /// <paramref name="actionName"/> will process the request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="actionName">The name of the action method.</param> /// <param name="actionName">The name of the action method.</param>
@ -172,8 +171,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the action with name
/// <paramref name="actionName"/> method will process the request. /// <paramref name="actionName"/> will process the request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="actionName">The name of the action method.</param> /// <param name="actionName">The name of the action method.</param>
@ -204,8 +203,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the action with name
/// <paramref name="actionName"/> method will process the request. /// <paramref name="actionName"/> will process the request.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="actionName">The name of the action method.</param> /// <param name="actionName">The name of the action method.</param>
@ -234,8 +233,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. The first route that can provide a URL with the
/// default route will forward the request to an action method. /// specified <paramref name="routeValues"/> generates the &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="routeValues"> /// <param name="routeValues">
@ -261,8 +260,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. The route with name <paramref name="routeName"/>
/// <paramref name="routeName"/> route will forward the request to an action method. /// generates the &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>
@ -282,8 +281,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. The route with name <paramref name="routeName"/>
/// <paramref name="routeName"/> route will forward the request to an action method. /// generates the &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>
@ -309,8 +308,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. The route with name <paramref name="routeName"/>
/// <paramref name="routeName"/> route will forward the request to an action method. /// generates the &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>
@ -330,8 +329,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. The route with name <paramref name="routeName"/>
/// <paramref name="routeName"/> route will forward the request to an action method. /// generates the &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>
@ -359,8 +358,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
} }
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. The route with name <paramref name="routeName"/>
/// <paramref name="routeName"/> route will forward the request to an action method. /// generates the &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param> /// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>

6
src/Microsoft.AspNet.Mvc.Core/Rendering/IHtmlHelper.cs
View File

@ -83,7 +83,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the
/// <paramref name="actionName"/> method will process the request. /// the action with name <paramref name="actionName"/> will process the request.
/// </summary> /// </summary>
/// <param name="actionName">The name of the action method.</param> /// <param name="actionName">The name of the action method.</param>
/// <param name="controllerName">The name of the controller.</param> /// <param name="controllerName">The name of the controller.</param>
@ -112,8 +112,8 @@ namespace Microsoft.AspNet.Mvc.Rendering
object htmlAttributes); object htmlAttributes);
/// <summary> /// <summary>
/// Renders a &lt;form&gt; start tag to the response. When the user submits the form, the /// Renders a &lt;form&gt; start tag to the response. The route with name <paramref name="routeName"/>
/// <paramref name="routeName"/> route will forward the request to an action method. /// generates the &lt;form&gt;'s <c>action</c> attribute value.
/// </summary> /// </summary>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>
/// <param name="routeValues"> /// <param name="routeValues">