Documentation modifications

This commit is contained in:
julian
2026-06-27 15:23:26 -07:00
parent a633fe6c06
commit a19fb90902
218 changed files with 2882 additions and 0 deletions
@@ -18,6 +18,12 @@ public class PublisherService : IPublisherService
private readonly HashSet<string> _queues = new();
private readonly IBus? _bus;
/// <summary>
/// Initializes a new instance of the <see cref="PublisherService"/> class, a RabbitMQ publisher service, by configuring the message bus from <paramref name="rabbitMqSettings"/> and storing <paramref name="logger"/> for diagnostic logging.
/// </summary>
/// <param name="rabbitMqSettings">The RabbitMQ configuration whose <see cref="RabbitMqSettings.ConnectionString"/> is used to initialize the message bus.</param>
/// <param name="logger">The logger used to record initialization status and errors.</param>
/// <!-- aidoc:v1 sig=e60da0f body=9c07ebc -->
public PublisherService(
IOptions<RabbitMqSettings> rabbitMqSettings,
ILogger<PublisherService> logger)
@@ -48,6 +54,17 @@ public class PublisherService : IPublisherService
}
}
/// <summary>
/// Registers a queue with the specified <paramref name="queueName"/> for tracking purposes,
/// while the actual queue creation is delegated to EasyNetQ. Returns false when the name is
/// null, empty, or whitespace, and returns true when the queue is newly added or already
/// registered (idempotent behavior).
/// </summary>
/// <param name="queueName">The name of the queue to register.</param>
/// <returns>A <see cref="Task{Boolean}"/> that resolves to true when the queue is successfully
/// registered (either newly added or already present), or false when <paramref name="queueName"/>
/// is null, empty, or whitespace.</returns>
/// <!-- aidoc:v1 sig=980f114 body=a6676db -->
public Task<bool> CreateQueue(string queueName)
{
if (string.IsNullOrWhiteSpace(queueName))