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

Simplify some XML comment references 

- follow VS fixup suggestion and change e.g. `<see cref="System.String"/>` -> `<see cref="string"/>`
This commit is contained in:
dougbu 2014-08-07 17:25:06 -07:00
parent 147b4416b5
commit d95b85d057
6 changed files with 30 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -16,7 +16,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// Returns the display name for the current model.
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <returns>A <see cref="String"/> containing the display name.</returns>
/// <returns>A <see cref="string"/> containing the display name.</returns>
public static string DisplayNameForModel([NotNull] this IHtmlHelper htmlHelper)
{
return htmlHelper.DisplayName(expression: null);
@ -32,7 +32,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <param name="expression">The expression to be evaluated against an item in the current model.</param>
/// <typeparam name="TModelItem">The type of items in the model collection.</typeparam>
/// <typeparam name="TValue">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A <see cref="String"/> containing the display name.</returns>
/// <returns>A <see cref="string"/> containing the display name.</returns>
public static string DisplayNameFor<TModelItem, TValue>(
[NotNull] this IHtmlHelper<IEnumerable<TModelItem>> htmlHelper,
[NotNull] Expression<Func<TModelItem, TValue>> expression)

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

@ -12,7 +12,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// Returns the full HTML element name for the current model.
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <returns>A <see cref="System.String"/> containing the element name.</returns>
/// <returns>A <see cref="string"/> containing the element name.</returns>
public static string NameForModel([NotNull] this IHtmlHelper htmlHelper)
{
return htmlHelper.Name(name: null);
@ -22,7 +22,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// Returns the HTML element Id for the current model.
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <returns>A <see cref="System.String"/> containing the element Id.</returns>
/// <returns>A <see cref="string"/> containing the element Id.</returns>
public static string IdForModel([NotNull] this IHtmlHelper htmlHelper)
{
return htmlHelper.Id(name: null);

18
src/Microsoft.AspNet.Mvc.Core/Rendering/HtmlHelperValueExtensions.cs
View File

@ -16,9 +16,9 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="name">Expression name, relative to the current model.</param>
/// <returns>A <see cref="String"/> containing the formatted value.</returns>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>
/// Converts the expression <paramref name="name"/> result to a <see cref="String"/> directly.
/// Converts the expression <paramref name="name"/> result to a <see cref="string"/> directly.
/// </remarks>
public static string Value([NotNull] this IHtmlHelper htmlHelper, string name)
{
@ -32,9 +32,9 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <param name="expression">The expression to be evaluated against the current model.</param>
/// <typeparam name="TModel">The type of the model.</typeparam>
/// <typeparam name="TProperty">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A <see cref="String"/> containing the formatted value.</returns>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>
/// Converts the <paramref name="expression"/> result to a <see cref="String"/> directly.
/// Converts the <paramref name="expression"/> result to a <see cref="string"/> directly.
/// </remarks>
public static string ValueFor<TModel, TProperty>(
[NotNull] this IHtmlHelper<TModel> htmlHelper,
@ -47,9 +47,9 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// Returns the formatted value for the current model.
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <returns>A <see cref="String"/> containing the formatted value.</returns>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>
/// Converts the model value to a <see cref="String"/> directly.
/// Converts the model value to a <see cref="string"/> directly.
/// </remarks>
public static string ValueForModel([NotNull] this IHtmlHelper htmlHelper)
{
@ -61,11 +61,11 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="format">
/// The composite format <see cref="String"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// </param>
/// <returns>A <see cref="String"/> containing the formatted value.</returns>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>
/// Converts the model value to a <see cref="String"/> directly if
/// Converts the model value to a <see cref="string"/> directly if
/// <paramref name="format"/> is <c>null</c> or empty.
/// </remarks>
public static string ValueForModel([NotNull] this IHtmlHelper htmlHelper, string format)

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

@ -151,7 +151,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// Returns the display name for the specified expression <paramref name="expression"/>.
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <returns>A <see cref="System.String"/> containing the display name.</returns>
/// <returns>A <see cref="string"/> containing the display name.</returns>
string DisplayName(string expression);
/// <summary>
@ -159,7 +159,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// </summary>
/// <param name="name">Expression name, relative to the current model.</param>
/// <returns>
/// A <see cref="System.String"/> containing the simple display text.
/// A <see cref="string"/> containing the simple display text.
/// If the expression result is <c>null</c>, returns <see cref="ModelMetadata.NullDisplayText"/>.
/// </returns>
string DisplayText(string name);
@ -242,7 +242,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// Returns information about about client validation rules for the given <paramref name="metadata"/> or
/// <paramref name="name"/>. Intended for use in <see cref="IHtmlHelper"/> extension methods.
/// </summary>
/// <param name="metadata">Metadata about the <see cref="System.Object"/> of interest.</param>
/// <param name="metadata">Metadata about the <see cref="object"/> of interest.</param>
/// <param name="name">Expression name, relative to the current model. Used to determine
/// <see cref="ModelMetadata"/> when <paramref name="metadata"/> is <c>null</c>; ignored
/// otherwise.</param>
@ -269,7 +269,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// Returns the HTML element Id for the specified expression <paramref name="name"/>.
/// </summary>
/// <param name="name">Expression name, relative to the current model.</param>
/// <returns>A <see cref="System.String"/> containing the element Id.</returns>
/// <returns>A <see cref="string"/> containing the element Id.</returns>
string Id(string name);
/// <summary>
@ -303,7 +303,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// Returns the full HTML element name for the specified expression <paramref name="name"/>.
/// </summary>
/// <param name="name">Expression name, relative to the current model.</param>
/// <returns>A <see cref="System.String"/> containing the element name.</returns>
/// <returns>A <see cref="string"/> containing the element name.</returns>
string Name(string name);
/// <summary>
@ -483,12 +483,11 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// </summary>
/// <param name="name">Expression name, relative to the current model.</param>
/// <param name="format">
/// The composite format <see cref="System.String"/>
/// (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// </param>
/// <returns>A <see cref="System.String"/> containing the formatted value.</returns>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>
/// Converts the expression result to a <see cref="System.String"/> directly if
/// Converts the expression result to a <see cref="string"/> directly if
/// <paramref name="format"/> is <c>null</c> or empty.
/// </remarks>
string Value(string name, string format);

16
src/Microsoft.AspNet.Mvc.Core/Rendering/IHtmlHelperOfT.cs
View File

@ -58,7 +58,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// </summary>
/// <param name="expression">The expression to be evaluated against the current model.</param>
/// <typeparam name="TValue">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A <see cref="String"/> containing the display name.</returns>
/// <returns>A <see cref="string"/> containing the display name.</returns>
string DisplayNameFor<TValue>([NotNull] Expression<Func<TModel, TValue>> expression);
/// <summary>
@ -68,7 +68,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <param name="expression">The expression to be evaluated against an item in the current model.</param>
/// <typeparam name="TModelItem">The type of items in the model collection.</typeparam>
/// <typeparam name="TValue">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A <see cref="String"/> containing the display name.</returns>
/// <returns>A <see cref="string"/> containing the display name.</returns>
string DisplayNameForInnerType<TModelItem, TValue>(
[NotNull] Expression<Func<TModelItem, TValue>> expression);
@ -78,7 +78,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// <param name="expression">The expression to be evaluated against the current model.</param>
/// <typeparam name="TValue">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>
/// A <see cref="String"/> containing the simple display text.
/// A <see cref="string"/> containing the simple display text.
/// If the <paramref name="expression"/> result is <c>null</c>, returns
/// <see cref="ModelBinding.ModelMetadata.NullDisplayText"/>.
/// </returns>
@ -147,7 +147,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// </summary>
/// <param name="expression">The expression to be evaluated against the current model.</param>
/// <typeparam name="TProperty">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A <see cref="String"/> containing the element Id.</returns>
/// <returns>A <see cref="string"/> containing the element Id.</returns>
string IdFor<TProperty>([NotNull] Expression<Func<TModel, TProperty>> expression);
/// <summary>
@ -189,7 +189,7 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// </summary>
/// <param name="expression">The expression to be evaluated against the current model.</param>
/// <typeparam name="TProperty">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A <see cref="String"/> containing the element name.</returns>
/// <returns>A <see cref="string"/> containing the element name.</returns>
string NameFor<TProperty>([NotNull] Expression<Func<TModel, TProperty>> expression);
/// <summary>
@ -272,12 +272,12 @@ namespace Microsoft.AspNet.Mvc.Rendering
/// </summary>
/// <param name="expression">The expression to be evaluated against the current model.</param>
/// <param name="format">
/// The composite format <see cref="String"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// </param>
/// <typeparam name="TProperty">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A <see cref="String"/> containing the formatted value.</returns>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>
/// Converts the <paramref name="expression"/> result to a <see cref="String"/> directly if
/// Converts the <paramref name="expression"/> result to a <see cref="string"/> directly if
/// <paramref name="format"/> is <c>null</c> or empty.
/// </remarks>
string ValueFor<TProperty>([NotNull] Expression<Func<TModel, TProperty>> expression, string format);

2
src/Microsoft.AspNet.Mvc.ModelBinding/Validation/ModelClientValidationRule.cs
View File

@ -27,7 +27,7 @@ namespace Microsoft.AspNet.Mvc.ModelBinding
/// <summary>
/// Identifier of the <see cref="ModelClientValidationRule"/>. If client-side validation is enabled, default
/// validation attribute generator uses this <see cref="String"/> as part of the generated "data-val"
/// validation attribute generator uses this <see cref="string"/> as part of the generated "data-val"
/// attribute name. Must be unique in the set of enabled validation rules.
/// </summary>
public string ValidationType { get; private set; }