diff --git a/src/Components/Analyzers/src/ComponentInternalUsageDiagnosticAnalzyer.cs b/src/Components/Analyzers/src/ComponentInternalUsageDiagnosticAnalzyer.cs index 3f0c765614..8f6272c326 100644 --- a/src/Components/Analyzers/src/ComponentInternalUsageDiagnosticAnalzyer.cs +++ b/src/Components/Analyzers/src/ComponentInternalUsageDiagnosticAnalzyer.cs @@ -8,6 +8,10 @@ using Microsoft.CodeAnalysis.Diagnostics; namespace Microsoft.Extensions.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// [DiagnosticAnalyzer(LanguageNames.CSharp)] public class ComponentInternalUsageDiagnosticAnalyzer : DiagnosticAnalyzer { diff --git a/src/DataProtection/DataProtection/src/KeyManagement/Internal/DefaultKeyResolution.cs b/src/DataProtection/DataProtection/src/KeyManagement/Internal/DefaultKeyResolution.cs index 1c4170607b..83dbf61096 100644 --- a/src/DataProtection/DataProtection/src/KeyManagement/Internal/DefaultKeyResolution.cs +++ b/src/DataProtection/DataProtection/src/KeyManagement/Internal/DefaultKeyResolution.cs @@ -5,6 +5,10 @@ using Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption; namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public struct DefaultKeyResolution { /// diff --git a/src/DataProtection/DataProtection/src/KeyManagement/Internal/ICacheableKeyRingProvider.cs b/src/DataProtection/DataProtection/src/KeyManagement/Internal/ICacheableKeyRingProvider.cs index 367080f2b8..7c41388532 100644 --- a/src/DataProtection/DataProtection/src/KeyManagement/Internal/ICacheableKeyRingProvider.cs +++ b/src/DataProtection/DataProtection/src/KeyManagement/Internal/ICacheableKeyRingProvider.cs @@ -5,6 +5,10 @@ using System; namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public interface ICacheableKeyRingProvider { CacheableKeyRing GetCacheableKeyRing(DateTimeOffset now); diff --git a/src/DataProtection/DataProtection/src/KeyManagement/Internal/IInternalXmlKeyManager.cs b/src/DataProtection/DataProtection/src/KeyManagement/Internal/IInternalXmlKeyManager.cs index 9ebaa4c63c..6c7d015213 100644 --- a/src/DataProtection/DataProtection/src/KeyManagement/Internal/IInternalXmlKeyManager.cs +++ b/src/DataProtection/DataProtection/src/KeyManagement/Internal/IInternalXmlKeyManager.cs @@ -7,6 +7,10 @@ using Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationM namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public interface IInternalXmlKeyManager { IKey CreateNewKey(Guid keyId, DateTimeOffset creationDate, DateTimeOffset activationDate, DateTimeOffset expirationDate); diff --git a/src/DataProtection/DataProtection/src/KeyManagement/Internal/IKeyRingProvider.cs b/src/DataProtection/DataProtection/src/KeyManagement/Internal/IKeyRingProvider.cs index 3a507f1250..67bc44776e 100644 --- a/src/DataProtection/DataProtection/src/KeyManagement/Internal/IKeyRingProvider.cs +++ b/src/DataProtection/DataProtection/src/KeyManagement/Internal/IKeyRingProvider.cs @@ -3,6 +3,10 @@ namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public interface IKeyRingProvider { IKeyRing GetCurrentKeyRing(); diff --git a/src/Features/JsonPatch/src/Internal/ConversionResult.cs b/src/Features/JsonPatch/src/Internal/ConversionResult.cs index 77181eb18d..cf602ebf0e 100644 --- a/src/Features/JsonPatch/src/Internal/ConversionResult.cs +++ b/src/Features/JsonPatch/src/Internal/ConversionResult.cs @@ -3,6 +3,10 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class ConversionResult { public ConversionResult(bool canBeConverted, object convertedInstance) @@ -14,4 +18,4 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal public bool CanBeConverted { get; } public object ConvertedInstance { get; } } -} \ No newline at end of file +} diff --git a/src/Features/JsonPatch/src/Internal/ConversionResultProvider.cs b/src/Features/JsonPatch/src/Internal/ConversionResultProvider.cs index 3d0b6cc979..8a717bb0ed 100644 --- a/src/Features/JsonPatch/src/Internal/ConversionResultProvider.cs +++ b/src/Features/JsonPatch/src/Internal/ConversionResultProvider.cs @@ -7,6 +7,10 @@ using Newtonsoft.Json; namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public static class ConversionResultProvider { public static ConversionResult ConvertTo(object value, Type typeToConvertTo) diff --git a/src/Features/JsonPatch/src/Internal/DictionaryAdapterOfTU.cs b/src/Features/JsonPatch/src/Internal/DictionaryAdapterOfTU.cs index be2bbffd86..8ab6acc0c9 100644 --- a/src/Features/JsonPatch/src/Internal/DictionaryAdapterOfTU.cs +++ b/src/Features/JsonPatch/src/Internal/DictionaryAdapterOfTU.cs @@ -8,6 +8,10 @@ using Newtonsoft.Json.Serialization; namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class DictionaryAdapter : IAdapter { public virtual bool TryAdd( diff --git a/src/Features/JsonPatch/src/Internal/DynamicObjectAdapter.cs b/src/Features/JsonPatch/src/Internal/DynamicObjectAdapter.cs index 5b3d7d8bdd..64298bc414 100644 --- a/src/Features/JsonPatch/src/Internal/DynamicObjectAdapter.cs +++ b/src/Features/JsonPatch/src/Internal/DynamicObjectAdapter.cs @@ -13,6 +13,10 @@ using CSharpBinder = Microsoft.CSharp.RuntimeBinder; namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class DynamicObjectAdapter : IAdapter { public virtual bool TryAdd( diff --git a/src/Features/JsonPatch/src/Internal/IAdapter.cs b/src/Features/JsonPatch/src/Internal/IAdapter.cs index ec28131f7d..061b9a37bd 100644 --- a/src/Features/JsonPatch/src/Internal/IAdapter.cs +++ b/src/Features/JsonPatch/src/Internal/IAdapter.cs @@ -5,6 +5,10 @@ using Newtonsoft.Json.Serialization; namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public interface IAdapter { bool TryTraverse( diff --git a/src/Features/JsonPatch/src/Internal/ListAdapter.cs b/src/Features/JsonPatch/src/Internal/ListAdapter.cs index 18b4acf217..a23dd7a4ad 100644 --- a/src/Features/JsonPatch/src/Internal/ListAdapter.cs +++ b/src/Features/JsonPatch/src/Internal/ListAdapter.cs @@ -11,6 +11,10 @@ using Newtonsoft.Json.Serialization; namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class ListAdapter : IAdapter { public virtual bool TryAdd( @@ -318,6 +322,10 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal } } + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// protected readonly struct PositionInfo { public PositionInfo(PositionType type, int index) @@ -330,6 +338,10 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal public int Index { get; } } + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// protected enum PositionType { Index, // valid index @@ -338,6 +350,10 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal OutOfBounds } + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// protected enum OperationType { Add, diff --git a/src/Features/JsonPatch/src/Internal/ObjectVisitor.cs b/src/Features/JsonPatch/src/Internal/ObjectVisitor.cs index 6cb4d7450c..750331d159 100644 --- a/src/Features/JsonPatch/src/Internal/ObjectVisitor.cs +++ b/src/Features/JsonPatch/src/Internal/ObjectVisitor.cs @@ -7,6 +7,10 @@ using Newtonsoft.Json.Serialization; namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class ObjectVisitor { private readonly IAdapterFactory _adapterFactory; @@ -30,7 +34,7 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal /// The . /// The to use when creating adaptors. public ObjectVisitor(ParsedPath path, IContractResolver contractResolver, IAdapterFactory adapterFactory) - { + { _path = path; _contractResolver = contractResolver ?? throw new ArgumentNullException(nameof(contractResolver)); _adapterFactory = adapterFactory ?? throw new ArgumentNullException(nameof(adapterFactory)); @@ -55,7 +59,7 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal adapter = null; return false; } - + // If we hit a null on an interior segment then we need to stop traversing. if (next == null) { diff --git a/src/Features/JsonPatch/src/Internal/ParsedPath.cs b/src/Features/JsonPatch/src/Internal/ParsedPath.cs index bff5fd9188..70f3ea98e9 100644 --- a/src/Features/JsonPatch/src/Internal/ParsedPath.cs +++ b/src/Features/JsonPatch/src/Internal/ParsedPath.cs @@ -8,6 +8,10 @@ using System.Text; namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public readonly struct ParsedPath { private static readonly string[] Empty = null; diff --git a/src/Features/JsonPatch/src/Internal/PocoAdapter.cs b/src/Features/JsonPatch/src/Internal/PocoAdapter.cs index 5ba3e5587b..fea5c5922e 100644 --- a/src/Features/JsonPatch/src/Internal/PocoAdapter.cs +++ b/src/Features/JsonPatch/src/Internal/PocoAdapter.cs @@ -10,6 +10,10 @@ using Newtonsoft.Json.Serialization; namespace Microsoft.AspNetCore.JsonPatch.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class PocoAdapter : IAdapter { public virtual bool TryAdd( diff --git a/src/Tools/Shared/CommandLine/CliContext.cs b/src/Tools/Shared/CommandLine/CliContext.cs index 854ea0fef6..230f832037 100644 --- a/src/Tools/Shared/CommandLine/CliContext.cs +++ b/src/Tools/Shared/CommandLine/CliContext.cs @@ -5,6 +5,10 @@ using System; namespace Microsoft.Extensions.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public static class CliContext { /// diff --git a/src/Tools/Shared/CommandLine/ConsoleReporter.cs b/src/Tools/Shared/CommandLine/ConsoleReporter.cs index a94efc70a4..e1cc8022bc 100644 --- a/src/Tools/Shared/CommandLine/ConsoleReporter.cs +++ b/src/Tools/Shared/CommandLine/ConsoleReporter.cs @@ -6,6 +6,10 @@ using System.IO; namespace Microsoft.Extensions.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class ConsoleReporter : IReporter { private readonly object _writeLock = new object(); diff --git a/src/Tools/Shared/CommandLine/DebugHelper.cs b/src/Tools/Shared/CommandLine/DebugHelper.cs index bb7f966d65..24f9173ee7 100644 --- a/src/Tools/Shared/CommandLine/DebugHelper.cs +++ b/src/Tools/Shared/CommandLine/DebugHelper.cs @@ -7,6 +7,10 @@ using System.Linq; namespace Microsoft.Extensions.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public static class DebugHelper { [Conditional("DEBUG")] @@ -21,4 +25,4 @@ namespace Microsoft.Extensions.Tools.Internal } } } -} \ No newline at end of file +} diff --git a/src/Tools/Shared/CommandLine/IConsole.cs b/src/Tools/Shared/CommandLine/IConsole.cs index 7216c267a0..ea40b6620c 100644 --- a/src/Tools/Shared/CommandLine/IConsole.cs +++ b/src/Tools/Shared/CommandLine/IConsole.cs @@ -6,6 +6,10 @@ using System.IO; namespace Microsoft.Extensions.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public interface IConsole { event ConsoleCancelEventHandler CancelKeyPress; diff --git a/src/Tools/Shared/CommandLine/IReporter.cs b/src/Tools/Shared/CommandLine/IReporter.cs index 890dec3f7e..b9828e4e80 100644 --- a/src/Tools/Shared/CommandLine/IReporter.cs +++ b/src/Tools/Shared/CommandLine/IReporter.cs @@ -3,6 +3,10 @@ namespace Microsoft.Extensions.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public interface IReporter { void Verbose(string message); @@ -10,4 +14,4 @@ namespace Microsoft.Extensions.Tools.Internal void Warn(string message); void Error(string message); } -} \ No newline at end of file +} diff --git a/src/Tools/Shared/CommandLine/NullReporter.cs b/src/Tools/Shared/CommandLine/NullReporter.cs index 5d80aeac91..0903797b67 100644 --- a/src/Tools/Shared/CommandLine/NullReporter.cs +++ b/src/Tools/Shared/CommandLine/NullReporter.cs @@ -3,6 +3,10 @@ namespace Microsoft.Extensions.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class NullReporter : IReporter { private NullReporter() diff --git a/src/Tools/Shared/CommandLine/PhysicalConsole.cs b/src/Tools/Shared/CommandLine/PhysicalConsole.cs index 9a93323d5c..1266ab5887 100644 --- a/src/Tools/Shared/CommandLine/PhysicalConsole.cs +++ b/src/Tools/Shared/CommandLine/PhysicalConsole.cs @@ -6,6 +6,10 @@ using System.IO; namespace Microsoft.Extensions.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class PhysicalConsole : IConsole { private PhysicalConsole() diff --git a/src/Tools/dotnet-user-secrets/src/Internal/CommandContext.cs b/src/Tools/dotnet-user-secrets/src/Internal/CommandContext.cs index 0ac0ea40fe..cfbec380dd 100644 --- a/src/Tools/dotnet-user-secrets/src/Internal/CommandContext.cs +++ b/src/Tools/dotnet-user-secrets/src/Internal/CommandContext.cs @@ -5,6 +5,10 @@ using Microsoft.Extensions.Tools.Internal; namespace Microsoft.Extensions.SecretManager.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class CommandContext { public CommandContext( @@ -21,4 +25,4 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal public IReporter Reporter { get; } public SecretsStore SecretStore { get; } } -} \ No newline at end of file +} diff --git a/src/Tools/dotnet-user-secrets/src/Internal/ICommand.cs b/src/Tools/dotnet-user-secrets/src/Internal/ICommand.cs index 636c08a07c..594a04eb27 100644 --- a/src/Tools/dotnet-user-secrets/src/Internal/ICommand.cs +++ b/src/Tools/dotnet-user-secrets/src/Internal/ICommand.cs @@ -3,8 +3,12 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public interface ICommand { void Execute(CommandContext context); } -} \ No newline at end of file +} diff --git a/src/Tools/dotnet-user-secrets/src/Internal/InitCommand.cs b/src/Tools/dotnet-user-secrets/src/Internal/InitCommand.cs index 670da42c4e..6ad5ccf886 100644 --- a/src/Tools/dotnet-user-secrets/src/Internal/InitCommand.cs +++ b/src/Tools/dotnet-user-secrets/src/Internal/InitCommand.cs @@ -10,7 +10,13 @@ using Microsoft.Extensions.CommandLineUtils; namespace Microsoft.Extensions.SecretManager.Tools.Internal { - // Workaround used to handle the fact that the options have not been parsed at configuration time + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// + /// + /// Workaround used to handle the fact that the options have not been parsed at configuration time + /// public class InitCommandFactory : ICommand { public CommandLineOptions Options { get; } @@ -42,6 +48,10 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal } } + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class InitCommand : ICommand { public string OverrideId { get; } diff --git a/src/Tools/dotnet-user-secrets/src/Internal/ProjectIdResolver.cs b/src/Tools/dotnet-user-secrets/src/Internal/ProjectIdResolver.cs index b04cf8306d..c2a81b5c2d 100644 --- a/src/Tools/dotnet-user-secrets/src/Internal/ProjectIdResolver.cs +++ b/src/Tools/dotnet-user-secrets/src/Internal/ProjectIdResolver.cs @@ -11,6 +11,10 @@ using Microsoft.Extensions.Tools.Internal; namespace Microsoft.Extensions.SecretManager.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class ProjectIdResolver { private const string DefaultConfig = "Debug"; diff --git a/src/Tools/dotnet-user-secrets/src/Internal/ReadableJsonConfigurationSource.cs b/src/Tools/dotnet-user-secrets/src/Internal/ReadableJsonConfigurationSource.cs index 96d0554aeb..864a76b36e 100644 --- a/src/Tools/dotnet-user-secrets/src/Internal/ReadableJsonConfigurationSource.cs +++ b/src/Tools/dotnet-user-secrets/src/Internal/ReadableJsonConfigurationSource.cs @@ -6,6 +6,10 @@ using Microsoft.Extensions.Configuration.Json; namespace Microsoft.Extensions.SecretManager.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class ReadableJsonConfigurationProvider : JsonConfigurationProvider { public ReadableJsonConfigurationProvider() @@ -15,4 +19,4 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal public IDictionary CurrentData => Data; } -} \ No newline at end of file +} diff --git a/src/Tools/dotnet-user-secrets/src/Internal/SecretsStore.cs b/src/Tools/dotnet-user-secrets/src/Internal/SecretsStore.cs index 93d46242f2..b865f97248 100644 --- a/src/Tools/dotnet-user-secrets/src/Internal/SecretsStore.cs +++ b/src/Tools/dotnet-user-secrets/src/Internal/SecretsStore.cs @@ -13,6 +13,10 @@ using Newtonsoft.Json.Linq; namespace Microsoft.Extensions.SecretManager.Tools.Internal { + /// + /// This API supports infrastructure and is not intended to be used + /// directly from your code. This API may change or be removed in future releases. + /// public class SecretsStore { private readonly string _secretsFilePath; @@ -84,4 +88,4 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal .ToDictionary(i => i.Key, i => i.Value, StringComparer.OrdinalIgnoreCase); } } -} \ No newline at end of file +}