Skip to content

Commit

Permalink
Remove ctor remarks
Browse files Browse the repository at this point in the history
  • Loading branch information
jviau committed Apr 4, 2024
1 parent 18a2125 commit f1eeb6f
Show file tree
Hide file tree
Showing 20 changed files with 1 addition and 59 deletions.
1 change: 0 additions & 1 deletion samples/AzureFunctionsApp/HelloCitiesTyped.cs
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ public async override Task<string> RunAsync(TaskOrchestrationContext context, st
/// definition that creates an instance of this class and invokes its <see cref="OnRun"/> method.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="SayHelloTyped"/> class.
/// This class is initialized once for every activity execution.
/// </remarks>
/// <remarks>
Expand Down
3 changes: 0 additions & 3 deletions src/Abstractions/Converters/JsonDataConverter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Converters;
/// <summary>
/// An implementation of <see cref="DataConverter"/> that uses System.Text.Json APIs for data serialization.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="JsonDataConverter"/> class.
/// </remarks>
/// <param name="options">The serializer options.</param>
public class JsonDataConverter(JsonSerializerOptions? options = null) : DataConverter
{
Expand Down
3 changes: 0 additions & 3 deletions src/Abstractions/DurableTaskAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ namespace Microsoft.DurableTask;
/// It is used specifically by build-time source generators to generate type-safe methods for invoking
/// orchestrations or activities.
/// </remarks>
/// <remarks>
/// Initializes a new instance of the <see cref="DurableTaskAttribute"/> class.
/// </remarks>
/// <param name="name">
/// The name of the durable task. If not specified, the class name is used as the implied name of the durable task.
/// </param>
Expand Down
3 changes: 0 additions & 3 deletions src/Abstractions/Entities/EntityOperationFailedException.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ namespace Microsoft.DurableTask.Entities;
/// Detailed information associated with a particular operation failure, including exception details, can be found in the
/// <see cref="FailureDetails"/> property.
/// </remarks>
/// <remarks>
/// Initializes a new instance of the <see cref="EntityOperationFailedException"/> class.
/// </remarks>
/// <param name="operationName">The operation name.</param>
/// <param name="entityId">The entity ID.</param>
/// <param name="failureDetails">The failure details.</param>
Expand Down
3 changes: 0 additions & 3 deletions src/Abstractions/Page.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ namespace Microsoft.DurableTask;
/// Represents a single page of results.
/// </summary>
/// <typeparam name="T">The type of values held by the page.</typeparam>
/// <remarks>
/// Initializes a new instance of the <see cref="Page{T}" /> class.
/// </remarks>
/// <param name="values">The values this holds.</param>
/// <param name="continuationToken">The continuation token.</param>
public sealed class Page<T>(IReadOnlyList<T> values, string? continuationToken = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ namespace Microsoft.DurableTask.Client;
/// <summary>
/// Default builder for <see cref="IDurableTaskClientBuilder" />.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="DefaultDurableTaskClientBuilder"/> class.
/// </remarks>
/// <param name="name">The name of the builder.</param>
/// <param name="services">The service collection.</param>
public class DefaultDurableTaskClientBuilder(string? name, IServiceCollection services) : IDurableTaskClientBuilder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Client;
/// <summary>
/// Default implementation of <see cref="IDurableTaskClientProvider" />.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="DefaultDurableTaskClientProvider"/> class.
/// </remarks>
/// <param name="clients">The set of clients.</param>
class DefaultDurableTaskClientProvider(IEnumerable<DefaultDurableTaskClientProvider.ClientContainer> clients)
: IDurableTaskClientProvider
Expand Down
6 changes: 0 additions & 6 deletions src/Client/Core/Entities/EntityMetadata.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@ namespace Microsoft.DurableTask.Client.Entities;
/// Represents entity metadata.
/// </summary>
/// <typeparam name="TState">The type of state held by the metadata.</typeparam>
/// <remarks>
/// Initializes a new instance of the <see cref="EntityMetadata{TState}"/> class.
/// </remarks>
/// <param name="id">The ID of the entity.</param>
[JsonConverter(typeof(EntityMetadataConverter))]
public class EntityMetadata<TState>(EntityInstanceId id)
Expand Down Expand Up @@ -90,9 +87,6 @@ public TState State
/// <summary>
/// Represents the metadata for a durable entity instance.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="EntityMetadata"/> class.
/// </remarks>
/// <param name="id">The ID of the entity.</param>
/// <param name="state">The state of this entity.</param>
[JsonConverter(typeof(EntityMetadataConverter))]
Expand Down
3 changes: 0 additions & 3 deletions src/Client/Core/OrchestrationMetadata.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ namespace Microsoft.DurableTask.Client;
/// <see cref="DurableTaskClient.WaitForInstanceStartAsync(string, CancellationToken)"/> and
/// <see cref="DurableTaskClient.WaitForInstanceCompletionAsync(string, CancellationToken)"/>.
/// </remarks>
/// <remarks>
/// Initializes a new instance of the <see cref="OrchestrationMetadata" /> class.
/// </remarks>
/// <param name="name">The name of the orchestration.</param>
/// <param name="instanceId">The instance ID of the orchestration.</param>
public sealed class OrchestrationMetadata(string name, string instanceId)
Expand Down
3 changes: 0 additions & 3 deletions src/Client/Core/SerializedData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Client;
/// <summary>
/// Gets a type representing serialized data.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="SerializedData"/> class.
/// </remarks>
/// <param name="data">The serialized data.</param>
/// <param name="converter">The data converter.</param>
public sealed class SerializedData(string data, DataConverter? converter = null)
Expand Down
3 changes: 0 additions & 3 deletions src/Client/Grpc/GrpcDurableEntityClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@ namespace Microsoft.DurableTask.Client.Grpc;
/// <summary>
/// The client for entities.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="GrpcDurableEntityClient"/> class.
/// </remarks>
/// <param name="name">The name of the client.</param>
/// <param name="dataConverter">The data converter.</param>
/// <param name="sidecarClient">The client for the GRPC connection to the sidecar.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ namespace Microsoft.DurableTask.Client.OrchestrationServiceClientShim;
/// <summary>
/// A shim client for interacting with the backend via <see cref="Core.IOrchestrationServiceClient" />.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="ShimDurableTaskClient"/> class.
/// </remarks>
/// <param name="name">The name of the client.</param>
/// <param name="options">The client options.</param>
class ShimDurableTaskClient(string name, ShimDurableTaskClientOptions options) : DurableTaskClient(name)
Expand Down
3 changes: 0 additions & 3 deletions src/Shared/Core/AsyncDisposable.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ namespace Microsoft.DurableTask;
/// <summary>
/// A struct for calling a simple delegate on dispose.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="AsyncDisposable"/> struct.
/// </remarks>
/// <param name="callback">The callback to invoke on disposal.</param>
struct AsyncDisposable(Func<ValueTask> callback) : IAsyncDisposable
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ namespace Microsoft.DurableTask.Worker;
/// <summary>
/// The default builder for durable task.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="DefaultDurableTaskWorkerBuilder" /> class.
/// </remarks>
/// <param name="services">The service collection for this builder.</param>
/// <param name="name">The name for this builder.</param>
public class DefaultDurableTaskWorkerBuilder(string? name, IServiceCollection services) : IDurableTaskWorkerBuilder
Expand Down
3 changes: 0 additions & 3 deletions src/Worker/Core/Shims/DurableTaskShimFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ namespace Microsoft.DurableTask.Worker.Shims;
/// This class is intended for use with alternate .NET-based durable task runtimes. It's not intended for use
/// in application code.
/// </remarks>
/// <remarks>
/// Initializes a new instance of the <see cref="DurableTaskShimFactory" /> class.
/// </remarks>
/// <param name="options">The data converter.</param>
/// <param name="loggerFactory">The logger factory.</param>
public class DurableTaskShimFactory(
Expand Down
3 changes: 0 additions & 3 deletions src/Worker/Core/Shims/JsonDataConverterShim.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Worker.Shims;
/// <summary>
/// A shim to go from <see cref="DataConverter" /> to <see cref="CoreJsonDataConverter" />.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="JsonDataConverterShim"/> class.
/// </remarks>
/// <param name="innerConverter">The converter to wrap.</param>
sealed class JsonDataConverterShim(DataConverter innerConverter) : CoreJsonDataConverter
{
Expand Down
3 changes: 0 additions & 3 deletions src/Worker/Core/Shims/TaskActivityShim.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Worker.Shims;
/// <summary>
/// Shims a <see cref="ITaskActivity" /> to a <see cref="TaskActivity" />.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="TaskActivityShim"/> class.
/// </remarks>
/// <param name="dataConverter">The data converter.</param>
/// <param name="name">The name of the activity.</param>
/// <param name="implementation">The activity implementation to wrap.</param>
Expand Down
3 changes: 0 additions & 3 deletions src/Worker/Core/Shims/TaskOrchestrationShim.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@ namespace Microsoft.DurableTask.Worker.Shims;
/// This class is intended for use with alternate .NET-based durable task runtimes. It's not intended for use
/// in application code.
/// </remarks>
/// <remarks>
/// Initializes a new instance of the <see cref="TaskOrchestrationShim"/> class.
/// </remarks>
/// <param name="invocationContext">The invocation context for this orchestration.</param>
/// <param name="implementation">The orchestration's implementation.</param>
partial class TaskOrchestrationShim(
Expand Down
3 changes: 0 additions & 3 deletions src/Worker/Grpc/GrpcDurableTaskWorker.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ namespace Microsoft.DurableTask.Worker.Grpc;
/// <summary>
/// The gRPC Durable Task worker.
/// </summary>
/// <remarks>
/// Initializes a new instance of the <see cref="GrpcDurableTaskWorker" /> class.
/// </remarks>
/// <param name="name">The name of the worker.</param>
/// <param name="factory">The task factory.</param>
/// <param name="options">The gRPC worker options.</param>
Expand Down
2 changes: 1 addition & 1 deletion test/Grpc.IntegrationTests/OrchestrationErrorHandling.cs
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ public async Task TaskNotFoundErrorsAreNotRetried(bool activity)

static Exception MakeException(Type exceptionType, string message)
{
// We assume the contructor of the exception type takes a single string argument
// We assume the constructor of the exception type takes a single string argument
return (Exception)Activator.CreateInstance(exceptionType, message)!;
}

Expand Down

0 comments on commit f1eeb6f

Please sign in to comment.