Skip to content

Commit

Permalink
adding XML comments
Browse files Browse the repository at this point in the history
Signed-off-by: Neil South <[email protected]>
  • Loading branch information
neildsouth committed Oct 11, 2023
1 parent 84d04e1 commit f2415a5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/Messaging/API/IMessageBrokerSubscriberService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public interface IMessageBrokerSubscriberService : IDisposable
string Name { get; }

/// <summary>
/// Subscribe to a message topic & queue and executes <c>messageReceivedCallback</c> asynchronously for every message that is received.
/// Subscribe to a message topic and queue and executes <c>messageReceivedCallback</c> asynchronously for every message that is received.
/// Either provide a topic, a queue or both.
/// A queue is generated if the name of the queue is not provided.
/// </summary>
Expand All @@ -43,7 +43,7 @@ public interface IMessageBrokerSubscriberService : IDisposable
void SubscribeAsync(string topic, string queue, Func<MessageReceivedEventArgs, Task> messageReceivedCallback, ushort prefetchCount = 0);

/// <summary>
/// Subscribe to a message topic & queue and executes <c>messageReceivedCallback</c> asynchronously for every message that is received.
/// Subscribe to a message topic and queue and executes <c>messageReceivedCallback</c> asynchronously for every message that is received.
/// Either provide a topic, a queue or both.
/// A queue is generated if the name of the queue is not provided.
/// </summary>
Expand Down
4 changes: 2 additions & 2 deletions src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ public class MessageBrokerServiceConfiguration

/// <summary>
/// Gets or sets the a fully qualified type name of the message publisher service.
/// The spcified type must implement <typeparam name="Monai.Deploy.InformaticsGateway.Api.MessageBroker.IMessageBrokerPublisherService">IMessageBrokerPublisherService</typeparam> interface.
/// The spcified type must implement <see cref="Monai.Deploy.InformaticsGateway.Api.MessageBroker.IMessageBrokerPublisherService">IMessageBrokerPublisherService</see> interface.

Check warning on line 28 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / build (ubuntu-latest)

XML comment has cref attribute 'IMessageBrokerPublisherService' that could not be resolved

Check warning on line 28 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / build (ubuntu-latest)

XML comment has cref attribute 'IMessageBrokerPublisherService' that could not be resolved

Check warning on line 28 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / analyze (csharp)

XML comment has cref attribute 'IMessageBrokerPublisherService' that could not be resolved

Check warning on line 28 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / analyze (csharp)

XML comment has cref attribute 'IMessageBrokerPublisherService' that could not be resolved

Check warning on line 28 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / unit-test

XML comment has cref attribute 'IMessageBrokerPublisherService' that could not be resolved

Check warning on line 28 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / unit-test

XML comment has cref attribute 'IMessageBrokerPublisherService' that could not be resolved

Check warning on line 28 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / build (windows-latest)

XML comment has cref attribute 'IMessageBrokerPublisherService' that could not be resolved

Check warning on line 28 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / build (windows-latest)

XML comment has cref attribute 'IMessageBrokerPublisherService' that could not be resolved
/// The default message publisher service configured is RabbitMQ.
/// </summary>
[ConfigurationKeyName("publisherServiceAssemblyName")]
public string PublisherServiceAssemblyName { get; set; } = DefaultPublisherAssemblyName;

/// <summary>
/// Gets or sets the a fully qualified type name of the message subscriber service.
/// The spcified type must implement <typeparam name="Monai.Deploy.InformaticsGateway.Api.MessageBroker.IMessageBrokerSubscriberService">IMessageBrokerSubscriberService</typeparam> interface.
/// The spcified type must implement <see cref="Monai.Deploy.InformaticsGateway.Api.MessageBroker.IMessageBrokerSubscriberService">IMessageBrokerSubscriberService</see> interface.

Check warning on line 36 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / build (ubuntu-latest)

XML comment has cref attribute 'IMessageBrokerSubscriberService' that could not be resolved

Check warning on line 36 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / build (ubuntu-latest)

XML comment has cref attribute 'IMessageBrokerSubscriberService' that could not be resolved

Check warning on line 36 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / analyze (csharp)

