Skip to content

Commit 3e253f6

Browse files
PilchiePilchie
committed
Add XML docs to pubternal types
1 parent 50660f3 commit 3e253f6

27 files changed

+136
-10
lines changed

‎src/Components/Analyzers/src/ComponentInternalUsageDiagnosticAnalzyer.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99
namespace Microsoft.Extensions.Internal
1010
{
11+
/// <summary>
12+
/// This API supports infrastructure and is not intended to be used
13+
/// directly from your code. This API may change or be removed in future releases.
14+
/// </summary>
1115
[DiagnosticAnalyzer(LanguageNames.CSharp)]
1216
public class ComponentInternalUsageDiagnosticAnalyzer : DiagnosticAnalyzer
1317
{

‎src/DataProtection/DataProtection/src/KeyManagement/Internal/DefaultKeyResolution.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
77
{
8+
/// <summary>
9+
/// This API supports infrastructure and is not intended to be used
10+
/// directly from your code. This API may change or be removed in future releases.
11+
/// </summary>
812
public struct DefaultKeyResolution
913
{
1014
/// <summary>

‎src/DataProtection/DataProtection/src/KeyManagement/Internal/ICacheableKeyRingProvider.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
77
{
8+
/// <summary>
9+
/// This API supports infrastructure and is not intended to be used
10+
/// directly from your code. This API may change or be removed in future releases.
11+
/// </summary>
812
public interface ICacheableKeyRingProvider
913
{
1014
CacheableKeyRing GetCacheableKeyRing(DateTimeOffset now);

‎src/DataProtection/DataProtection/src/KeyManagement/Internal/IInternalXmlKeyManager.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88
namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
99
{
10+
/// <summary>
11+
/// This API supports infrastructure and is not intended to be used
12+
/// directly from your code. This API may change or be removed in future releases.
13+
/// </summary>
1014
public interface IInternalXmlKeyManager
1115
{
1216
IKey CreateNewKey(Guid keyId, DateTimeOffset creationDate, DateTimeOffset activationDate, DateTimeOffset expirationDate);

‎src/DataProtection/DataProtection/src/KeyManagement/Internal/IKeyRingProvider.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
55
{
6+
/// <summary>
7+
/// This API supports infrastructure and is not intended to be used
8+
/// directly from your code. This API may change or be removed in future releases.
9+
/// </summary>
610
public interface IKeyRingProvider
711
{
812
IKeyRing GetCurrentKeyRing();

‎src/Features/JsonPatch/src/Internal/ConversionResult.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
namespace Microsoft.AspNetCore.JsonPatch.Internal
55
{
6+
/// <summary>
7+
/// This API supports infrastructure and is not intended to be used
8+
/// directly from your code. This API may change or be removed in future releases.
9+
/// </summary>
610
public class ConversionResult
711
{
812
public ConversionResult(bool canBeConverted, object convertedInstance)
@@ -14,4 +18,4 @@ public ConversionResult(bool canBeConverted, object convertedInstance)
1418
public bool CanBeConverted { get; }
1519
public object ConvertedInstance { get; }
1620
}
17-
}
21+
}

‎src/Features/JsonPatch/src/Internal/ConversionResultProvider.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88
namespace Microsoft.AspNetCore.JsonPatch.Internal
99
{
10+
/// <summary>
11+
/// This API supports infrastructure and is not intended to be used
12+
/// directly from your code. This API may change or be removed in future releases.
13+
/// </summary>
1014
public static class ConversionResultProvider
1115
{
1216
public static ConversionResult ConvertTo(object value, Type typeToConvertTo)

‎src/Features/JsonPatch/src/Internal/DictionaryAdapterOfTU.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99
namespace Microsoft.AspNetCore.JsonPatch.Internal
1010
{
11+
/// <summary>
12+
/// This API supports infrastructure and is not intended to be used
13+
/// directly from your code. This API may change or be removed in future releases.
14+
/// </summary>
1115
public class DictionaryAdapter<TKey, TValue> : IAdapter
1216
{
1317
public virtual bool TryAdd(

‎src/Features/JsonPatch/src/Internal/DynamicObjectAdapter.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313

1414
namespace Microsoft.AspNetCore.JsonPatch.Internal
1515
{
16+
/// <summary>
17+
/// This API supports infrastructure and is not intended to be used
18+
/// directly from your code. This API may change or be removed in future releases.
19+
/// </summary>
1620
public class DynamicObjectAdapter : IAdapter
1721
{
1822
public virtual bool TryAdd(

‎src/Features/JsonPatch/src/Internal/IAdapter.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
namespace Microsoft.AspNetCore.JsonPatch.Internal
77
{
8+
/// <summary>
9+
/// This API supports infrastructure and is not intended to be used
10+
/// directly from your code. This API may change or be removed in future releases.
11+
/// </summary>
812
public interface IAdapter
913
{
1014
bool TryTraverse(

‎src/Features/JsonPatch/src/Internal/ListAdapter.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111

1212
namespace Microsoft.AspNetCore.JsonPatch.Internal
1313
{
14+
/// <summary>
15+
/// This API supports infrastructure and is not intended to be used
16+
/// directly from your code. This API may change or be removed in future releases.
17+
/// </summary>
1418
public class ListAdapter : IAdapter
1519
{
1620
public virtual bool TryAdd(
@@ -318,6 +322,10 @@ protected virtual bool TryGetPositionInfo(
318322
}
319323
}
320324

325+
/// <summary>
326+
/// This API supports infrastructure and is not intended to be used
327+
/// directly from your code. This API may change or be removed in future releases.
328+
/// </summary>
321329
protected readonly struct PositionInfo
322330
{
323331
public PositionInfo(PositionType type, int index)
@@ -330,6 +338,10 @@ public PositionInfo(PositionType type, int index)
330338
public int Index { get; }
331339
}
332340

341+
/// <summary>
342+
/// This API supports infrastructure and is not intended to be used
343+
/// directly from your code. This API may change or be removed in future releases.
344+
/// </summary>
333345
protected enum PositionType
334346
{
335347
Index, // valid index
@@ -338,6 +350,10 @@ protected enum PositionType
338350
OutOfBounds
339351
}
340352

353+
/// <summary>
354+
/// This API supports infrastructure and is not intended to be used
355+
/// directly from your code. This API may change or be removed in future releases.
356+
/// </summary>
341357
protected enum OperationType
342358
{
343359
Add,

‎src/Features/JsonPatch/src/Internal/ObjectVisitor.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88
namespace Microsoft.AspNetCore.JsonPatch.Internal
99
{
10+
/// <summary>
11+
/// This API supports infrastructure and is not intended to be used
12+
/// directly from your code. This API may change or be removed in future releases.
13+
/// </summary>
1014
public class ObjectVisitor
1115
{
1216
private readonly IAdapterFactory _adapterFactory;
@@ -30,7 +34,7 @@ public ObjectVisitor(ParsedPath path, IContractResolver contractResolver)
3034
/// <param name="contractResolver">The <see cref="IContractResolver"/>.</param>
3135
/// <param name="adapterFactory">The <see cref="IAdapterFactory"/> to use when creating adaptors.</param>
3236
public ObjectVisitor(ParsedPath path, IContractResolver contractResolver, IAdapterFactory adapterFactory)
33-
{
37+
{
3438
_path = path;
3539
_contractResolver = contractResolver ?? throw new ArgumentNullException(nameof(contractResolver));
3640
_adapterFactory = adapterFactory ?? throw new ArgumentNullException(nameof(adapterFactory));
@@ -55,7 +59,7 @@ public bool TryVisit(ref object target, out IAdapter adapter, out string errorMe
5559
adapter = null;
5660
return false;
5761
}
58-
62+
5963
// If we hit a null on an interior segment then we need to stop traversing.
6064
if (next == null)
6165
{

‎src/Features/JsonPatch/src/Internal/ParsedPath.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99
namespace Microsoft.AspNetCore.JsonPatch.Internal
1010
{
11+
/// <summary>
12+
/// This API supports infrastructure and is not intended to be used
13+
/// directly from your code. This API may change or be removed in future releases.
14+
/// </summary>
1115
public readonly struct ParsedPath
1216
{
1317
private static readonly string[] Empty = null;

‎src/Features/JsonPatch/src/Internal/PocoAdapter.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010

1111
namespace Microsoft.AspNetCore.JsonPatch.Internal
1212
{
13+
/// <summary>
14+
/// This API supports infrastructure and is not intended to be used
15+
/// directly from your code. This API may change or be removed in future releases.
16+
/// </summary>
1317
public class PocoAdapter : IAdapter
1418
{
1519
public virtual bool TryAdd(

‎src/Tools/Shared/CommandLine/CliContext.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
namespace Microsoft.Extensions.Tools.Internal
77
{
8+
/// <summary>
9+
/// This API supports infrastructure and is not intended to be used
10+
/// directly from your code. This API may change or be removed in future releases.
11+
/// </summary>
812
public static class CliContext
913
{
1014
/// <summary>

‎src/Tools/Shared/CommandLine/ConsoleReporter.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
namespace Microsoft.Extensions.Tools.Internal
88
{
9+
/// <summary>
10+
/// This API supports infrastructure and is not intended to be used
11+
/// directly from your code. This API may change or be removed in future releases.
12+
/// </summary>
913
public class ConsoleReporter : IReporter
1014
{
1115
private readonly object _writeLock = new object();

‎src/Tools/Shared/CommandLine/DebugHelper.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88
namespace Microsoft.Extensions.Tools.Internal
99
{
10+
/// <summary>
11+
/// This API supports infrastructure and is not intended to be used
12+
/// directly from your code. This API may change or be removed in future releases.
13+
/// </summary>
1014
public static class DebugHelper
1115
{
1216
[Conditional("DEBUG")]
@@ -21,4 +25,4 @@ public static void HandleDebugSwitch(ref string[] args)
2125
}
2226
}
2327
}
24-
}
28+
}

‎src/Tools/Shared/CommandLine/IConsole.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
namespace Microsoft.Extensions.Tools.Internal
88
{
9+
/// <summary>
10+
/// This API supports infrastructure and is not intended to be used
11+
/// directly from your code. This API may change or be removed in future releases.
12+
/// </summary>
913
public interface IConsole
1014
{
1115
event ConsoleCancelEventHandler CancelKeyPress;

‎src/Tools/Shared/CommandLine/IReporter.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@
33

44
namespace Microsoft.Extensions.Tools.Internal
55
{
6+
/// <summary>
7+
/// This API supports infrastructure and is not intended to be used
8+
/// directly from your code. This API may change or be removed in future releases.
9+
/// </summary>
610
public interface IReporter
711
{
812
void Verbose(string message);
913
void Output(string message);
1014
void Warn(string message);
1115
void Error(string message);
1216
}
13-
}
17+
}

‎src/Tools/Shared/CommandLine/NullReporter.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
namespace Microsoft.Extensions.Tools.Internal
55
{
6+
/// <summary>
7+
/// This API supports infrastructure and is not intended to be used
8+
/// directly from your code. This API may change or be removed in future releases.
9+
/// </summary>
610
public class NullReporter : IReporter
711
{
812
private NullReporter()

‎src/Tools/Shared/CommandLine/PhysicalConsole.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
namespace Microsoft.Extensions.Tools.Internal
88
{
9+
/// <summary>
10+
/// This API supports infrastructure and is not intended to be used
11+
/// directly from your code. This API may change or be removed in future releases.
12+
/// </summary>
913
public class PhysicalConsole : IConsole
1014
{
1115
private PhysicalConsole()

‎src/Tools/dotnet-user-secrets/src/Internal/CommandContext.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
namespace Microsoft.Extensions.SecretManager.Tools.Internal
77
{
8+
/// <summary>
9+
/// This API supports infrastructure and is not intended to be used
10+
/// directly from your code. This API may change or be removed in future releases.
11+
/// </summary>
812
public class CommandContext
913
{
1014
public CommandContext(
@@ -21,4 +25,4 @@ public CommandContext(
2125
public IReporter Reporter { get; }
2226
public SecretsStore SecretStore { get; }
2327
}
24-
}
28+
}

‎src/Tools/dotnet-user-secrets/src/Internal/ICommand.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33

44
namespace Microsoft.Extensions.SecretManager.Tools.Internal
55
{
6+
/// <summary>
7+
/// This API supports infrastructure and is not intended to be used
8+
/// directly from your code. This API may change or be removed in future releases.
9+
/// </summary>
610
public interface ICommand
711
{
812
void Execute(CommandContext context);
913
}
10-
}
14+
}

‎src/Tools/dotnet-user-secrets/src/Internal/InitCommand.cs

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@
1010

1111
namespace Microsoft.Extensions.SecretManager.Tools.Internal
1212
{
13-
// Workaround used to handle the fact that the options have not been parsed at configuration time
13+
/// <summary>
14+
/// This API supports infrastructure and is not intended to be used
15+
/// directly from your code. This API may change or be removed in future releases.
16+
/// </summary>
17+
/// <remarks>
18+
/// Workaround used to handle the fact that the options have not been parsed at configuration time
19+
/// </remarks>
1420
public class InitCommandFactory : ICommand
1521
{
1622
public CommandLineOptions Options { get; }
@@ -42,6 +48,10 @@ public void Execute(CommandContext context, string workingDirectory)
4248
}
4349
}
4450

51+
/// <summary>
52+
/// This API supports infrastructure and is not intended to be used
53+
/// directly from your code. This API may change or be removed in future releases.
54+
/// </summary>
4555
public class InitCommand : ICommand
4656
{
4757
public string OverrideId { get; }

‎src/Tools/dotnet-user-secrets/src/Internal/ProjectIdResolver.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111

1212
namespace Microsoft.Extensions.SecretManager.Tools.Internal
1313
{
14+
/// <summary>
15+
/// This API supports infrastructure and is not intended to be used
16+
/// directly from your code. This API may change or be removed in future releases.
17+
/// </summary>
1418
public class ProjectIdResolver
1519
{
1620
private const string DefaultConfig = "Debug";

‎src/Tools/dotnet-user-secrets/src/Internal/ReadableJsonConfigurationSource.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
namespace Microsoft.Extensions.SecretManager.Tools.Internal
88
{
9+
/// <summary>
10+
/// This API supports infrastructure and is not intended to be used
11+
/// directly from your code. This API may change or be removed in future releases.
12+
/// </summary>
913
public class ReadableJsonConfigurationProvider : JsonConfigurationProvider
1014
{
1115
public ReadableJsonConfigurationProvider()
@@ -15,4 +19,4 @@ public ReadableJsonConfigurationProvider()
1519

1620
public IDictionary<string, string> CurrentData => Data;
1721
}
18-
}
22+
}

0 commit comments

Comments
 (0)