Add XML docs to pubternal types

This commit is contained in:
Kevin Pilch 2019-08-23 13:04:30 -07:00 committed by Kevin Pilch
parent 50660f31c8
commit 3e253f6a40
27 changed files with 136 additions and 10 deletions

View File

@ -8,6 +8,10 @@ using Microsoft.CodeAnalysis.Diagnostics;
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
{

View File

@ -5,6 +5,10 @@ using Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption;
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>

View File

@ -5,6 +5,10 @@ using System;
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);

View File

@ -7,6 +7,10 @@ using Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationM
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);

View File

@ -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();

View File

@ -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 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal
public bool CanBeConverted { get; }
public object ConvertedInstance { get; }
}
}
}

View File

@ -7,6 +7,10 @@ using Newtonsoft.Json;
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)

View File

@ -8,6 +8,10 @@ using Newtonsoft.Json.Serialization;
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(

View File

@ -13,6 +13,10 @@ using CSharpBinder = Microsoft.CSharp.RuntimeBinder;
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(

View File

@ -5,6 +5,10 @@ using Newtonsoft.Json.Serialization;
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(

View File

@ -11,6 +11,10 @@ using Newtonsoft.Json.Serialization;
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 @@ 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>
protected readonly struct PositionInfo
{
public PositionInfo(PositionType type, int index)
@ -330,6 +338,10 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal
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 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal
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,

View File

@ -7,6 +7,10 @@ using Newtonsoft.Json.Serialization;
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 @@ namespace Microsoft.AspNetCore.JsonPatch.Internal
/// <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 @@ 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)
{

View File

@ -8,6 +8,10 @@ using System.Text;
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;

View File

@ -10,6 +10,10 @@ using Newtonsoft.Json.Serialization;
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(

View File

@ -5,6 +5,10 @@ using System;
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>

View File

@ -6,6 +6,10 @@ using System.IO;
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();

View File

@ -7,6 +7,10 @@ using System.Linq;
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 @@ namespace Microsoft.Extensions.Tools.Internal
}
}
}
}
}

View File

@ -6,6 +6,10 @@ using System.IO;
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;

View File

@ -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 interface IReporter
{
void Verbose(string message);
@ -10,4 +14,4 @@ namespace Microsoft.Extensions.Tools.Internal
void Warn(string message);
void Error(string message);
}
}
}

View File

@ -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()

View File

@ -6,6 +6,10 @@ using System.IO;
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()

View File

@ -5,6 +5,10 @@ using Microsoft.Extensions.Tools.Internal;
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 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal
public IReporter Reporter { get; }
public SecretsStore SecretStore { get; }
}
}
}

View File

@ -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);
}
}
}

View File

@ -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
/// <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 @@ 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 InitCommand : ICommand
{
public string OverrideId { get; }

View File

@ -11,6 +11,10 @@ using Microsoft.Extensions.Tools.Internal;
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";

View File

@ -6,6 +6,10 @@ using Microsoft.Extensions.Configuration.Json;
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 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal
public IDictionary<string, string> CurrentData => Data;
}
}
}

View File

@ -13,6 +13,10 @@ using Newtonsoft.Json.Linq;
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 SecretsStore
{
private readonly string _secretsFilePath;
@ -84,4 +88,4 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal
.ToDictionary(i => i.Key, i => i.Value, StringComparer.OrdinalIgnoreCase);
}
}
}
}