Skip to content

Commit

Permalink
#371 Minor documentation changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjstone committed Sep 9, 2020
1 parent 03e0df5 commit c8c2c45
Show file tree
Hide file tree
Showing 25 changed files with 43 additions and 40 deletions.
10 changes: 5 additions & 5 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ This path contains sample projects that utilize the **Solid Instruments** [const

- [`RapidField.SolidInstruments.Example.BeaconService`](/example/RapidField.SolidInstruments.Example.BeaconService) demonstrates a utility service that publishes scheduled heartbeat messages.
- [`RapidField.SolidInstruments.Example.Domain`](/example/RapidField.SolidInstruments.Example.Domain) houses a sample collection of shared domain models that utilize the **Solid Instruments** [messaging](../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.AccessControl`](/example/RapidField.SolidInstruments.Example.Domain.AccessControl) demonstrates AccessControl domain logic utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.AccessControl.HttpApi`](/example/RapidField.SolidInstruments.Example.Domain.AccessControl.HttpApi) demonstrates an AccessControl domain HTTP API utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.AccessControl.Service`](/example/RapidField.SolidInstruments.Example.Domain.AccessControl.Service) demonstrates an AccessControl domain service utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.Identity`](/example/RapidField.SolidInstruments.Example.Domain.Identity) demonstrates Identity domain logic utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.Identity.Service`](/example/RapidField.SolidInstruments.Example.Domain.Identity.Service) demonstrates an Identity domain service utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.AccessControl`](/example/RapidField.SolidInstruments.Example.Domain.AccessControl) demonstrates **AccessControl** domain logic utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.AccessControl.HttpApi`](/example/RapidField.SolidInstruments.Example.Domain.AccessControl.HttpApi) demonstrates an **AccessControl** domain HTTP API utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.AccessControl.Service`](/example/RapidField.SolidInstruments.Example.Domain.AccessControl.Service) demonstrates an **AccessControl** domain service utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.Identity`](/example/RapidField.SolidInstruments.Example.Domain.Identity) demonstrates **Identity** domain logic utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) constructs.
- [`RapidField.SolidInstruments.Example.Domain.Identity.Service`](/example/RapidField.SolidInstruments.Example.Domain.Identity.Service) demonstrates an **Identity** domain service utilizing the **Solid Instruments** [data access](../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../src/RapidField.SolidInstruments.Messaging/README.md) constructs.

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes the purpose of the [`RapidField.SolidInstruments.Example

## Purpose

