Skip to content

Commit 284501e

Browse files
Markus WeimerMarkus Weimer
Markus Weimer
authored and
Markus Weimer
committed
Issue 434: Fixed imprecise crefs in XML Docs
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 dec0d9e commit 284501e

File tree

6 files changed

+8
-7
lines changed

6 files changed

+8
-7
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.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: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
using Microsoft.ML.Runtime.Tools;
1616
using System.Threading;
1717
using System.Threading.Tasks;
18+
using Microsoft.ML.Runtime.Command;
1819
using Xunit;
1920
using Xunit.Abstractions;
2021

@@ -308,7 +309,7 @@ protected bool TestCore(RunContextBase ctx, string cmdName, string args, params
308309
/// </summary>
309310
/// <param name="env">The environment to use.</param>
310311
/// <param name="writer">
311-
/// The writer to print the <see cref="ProgressLogLine"/>. Usually this should be the same writer that is used in <paramref name="env"/>.
312+
/// The writer to print the <see cref="BaseTestBaseline.ProgressLogLine"/>. Usually this should be the same writer that is used in <paramref name="env"/>.
312313
/// </param>
313314
/// <param name="args">The arguments for MAML.</param>
314315
/// <param name="printProgress">Whether to print the progress summary. If true, progress summary will appear in the end of baseline output file.</param>
@@ -591,7 +592,7 @@ protected OutputPath FoldModelPath(int fold)
591592

592593
/// <summary>
593594
/// Creates an output path with a suffix based on the test name. For new tests please
594-
/// do not use this, but instead utilize the <see cref="RunContextBase.InitPath"/>
595+
/// do not use this, but instead utilize the <see cref="TestCommandBase.RunContextBase.InitPath"/>
595596
/// method.
596597
/// </summary>
597598
protected OutputPath CreateOutputPath(string suffix)

0 commit comments

Comments
 (0)