Skip to content

Commit

Permalink
fix broken docs (#108094)
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp authored Sep 21, 2024
1 parent bbe61b9 commit 557c45e
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ internal static MessageContainer CreateErrorMessage(MessageOrigin? origin, Diagn
/// <param name="text">Humanly readable message describing the warning</param>
/// <param name="code">Unique warning ID. Please see https://github.com/dotnet/runtime/blob/main/docs/tools/illink/error-codes.md
/// for the list of warnings and possibly add a new one</param>
/// /// <param name="origin">Filename or member where the warning is coming from</param>
/// <param name="origin">Filename or member where the warning is coming from</param>
/// <param name="subcategory">Optionally, further categorize this warning</param>
/// <param name="version">Optional warning version number. Versioned warnings can be controlled with the
/// warning wave option --warn VERSION. Unversioned warnings are unaffected by this option. </param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public class RuntimeFunction
/// <summary>
/// The size of the code block in bytes
/// </summary>
/// /// <remarks>
/// <remarks>
/// The EndAddress field in the runtime functions section is conditional on machine type
/// Size is -1 for images without the EndAddress field
/// </remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ public static void ExpectNoError(FileSystemWatcher watcher, Action action, Actio
Assert.False(TryErrorEvent(watcher, action, cleanup, attempts, expected: true), message);
}

/// /// <summary>
/// <summary>
/// Helper method for the ExpectError/ExpectNoError functions.
/// </summary>
/// <param name="watcher">The FileSystemWatcher to test</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3124,7 +3124,7 @@ public static int BinarySearch<T, TComparable>(
/// <param name="span">The sorted <see cref="Span{T}"/> to search.</param>
/// <param name="value">The object to locate. The value can be null for reference types.</param>
/// <param name="comparer">The <typeparamref name="TComparer"/> to use when comparing.</param>
/// /// <returns>
/// <returns>
/// The zero-based index of <paramref name="value"/> in the sorted <paramref name="span"/>,
/// if <paramref name="value"/> is found; otherwise, a negative number that is the bitwise complement
/// of the index of the next element that is larger than <paramref name="value"/> or, if there is
Expand Down Expand Up @@ -3198,7 +3198,7 @@ public static int BinarySearch<T, TComparable>(
/// <param name="span">The sorted <see cref="ReadOnlySpan{T}"/> to search.</param>
/// <param name="value">The object to locate. The value can be null for reference types.</param>
/// <param name="comparer">The <typeparamref name="TComparer"/> to use when comparing.</param>
/// /// <returns>
/// <returns>
/// The zero-based index of <paramref name="value"/> in the sorted <paramref name="span"/>,
/// if <paramref name="value"/> is found; otherwise, a negative number that is the bitwise complement
/// of the index of the next element that is larger than <paramref name="value"/> or, if there is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public static SearchValues<byte> Create(params ReadOnlySpan<byte> values)
/// Creates an optimized representation of <paramref name="values"/> used for efficient searching.
/// </summary>
/// <param name="values">The set of values.</param>
/// /// <returns>The optimized representation of <paramref name="values"/> used for efficient searching.</returns>
/// <returns>The optimized representation of <paramref name="values"/> used for efficient searching.</returns>
public static SearchValues<char> Create(params ReadOnlySpan<char> values)
{
if (values.IsEmpty)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ private bool IsSubset(XmlQueryCardinality other) {

/// <summary>
/// Returns true is right is subset of left.
/// /// </summary>
/// </summary>
public static bool operator >=(XmlQueryCardinality left, XmlQueryCardinality right)
{
return (right._value & ~left._value) == 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -709,7 +709,7 @@ public static ServiceController[] GetServices()

/// <summary>
/// Gets the services (not including device-driver services) on the given machine name.
/// /// </summary>
/// </summary>
/// <param name="machineName">Name of the machine</param>
/// <returns></returns>
public static ServiceController[] GetServices(string machineName)
Expand Down
2 changes: 1 addition & 1 deletion src/tools/illink/src/linker/Linker/MessageContainer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ public static MessageContainer CreateCustomErrorMessage (string text, int code,
/// <param name="text">Humanly readable message describing the warning</param>
/// <param name="code">Unique warning ID. Please see https://github.com/dotnet/runtime/blob/main/docs/tools/illink/error-codes.md
/// for the list of warnings and possibly add a new one</param>
/// /// <param name="origin">Filename or member where the warning is coming from</param>
/// <param name="origin">Filename or member where the warning is coming from</param>
/// <param name="subcategory">Optionally, further categorize this warning</param>
/// <param name="version">Optional warning version number. Versioned warnings can be controlled with the
/// warning wave option --warn VERSION. Unversioned warnings are unaffected by this option. </param>
Expand Down

0 comments on commit 557c45e

Please sign in to comment.