This project demonstrates an AccessControl domain HTTP API utilizing the **Solid Instruments** [data access](../../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
This project demonstrates an **AccessControl** domain HTTP API utilizing the **Solid Instruments** [data access](../../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../../src/RapidField.SolidInstruments.Messaging/README.md) constructs.

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
namespace RapidField.SolidInstruments.Example.Domain.AccessControl.Service
{
/// <summary>
/// Prepares for and performs execution of the AccessControl domain service.
/// Prepares for and performs execution of the <see cref="AccessControl" /> domain service.
/// </summary>
public sealed class ApplicationServiceExecutor : DotNetNativeMessagingServiceExecutor<ApplicationDependencyPackage>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes the purpose of the [`RapidField.SolidInstruments.Example

## Purpose

This project demonstrates an AccessControl domain service utilizing the **Solid Instruments** [data access](../../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
This project demonstrates an **AccessControl** domain service utilizing the **Solid Instruments** [data access](../../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../../src/RapidField.SolidInstruments.Messaging/README.md) constructs.

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
namespace RapidField.SolidInstruments.Example.Domain.AccessControl
{
/// <summary>
/// Encapsulates container configuration for AccessControl domain command handlers.
/// Encapsulates container configuration for <see cref="AccessControl" /> domain command handlers.
/// </summary>
public sealed class CommandHandlerModule : DotNetNativeCommandHandlerModule
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace RapidField.SolidInstruments.Example.Domain.AccessControl
using UserRoleModelConfiguration = Models.UserRole.AggregateDataAccessModelConfiguration;

/// <summary>
/// Represents a connection to the AccessControl database.
/// Represents a connection to the <see cref="AccessControl" /> database.
/// </summary>
public sealed class DatabaseContext : ConfiguredContext
{
Expand Down Expand Up @@ -97,6 +97,6 @@ public DbSet<UserModel> Users
/// Represents the database name that is used when creating and connecting to the data source.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
internal const String DatabaseName = "AccessControl";
internal const String DatabaseName = nameof(AccessControl);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
namespace RapidField.SolidInstruments.Example.Domain.AccessControl
{
/// <summary>
/// Encapsulates container configuration for the AccessControl database connection and related data access dependencies.
/// Encapsulates container configuration for the <see cref="AccessControl" /> database connection and related data access
/// dependencies.
/// </summary>
public sealed class DatabaseContextDependencyModule : DotNetNativeEntityFrameworkDataStoreDependencyModule<DatabaseContext, DatabaseContextRepositoryFactory>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
namespace RapidField.SolidInstruments.Example.Domain.AccessControl
{
/// <summary>
/// Encapsulates creation of new <see cref="IDataAccessRepository" /> instances that map to AccessControl database entities.
/// Encapsulates creation of new <see cref="IDataAccessRepository" /> instances that map to <see cref="AccessControl" />
/// database entities.
/// </summary>
public sealed class DatabaseContextRepositoryFactory : EntityFrameworkRepositoryFactory<DatabaseContext>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
namespace RapidField.SolidInstruments.Example.Domain.AccessControl
{
/// <summary>
/// Encapsulates container configuration for AccessControl domain event handlers.
/// Encapsulates container configuration for <see cref="AccessControl" /> domain event handlers.
/// </summary>
public sealed class EventHandlerModule : DotNetNativeEventHandlerModule
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes the purpose of the [`RapidField.SolidInstruments.Example

## Purpose

This project demonstrates AccessControl domain logic utilizing the **Solid Instruments** [data access](../../src/RapidField.SolidInstruments.DataAccess/README.md) constructs.
This project demonstrates **AccessControl** domain logic utilizing the **Solid Instruments** [data access](../../src/RapidField.SolidInstruments.DataAccess/README.md) constructs.

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
namespace RapidField.SolidInstruments.Example.Domain.Identity.Service
{
/// <summary>
/// Prepares for and performs execution of the Identity domain service.
/// Prepares for and performs execution of the <see cref="Identity" /> domain service.
/// </summary>
public sealed class ApplicationServiceExecutor : DotNetNativeMessagingServiceExecutor<ApplicationDependencyPackage>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes the purpose of the [`RapidField.SolidInstruments.Example

## Purpose

This project demonstrates an Identity domain service utilizing the **Solid Instruments** [data access](../../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../../src/RapidField.SolidInstruments.Messaging/README.md) constructs.
This project demonstrates an **Identity** domain service utilizing the **Solid Instruments** [data access](../../src/RapidField.SolidInstruments.DataAccess/README.md) and [messaging](../../src/RapidField.SolidInstruments.Messaging/README.md) constructs.

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
namespace RapidField.SolidInstruments.Example.Domain.Identity
{
/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
public sealed class DatabaseContext : IdentityDbContext
{
Expand Down Expand Up @@ -441,7 +441,7 @@ private String DatabaseName
/// Represents the database name that is used when creating and connecting to the data source.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private const String DefaultDatabaseName = "Identity";
private const String DefaultDatabaseName = nameof(Identity);

/// <summary>
/// Represents the default database type for backing databases.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
namespace RapidField.SolidInstruments.Example.Domain.Identity
{
/// <summary>
/// Encapsulates container configuration for the Identity database connection and related data access dependencies.
/// Encapsulates container configuration for the <see cref="Identity" /> database connection and related data access
/// dependencies.
/// </summary>
public sealed class DatabaseContextDependencyModule : DotNetNativeDependencyModule
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
namespace RapidField.SolidInstruments.Example.Domain.Identity
{
/// <summary>
/// Encapsulates container configuration for Identity domain event handlers.
/// Encapsulates container configuration for <see cref="Identity" /> domain event handlers.
/// </summary>
public sealed class EventHandlerModule : DotNetNativeEventHandlerModule
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class DomainModelCreatedEventHandler : DomainModelCreatedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -87,7 +87,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public sealed class DomainModelDeletedEventHandler : DomainModelDeletedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -79,7 +79,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class DomainModelUpdatedEventHandler : DomainModelUpdatedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -96,7 +96,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class DomainModelCreatedEventHandler : DomainModelCreatedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -82,7 +82,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public sealed class DomainModelDeletedEventHandler : DomainModelDeletedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -79,7 +79,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class DomainModelUpdatedEventHandler : DomainModelUpdatedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -89,7 +89,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class DomainModelCreatedEventHandler : DomainModelCreatedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -82,7 +82,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public sealed class DomainModelDeletedEventHandler : DomainModelDeletedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -79,7 +79,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class DomainModelUpdatedEventHandler : DomainModelUpdatedEventHand
/// A processing intermediary that is used to process sub-commands.
/// </param>
/// <param name="databaseContext">
/// A connection to the Identity database.
/// A connection to the <see cref="Identity" /> database.
/// </param>
/// <exception cref="ArgumentNullException">
/// <paramref name="mediator" /> is <see langword="null" /> -or- <paramref name="databaseContext" /> is
Expand Down Expand Up @@ -83,7 +83,7 @@ protected override void Process(DomainModel model, IEnumerable<String> labels, G
}

/// <summary>
/// Represents a connection to the Identity database.
/// Represents a connection to the <see cref="Identity" /> database.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly DatabaseContext DatabaseContext;
Expand Down
Loading

0 comments on commit c8c2c45

Please sign in to comment.