Add XML docs to pubternal types

Pilchie · Pilchie · commit 3e253f6a401b · 2019-08-27T13:45:33.000-07:00
diff --git a/src/Components/Analyzers/src/ComponentInternalUsageDiagnosticAnalzyer.cs b/src/Components/Analyzers/src/ComponentInternalUsageDiagnosticAnalzyer.cs
@@ -8,6 +8,10 @@
 
 namespace Microsoft.Extensions.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     [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
@@ -5,6 +5,10 @@
 
 namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public struct DefaultKeyResolution
     {
         /// <summary>
diff --git a/src/DataProtection/DataProtection/src/KeyManagement/Internal/ICacheableKeyRingProvider.cs b/src/DataProtection/DataProtection/src/KeyManagement/Internal/ICacheableKeyRingProvider.cs
@@ -5,6 +5,10 @@
 
 namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -7,6 +7,10 @@
 
 namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -3,6 +3,10 @@
 
 namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public interface IKeyRingProvider
     {
         IKeyRing GetCurrentKeyRing();
diff --git 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
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class ConversionResult
     {
         public ConversionResult(bool canBeConverted, object convertedInstance)
@@ -14,4 +18,4 @@ public ConversionResult(bool canBeConverted, object convertedInstance)
         public bool CanBeConverted { get; }
         public object ConvertedInstance { get; }
     }
-}
+}
diff --git a/src/Features/JsonPatch/src/Internal/ConversionResultProvider.cs b/src/Features/JsonPatch/src/Internal/ConversionResultProvider.cs
@@ -7,6 +7,10 @@
 
 namespace Microsoft.AspNetCore.JsonPatch.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -8,6 +8,10 @@
 
 namespace Microsoft.AspNetCore.JsonPatch.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class DictionaryAdapter<TKey, TValue> : IAdapter
     {
         public virtual bool TryAdd(
diff --git a/src/Features/JsonPatch/src/Internal/DynamicObjectAdapter.cs b/src/Features/JsonPatch/src/Internal/DynamicObjectAdapter.cs
@@ -13,6 +13,10 @@
 
 namespace Microsoft.AspNetCore.JsonPatch.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -5,6 +5,10 @@
 
 namespace Microsoft.AspNetCore.JsonPatch.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public interface IAdapter
     {
         bool TryTraverse(
diff --git a/src/Features/JsonPatch/src/Internal/ListAdapter.cs b/src/Features/JsonPatch/src/Internal/ListAdapter.cs
@@ -11,6 +11,10 @@
 
 namespace Microsoft.AspNetCore.JsonPatch.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class ListAdapter : IAdapter
     {
         public virtual bool TryAdd(
@@ -318,6 +322,10 @@ protected virtual bool TryGetPositionInfo(
             }
         }
 
+        /// <summary>
+        /// 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.
+        /// </summary>
         protected readonly struct PositionInfo
         {
             public PositionInfo(PositionType type, int index)
@@ -330,6 +338,10 @@ public PositionInfo(PositionType type, int index)
             public int Index { get; }
         }
 
+        /// <summary>
+        /// 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.
+        /// </summary>
         protected enum PositionType
         {
             Index, // valid index
@@ -338,6 +350,10 @@ protected enum PositionType
             OutOfBounds
         }
 
+        /// <summary>
+        /// 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.
+        /// </summary>
         protected enum OperationType
         {
             Add,
diff --git a/src/Features/JsonPatch/src/Internal/ObjectVisitor.cs b/src/Features/JsonPatch/src/Internal/ObjectVisitor.cs
@@ -7,6 +7,10 @@
 
 namespace Microsoft.AspNetCore.JsonPatch.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class ObjectVisitor
     {
         private readonly IAdapterFactory _adapterFactory;
@@ -30,7 +34,7 @@ public ObjectVisitor(ParsedPath path, IContractResolver contractResolver)
         /// <param name="contractResolver">The <see cref="IContractResolver"/>.</param>
         /// <param name="adapterFactory">The <see cref="IAdapterFactory"/> to use when creating adaptors.</param>
         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 @@ public bool TryVisit(ref object target, out IAdapter adapter, out string errorMe
                     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
@@ -8,6 +8,10 @@
 
 namespace Microsoft.AspNetCore.JsonPatch.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -10,6 +10,10 @@
 
 namespace Microsoft.AspNetCore.JsonPatch.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class PocoAdapter : IAdapter
     {
         public virtual bool TryAdd(
diff --git a/src/Tools/Shared/CommandLine/CliContext.cs b/src/Tools/Shared/CommandLine/CliContext.cs
@@ -5,6 +5,10 @@
 
 namespace Microsoft.Extensions.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public static class CliContext
     {
         /// <summary>
diff --git a/src/Tools/Shared/CommandLine/ConsoleReporter.cs b/src/Tools/Shared/CommandLine/ConsoleReporter.cs
@@ -6,6 +6,10 @@
 
 namespace Microsoft.Extensions.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -7,6 +7,10 @@
 
 namespace Microsoft.Extensions.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public static class DebugHelper
     {
         [Conditional("DEBUG")]
@@ -21,4 +25,4 @@ public static void HandleDebugSwitch(ref string[] args)
             }
         }
     }
-}
+}
diff --git a/src/Tools/Shared/CommandLine/IConsole.cs b/src/Tools/Shared/CommandLine/IConsole.cs
@@ -6,6 +6,10 @@
 
 namespace Microsoft.Extensions.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public interface IConsole
     {
         event ConsoleCancelEventHandler CancelKeyPress;
diff --git a/src/Tools/Shared/CommandLine/IReporter.cs b/src/Tools/Shared/CommandLine/IReporter.cs
@@ -3,11 +3,15 @@
 
 namespace Microsoft.Extensions.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public interface IReporter
     {
         void Verbose(string message);
         void Output(string message);
         void Warn(string message);
         void Error(string message);
     }
-}
+}
diff --git a/src/Tools/Shared/CommandLine/NullReporter.cs b/src/Tools/Shared/CommandLine/NullReporter.cs
@@ -3,6 +3,10 @@
 
 namespace Microsoft.Extensions.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class NullReporter : IReporter
     {
         private NullReporter()
diff --git a/src/Tools/Shared/CommandLine/PhysicalConsole.cs b/src/Tools/Shared/CommandLine/PhysicalConsole.cs
@@ -6,6 +6,10 @@
 
 namespace Microsoft.Extensions.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -5,6 +5,10 @@
 
 namespace Microsoft.Extensions.SecretManager.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class CommandContext
     {
         public CommandContext(
@@ -21,4 +25,4 @@ public CommandContext(
         public IReporter Reporter { get; }
         public SecretsStore SecretStore { get; }
     }
-}
+}
diff --git 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
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public interface ICommand
     {
         void Execute(CommandContext context);
     }
-}
+}
diff --git a/src/Tools/dotnet-user-secrets/src/Internal/InitCommand.cs b/src/Tools/dotnet-user-secrets/src/Internal/InitCommand.cs
@@ -10,7 +10,13 @@
 
 namespace Microsoft.Extensions.SecretManager.Tools.Internal
 {
-    // Workaround used to handle the fact that the options have not been parsed at configuration time
+    /// <summary>
+    /// 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.
+    /// </summary>
+    /// <remarks>
+    /// Workaround used to handle the fact that the options have not been parsed at configuration time
+    /// </remarks>
     public class InitCommandFactory : ICommand
     {
         public CommandLineOptions Options { get; }
@@ -42,6 +48,10 @@ public void Execute(CommandContext context, string workingDirectory)
         }
     }
 
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -11,6 +11,10 @@
 
 namespace Microsoft.Extensions.SecretManager.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     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
@@ -6,6 +6,10 @@
 
 namespace Microsoft.Extensions.SecretManager.Tools.Internal
 {
+    /// <summary>
+    /// 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.
+    /// </summary>
     public class ReadableJsonConfigurationProvider : JsonConfigurationProvider
     {
         public ReadableJsonConfigurationProvider()
@@ -15,4 +19,4 @@ public ReadableJsonConfigurationProvider()
 
         public IDictionary<string, string> CurrentData => Data;
     }
-}
+}
diff --git a/src/Tools/dotnet-user-secrets/src/Internal/SecretsStore.cs b/src/Tools/dotnet-user-secrets/src/Internal/SecretsStore.cs

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,10 @@`
`8`	`8`
`9`	`9`	`namespace Microsoft.Extensions.Internal`
`10`	`10`	`{`
	`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>`
`11`	`15`	`[DiagnosticAnalyzer(LanguageNames.CSharp)]`
`12`	`16`	`public class ComponentInternalUsageDiagnosticAnalyzer : DiagnosticAnalyzer`
`13`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,10 @@`
`5`	`5`
`6`	`6`	`namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal`
`7`	`7`	`{`
	`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>`
`8`	`12`	`public struct DefaultKeyResolution`
`9`	`13`	`{`
`10`	`14`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,10 @@`
`7`	`7`
`8`	`8`	`namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal`
`9`	`9`	`{`
	`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>`
`10`	`14`	`public interface IInternalXmlKeyManager`
`11`	`15`	`{`
`12`	`16`	`IKey CreateNewKey(Guid keyId, DateTimeOffset creationDate, DateTimeOffset activationDate, DateTimeOffset expirationDate);`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,10 @@`
`3`	`3`
`4`	`4`	`namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal`
`5`	`5`	`{`
	`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>`
`6`	`10`	`public interface IKeyRingProvider`
`7`	`11`	`{`
`8`	`12`	`IKeyRing GetCurrentKeyRing();`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,10 @@`
`3`	`3`
`4`	`4`	`namespace Microsoft.AspNetCore.JsonPatch.Internal`
`5`	`5`	`{`
	`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>`
`6`	`10`	`public class ConversionResult`
`7`	`11`	`{`
`8`	`12`	`public ConversionResult(bool canBeConverted, object convertedInstance)`
`@@ -14,4 +18,4 @@ public ConversionResult(bool canBeConverted, object convertedInstance)`
`14`	`18`	`public bool CanBeConverted { get; }`
`15`	`19`	`public object ConvertedInstance { get; }`
`16`	`20`	`}`
`17`		`-}`
	`21`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,10 @@`
`13`	`13`
`14`	`14`	`namespace Microsoft.AspNetCore.JsonPatch.Internal`
`15`	`15`	`{`
	`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>`
`16`	`20`	`public class DynamicObjectAdapter : IAdapter`
`17`	`21`	`{`
`18`	`22`	`public virtual bool TryAdd(`