Add & fix crefs in XML document comments

* Add references to types where they are missing.

 * Fix incorrect references to closed generic types.

 * Convert member ID strings to proper references where they can be
   converted without breaking the build. The remaining member ID
   strings usually mean that the comment would have to be rephrased
   for at least one build target / platform.

 * Drop namespaces from type names where they are unnecessary.

 * Fix the odd typo and add additional <c> markup in a few places.
This commit is contained in:
stakx
2016-12-23 16:15:24 +01:00
parent 780100b81f
commit e19ac3f28c
59 changed files with 342 additions and 352 deletions
@@ -58,7 +58,7 @@ namespace Newtonsoft.Json.Utilities
}
/// <summary>
/// Adds the elements of the specified collection to the specified generic IList.
/// Adds the elements of the specified collection to the specified generic <see cref="IList{T}"/>.
/// </summary>
/// <param name="initial">The list to add to.</param>
/// <param name="collection">The collection of elements to add.</param>
+1 -1
View File
@@ -104,7 +104,7 @@ namespace Newtonsoft.Json.Utilities
}
/// <summary>
/// Gets a dictionary of the names and values of an Enum type.
/// Gets a dictionary of the names and values of an <see cref="Enum"/> type.
/// </summary>
/// <returns></returns>
public static IList<EnumValue<ulong>> GetNamesAndValues<T>() where T : struct
@@ -79,7 +79,7 @@
/// </summary>
/// <param name="parameters">Method parameters.</param>
/// <param name="types">Argument types.</param>
/// <param name="enableParamArray">Try to pack extra arguments into ParamArray.</param>
/// <param name="enableParamArray">Try to pack extra arguments into the last parameter when it is marked up with <see cref="ParamArrayAttribute"/>.</param>
/// <returns><c>true</c> if method can be called with given arguments, <c>false</c> otherwise.</returns>
private static bool FilterParameters(ParameterInfo[] parameters, IList<Type> types, bool enableParamArray)
{
@@ -28,7 +28,7 @@ using System;
namespace Newtonsoft.Json.Utilities
{
/// <summary>
/// Builds a string. Unlike StringBuilder this class lets you reuse it's internal buffer.
/// Builds a string. Unlike <see cref="System.Text.StringBuilder"/> this class lets you reuse its internal buffer.
/// </summary>
internal struct StringBuffer
{