Skip to content

Commit ef169b2

Browse files
Markus Weimereerhardt
Markus Weimer
authored andcommitted
Issue 434: Fixed imprecise crefs in XML Docs (#485)
This fixes a couple of dangling `cref` in the XML Docs. This commit doesn't contain functional changes to the code. Issue: This closes #434
1 parent c491651 commit ef169b2

File tree

7 files changed

+10
-13
lines changed

7 files changed

+10
-13
lines changed

src/Microsoft.ML.Core/Environment/HostEnvironmentBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public interface IMessageSource
8787

8888
/// <summary>
8989
/// A <see cref="IHostEnvironment"/> that is also a channel listener can attach
90-
/// listeners for messages, as sent through <see cref="IChannelProvider.StartPipe"/>.
90+
/// listeners for messages, as sent through <see cref="IChannelProvider.StartPipe{TMessage}"/>.
9191
/// </summary>
9292
public interface IMessageDispatcher : IHostEnvironment
9393
{

src/Microsoft.ML.Core/Utilities/VBufferUtils.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1147,11 +1147,11 @@ private static void ApplyWithCoreCopy<TSrc, TDst>(ref VBuffer<TSrc> src, ref VBu
11471147
/// storing the result in <paramref name="dst"/>, overwriting any of its existing contents.
11481148
/// The contents of <paramref name="dst"/> do not affect calculation. If you instead wish
11491149
/// to calculate a function that reads and writes <paramref name="dst"/>, see
1150-
/// <see cref="ApplyWith"/> and <see cref="ApplyWithEitherDefined"/>. Post-operation,
1150+
/// <see cref="ApplyWith{TSrc,TDst}"/> and <see cref="ApplyWithEitherDefined{TSrc,TDst}"/>. Post-operation,
11511151
/// <paramref name="dst"/> will be dense iff <paramref name="src"/> is dense.
11521152
/// </summary>
1153-
/// <seealso cref="ApplyWith"/>
1154-
/// <seealso cref="ApplyWithEitherDefined"/>
1153+
/// <seealso cref="ApplyWith{TSrc,TDst}"/>
1154+
/// <seealso cref="ApplyWithEitherDefined{TSrc,TDst}"/>
11551155
public static void ApplyIntoEitherDefined<TSrc, TDst>(ref VBuffer<TSrc> src, ref VBuffer<TDst> dst, Func<int, TSrc, TDst> func)
11561156
{
11571157
Contracts.CheckValue(func, nameof(func));

src/Microsoft.ML.Data/DataView/Transposer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1405,7 +1405,7 @@ public static void GetSingleSlotValue<T>(this ITransposeDataView view, int col,
14051405
}
14061406

14071407
/// <summary>
1408-
/// The <see cref="ISlotCursor.GetGetter"/> is parameterized by a type that becomes the
1408+
/// The <see cref="ISlotCursor.GetGetter{TValue}"/> is parameterized by a type that becomes the
14091409
/// type parameter for a <see cref="VBuffer{T}"/>, and this is generally preferable and more
14101410
/// sensible but for various reasons it's often a lot simpler to have a get-getter be over
14111411
/// the actual type returned by the getter, that is, parameterize this by the actual

src/Microsoft.ML.Data/Depricated/Vector/VBufferMathUtils.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ public static void AddMultWithOffset(ref VBuffer<Float> src, Float c, ref VBuffe
350350
/// Perform in-place scaling of a vector into another vector as
351351
/// <c><paramref name="dst"/> = <paramref name="src"/> * <paramref name="c"/></c>.
352352
/// This is more or less equivalent to performing the same operation with
353-
/// <see cref="VBufferUtils.ApplyInto"/> except perhaps more efficiently,
353+
/// <see cref="VBufferUtils.ApplyInto{TSrc1,TSrc2,TDst}"/> except perhaps more efficiently,
354354
/// with one exception: if <paramref name="c"/> is 0 and <paramref name="src"/>
355355
/// is sparse, <paramref name="dst"/> will have a count of zero, instead of the
356356
/// same count as <paramref name="src"/>.

src/Microsoft.ML.Data/Scorers/BinaryClassifierScorer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ private static ISchemaBoundMapper WrapIfNeeded(IHostEnvironment env, ISchemaBoun
8282
/// <param name="labelNameType">The type of the label names from the metadata (either
8383
/// originating from the key value metadata of the training label column, or deserialized
8484
/// from the model of a bindable mapper)</param>
85-
/// <returns>Whether we can call <see cref="MultiClassClassifierScorer.LabelNameBindableMapper.CreateBound"/> with
85+
/// <returns>Whether we can call <see cref="MultiClassClassifierScorer.LabelNameBindableMapper.CreateBound{T}"/> with
8686
/// this mapper and expect it to succeed</returns>
8787
private static bool CanWrap(ISchemaBoundMapper mapper, ColumnType labelNameType)
8888
{

src/Microsoft.ML.Data/Scorers/MultiClassClassifierScorer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ private static ISchemaBoundMapper WrapIfNeeded(IHostEnvironment env, ISchemaBoun
452452
/// <param name="labelNameType">The type of the label names from the metadata (either
453453
/// originating from the key value metadata of the training label column, or deserialized
454454
/// from the model of a bindable mapper)</param>
455-
/// <returns>Whether we can call <see cref="LabelNameBindableMapper.CreateBound"/> with
455+
/// <returns>Whether we can call <see cref="LabelNameBindableMapper.CreateBound{T}"/> with
456456
/// this mapper and expect it to succeed</returns>
457457
public static bool CanWrap(ISchemaBoundMapper mapper, ColumnType labelNameType)
458458
{

test/Microsoft.ML.TestFramework/TestCommandBase.cs

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,13 @@
66
using System.Collections.Generic;
77
using System.IO;
88
using System.Linq;
9-
using Microsoft.ML.Runtime;
9+
using System.Threading;
10+
using System.Threading.Tasks;
1011
using Microsoft.ML.Runtime.Command;
1112
using Microsoft.ML.Runtime.Data;
12-
using Microsoft.ML.Runtime.EntryPoints;
1313
using Microsoft.ML.Runtime.Internal.Utilities;
14-
//using Microsoft.ML.Runtime.StandardLearners;
1514
using Microsoft.ML.Runtime.Model;
1615
using Microsoft.ML.Runtime.Tools;
17-
using System.Threading;
18-
using System.Threading.Tasks;
1916
using Xunit;
2017
using Xunit.Abstractions;
2118

0 commit comments

Comments
 (0)