Skip to content

Commit 648ea37

Browse files
committed
Remove ctor remarks
1 parent 18a2125 commit 648ea37

20 files changed

+1
-61
lines changed

samples/AzureFunctionsApp/HelloCitiesTyped.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,7 @@ public async override Task<string> RunAsync(TaskOrchestrationContext context, st
6464
/// definition that creates an instance of this class and invokes its <see cref="OnRun"/> method.
6565
/// </summary>
6666
/// <remarks>
67-
/// Initializes a new instance of the <see cref="SayHelloTyped"/> class.
6867
/// This class is initialized once for every activity execution.
69-
/// </remarks>
70-
/// <remarks>
7168
/// Activity class constructors support constructor-based dependency injection.
7269
/// The injected services are provided by the function's <see cref="FunctionContext.InstanceServices"/> property.
7370
/// </remarks>

src/Abstractions/Converters/JsonDataConverter.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Converters;
88
/// <summary>
99
/// An implementation of <see cref="DataConverter"/> that uses System.Text.Json APIs for data serialization.
1010
/// </summary>
11-
/// <remarks>
12-
/// Initializes a new instance of the <see cref="JsonDataConverter"/> class.
13-
/// </remarks>
1411
/// <param name="options">The serializer options.</param>
1512
public class JsonDataConverter(JsonSerializerOptions? options = null) : DataConverter
1613
{

src/Abstractions/DurableTaskAttribute.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ namespace Microsoft.DurableTask;
1212
/// It is used specifically by build-time source generators to generate type-safe methods for invoking
1313
/// orchestrations or activities.
1414
/// </remarks>
15-
/// <remarks>
16-
/// Initializes a new instance of the <see cref="DurableTaskAttribute"/> class.
17-
/// </remarks>
1815
/// <param name="name">
1916
/// The name of the durable task. If not specified, the class name is used as the implied name of the durable task.
2017
/// </param>

src/Abstractions/Entities/EntityOperationFailedException.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ namespace Microsoft.DurableTask.Entities;
1010
/// Detailed information associated with a particular operation failure, including exception details, can be found in the
1111
/// <see cref="FailureDetails"/> property.
1212
/// </remarks>
13-
/// <remarks>
14-
/// Initializes a new instance of the <see cref="EntityOperationFailedException"/> class.
15-
/// </remarks>
1613
/// <param name="operationName">The operation name.</param>
1714
/// <param name="entityId">The entity ID.</param>
1815
/// <param name="failureDetails">The failure details.</param>

src/Abstractions/Page.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ namespace Microsoft.DurableTask;
77
/// Represents a single page of results.
88
/// </summary>
99
/// <typeparam name="T">The type of values held by the page.</typeparam>
10-
/// <remarks>
11-
/// Initializes a new instance of the <see cref="Page{T}" /> class.
12-
/// </remarks>
1310
/// <param name="values">The values this holds.</param>
1411
/// <param name="continuationToken">The continuation token.</param>
1512
public sealed class Page<T>(IReadOnlyList<T> values, string? continuationToken = null)

src/Client/Core/DependencyInjection/DefaultDurableTaskClientBuilder.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ namespace Microsoft.DurableTask.Client;
99
/// <summary>
1010
/// Default builder for <see cref="IDurableTaskClientBuilder" />.
1111
/// </summary>
12-
/// <remarks>
13-
/// Initializes a new instance of the <see cref="DefaultDurableTaskClientBuilder"/> class.
14-
/// </remarks>
1512
/// <param name="name">The name of the builder.</param>
1613
/// <param name="services">The service collection.</param>
1714
public class DefaultDurableTaskClientBuilder(string? name, IServiceCollection services) : IDurableTaskClientBuilder

src/Client/Core/DependencyInjection/DefaultDurableTaskClientProvider.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Client;
88
/// <summary>
99
/// Default implementation of <see cref="IDurableTaskClientProvider" />.
1010
/// </summary>
11-
/// <remarks>
12-
/// Initializes a new instance of the <see cref="DefaultDurableTaskClientProvider"/> class.
13-
/// </remarks>
1411
/// <param name="clients">The set of clients.</param>
1512
class DefaultDurableTaskClientProvider(IEnumerable<DefaultDurableTaskClientProvider.ClientContainer> clients)
1613
: IDurableTaskClientProvider

src/Client/Core/Entities/EntityMetadata.cs

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ namespace Microsoft.DurableTask.Client.Entities;
1111
/// Represents entity metadata.
1212
/// </summary>
1313
/// <typeparam name="TState">The type of state held by the metadata.</typeparam>
14-
/// <remarks>
15-
/// Initializes a new instance of the <see cref="EntityMetadata{TState}"/> class.
16-
/// </remarks>
1714
/// <param name="id">The ID of the entity.</param>
1815
[JsonConverter(typeof(EntityMetadataConverter))]
1916
public class EntityMetadata<TState>(EntityInstanceId id)
@@ -90,9 +87,6 @@ public TState State
9087
/// <summary>
9188
/// Represents the metadata for a durable entity instance.
9289
/// </summary>
93-
/// <remarks>
94-
/// Initializes a new instance of the <see cref="EntityMetadata"/> class.
95-
/// </remarks>
9690
/// <param name="id">The ID of the entity.</param>
9791
/// <param name="state">The state of this entity.</param>
9892
[JsonConverter(typeof(EntityMetadataConverter))]

src/Client/Core/OrchestrationMetadata.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@ namespace Microsoft.DurableTask.Client;
1515
/// <see cref="DurableTaskClient.WaitForInstanceStartAsync(string, CancellationToken)"/> and
1616
/// <see cref="DurableTaskClient.WaitForInstanceCompletionAsync(string, CancellationToken)"/>.
1717
/// </remarks>
18-
/// <remarks>
19-
/// Initializes a new instance of the <see cref="OrchestrationMetadata" /> class.
20-
/// </remarks>
2118
/// <param name="name">The name of the orchestration.</param>
2219
/// <param name="instanceId">The instance ID of the orchestration.</param>
2320
public sealed class OrchestrationMetadata(string name, string instanceId)

src/Client/Core/SerializedData.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Client;
88
/// <summary>
99
/// Gets a type representing serialized data.
1010
/// </summary>
11-
/// <remarks>
12-
/// Initializes a new instance of the <see cref="SerializedData"/> class.
13-
/// </remarks>
1411
/// <param name="data">The serialized data.</param>
1512
/// <param name="converter">The data converter.</param>
1613
public sealed class SerializedData(string data, DataConverter? converter = null)

src/Client/Grpc/GrpcDurableEntityClient.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@ namespace Microsoft.DurableTask.Client.Grpc;
1313
/// <summary>
1414
/// The client for entities.
1515
/// </summary>
16-
/// <remarks>
17-
/// Initializes a new instance of the <see cref="GrpcDurableEntityClient"/> class.
18-
/// </remarks>
1916
/// <param name="name">The name of the client.</param>
2017
/// <param name="dataConverter">The data converter.</param>
2118
/// <param name="sidecarClient">The client for the GRPC connection to the sidecar.</param>

src/Client/OrchestrationServiceClientShim/ShimDurableTaskClient.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@ namespace Microsoft.DurableTask.Client.OrchestrationServiceClientShim;
1515
/// <summary>
1616
/// A shim client for interacting with the backend via <see cref="Core.IOrchestrationServiceClient" />.
1717
/// </summary>
18-
/// <remarks>
19-
/// Initializes a new instance of the <see cref="ShimDurableTaskClient"/> class.
20-
/// </remarks>
2118
/// <param name="name">The name of the client.</param>
2219
/// <param name="options">The client options.</param>
2320
class ShimDurableTaskClient(string name, ShimDurableTaskClientOptions options) : DurableTaskClient(name)

src/Shared/Core/AsyncDisposable.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ namespace Microsoft.DurableTask;
66
/// <summary>
77
/// A struct for calling a simple delegate on dispose.
88
/// </summary>
9-
/// <remarks>
10-
/// Initializes a new instance of the <see cref="AsyncDisposable"/> struct.
11-
/// </remarks>
129
/// <param name="callback">The callback to invoke on disposal.</param>
1310
struct AsyncDisposable(Func<ValueTask> callback) : IAsyncDisposable
1411
{

src/Worker/Core/DependencyInjection/DefaultDurableTaskWorkerBuilder.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ namespace Microsoft.DurableTask.Worker;
1010
/// <summary>
1111
/// The default builder for durable task.
1212
/// </summary>
13-
/// <remarks>
14-
/// Initializes a new instance of the <see cref="DefaultDurableTaskWorkerBuilder" /> class.
15-
/// </remarks>
1613
/// <param name="services">The service collection for this builder.</param>
1714
/// <param name="name">The name for this builder.</param>
1815
public class DefaultDurableTaskWorkerBuilder(string? name, IServiceCollection services) : IDurableTaskWorkerBuilder

src/Worker/Core/Shims/DurableTaskShimFactory.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ namespace Microsoft.DurableTask.Worker.Shims;
1616
/// This class is intended for use with alternate .NET-based durable task runtimes. It's not intended for use
1717
/// in application code.
1818
/// </remarks>
19-
/// <remarks>
20-
/// Initializes a new instance of the <see cref="DurableTaskShimFactory" /> class.
21-
/// </remarks>
2219
/// <param name="options">The data converter.</param>
2320
/// <param name="loggerFactory">The logger factory.</param>
2421
public class DurableTaskShimFactory(

src/Worker/Core/Shims/JsonDataConverterShim.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Worker.Shims;
88
/// <summary>
99
/// A shim to go from <see cref="DataConverter" /> to <see cref="CoreJsonDataConverter" />.
1010
/// </summary>
11-
/// <remarks>
12-
/// Initializes a new instance of the <see cref="JsonDataConverterShim"/> class.
13-
/// </remarks>
1411
/// <param name="innerConverter">The converter to wrap.</param>
1512
sealed class JsonDataConverterShim(DataConverter innerConverter) : CoreJsonDataConverter
1613
{

src/Worker/Core/Shims/TaskActivityShim.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ namespace Microsoft.DurableTask.Worker.Shims;
88
/// <summary>
99
/// Shims a <see cref="ITaskActivity" /> to a <see cref="TaskActivity" />.
1010
/// </summary>
11-
/// <remarks>
12-
/// Initializes a new instance of the <see cref="TaskActivityShim"/> class.
13-
/// </remarks>
1411
/// <param name="dataConverter">The data converter.</param>
1512
/// <param name="name">The name of the activity.</param>
1613
/// <param name="implementation">The activity implementation to wrap.</param>

src/Worker/Core/Shims/TaskOrchestrationShim.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@ namespace Microsoft.DurableTask.Worker.Shims;
1313
/// This class is intended for use with alternate .NET-based durable task runtimes. It's not intended for use
1414
/// in application code.
1515
/// </remarks>
16-
/// <remarks>
17-
/// Initializes a new instance of the <see cref="TaskOrchestrationShim"/> class.
18-
/// </remarks>
1916
/// <param name="invocationContext">The invocation context for this orchestration.</param>
2017
/// <param name="implementation">The orchestration's implementation.</param>
2118
partial class TaskOrchestrationShim(

src/Worker/Grpc/GrpcDurableTaskWorker.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ namespace Microsoft.DurableTask.Worker.Grpc;
1010
/// <summary>
1111
/// The gRPC Durable Task worker.
1212
/// </summary>
13-
/// <remarks>
14-
/// Initializes a new instance of the <see cref="GrpcDurableTaskWorker" /> class.
15-
/// </remarks>
1613
/// <param name="name">The name of the worker.</param>
1714
/// <param name="factory">The task factory.</param>
1815
/// <param name="options">The gRPC worker options.</param>

test/Grpc.IntegrationTests/OrchestrationErrorHandling.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ public async Task TaskNotFoundErrorsAreNotRetried(bool activity)
367367

368368
static Exception MakeException(Type exceptionType, string message)
369369
{
370-
// We assume the contructor of the exception type takes a single string argument
370+
// We assume the constructor of the exception type takes a single string argument
371371
return (Exception)Activator.CreateInstance(exceptionType, message)!;
372372
}
373373

0 commit comments

Comments
 (0)