XML comment has cref attribute 'IMessageBrokerSubscriberService' that could not be resolved

Check warning on line 36 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / analyze (csharp)

XML comment has cref attribute 'IMessageBrokerSubscriberService' that could not be resolved

Check warning on line 36 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / unit-test

XML comment has cref attribute 'IMessageBrokerSubscriberService' that could not be resolved

Check warning on line 36 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / unit-test

XML comment has cref attribute 'IMessageBrokerSubscriberService' that could not be resolved

Check warning on line 36 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / build (windows-latest)

XML comment has cref attribute 'IMessageBrokerSubscriberService' that could not be resolved

Check warning on line 36 in src/Messaging/Configuration/MessageBrokerServiceConfiguration.cs

View workflow job for this annotation

GitHub Actions / build (windows-latest)

XML comment has cref attribute 'IMessageBrokerSubscriberService' that could not be resolved
/// The default message subscriber service configured is RabbitMQ.
/// </summary>
[ConfigurationKeyName("subscriberServiceAssemblyName")]
Expand Down
16 changes: 16 additions & 0 deletions src/Messaging/IServiceCollectionExtension.cs
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ public static class IServiceCollectionExtensions
/// </summary>
/// <param name="services">Instance of <see cref="IServiceCollection"/>.</param>
/// <param name="fullyQualifiedTypeName">Fully qualified type name of the service to use.</param>
/// <param name="registerHealthCheck">bool as to if the healthcheck is be registered</param>
/// <param name="failureStatus"></param>
/// <param name="tags"></param>
/// <param name="timeout"></param>
/// <returns>Instance of <see cref="IServiceCollection"/>.</returns>
/// <exception cref="ConfigurationException"></exception>
public static IServiceCollection AddMonaiDeployMessageBrokerSubscriberService(
Expand All @@ -48,6 +52,10 @@ public static IServiceCollection AddMonaiDeployMessageBrokerSubscriberService(
/// <param name="services">Instance of <see cref="IServiceCollection"/>.</param>
/// <param name="fullyQualifiedTypeName">Fully qualified type name of the service to use.</param>
/// <param name="fileSystem">Instance of <see cref="IFileSystem"/>.</param>
/// <param name="registerHealthCheck">bool as to if the healthcheck is be registered</param>
/// <param name="failureStatus"></param>
/// <param name="tags"></param>
/// <param name="timeout"></param>
/// <returns>Instance of <see cref="IServiceCollection"/>.</returns>
/// <exception cref="ConfigurationException"></exception>
public static IServiceCollection AddMonaiDeployMessageBrokerSubscriberService(
Expand All @@ -65,6 +73,10 @@ public static IServiceCollection AddMonaiDeployMessageBrokerSubscriberService(
/// </summary>
/// <param name="services">Instance of <see cref="IServiceCollection"/>.</param>
/// <param name="fullyQualifiedTypeName">Fully qualified type name of the service to use.</param>
/// <param name="registerHealthCheck">bool as to if the healthcheck is be registered</param>
/// <param name="failureStatus"></param>
/// <param name="tags"></param>
/// <param name="timeout"></param>
/// <returns>Instance of <see cref="IServiceCollection"/>.</returns>
/// <exception cref="ConfigurationException"></exception>
public static IServiceCollection AddMonaiDeployMessageBrokerPublisherService(
Expand All @@ -82,6 +94,10 @@ public static IServiceCollection AddMonaiDeployMessageBrokerPublisherService(
/// <param name="services">Instance of <see cref="IServiceCollection"/>.</param>
/// <param name="fullyQualifiedTypeName">Fully qualified type name of the service to use.</param>
/// <param name="fileSystem">Instance of <see cref="IFileSystem"/>.</param>
/// <param name="registerHealthCheck">bool as to if the healthcheck is be registered</param>
/// <param name="failureStatus"></param>
/// <param name="tags"></param>
/// <param name="timeout"></param>
/// <returns>Instance of <see cref="IServiceCollection"/>.</returns>
/// <exception cref="ConfigurationException"></exception>
public static IServiceCollection AddMonaiDeployMessageBrokerPublisherService(
Expand Down

0 comments on commit f2415a5

Please sign in to comment.