Skip to content

Commit 0ec541f

Browse files
committed
Merge branch 'improvement/ViewModels-XmlDocs' into develop
Minor improvements to XML Docs within the `OnTopic.ViewModels` project. For instance, preferred the more specific name `model` for view models, instead of describing them as data transfer objects.
2 parents 7074bde + b8d9036 commit 0ec541f

17 files changed

Lines changed: 23 additions & 21 deletions

OnTopic.ViewModels/BindingModels/AssociatedTopicBindingModel.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
namespace OnTopic.ViewModels.BindingModels {
1111

1212
/*============================================================================================================================
13-
| CLASS: ASSOCIATED TOPIC BINDING MODEL
13+
| BINDING MODEL: ASSOCIATED TOPIC
1414
\---------------------------------------------------------------------------------------------------------------------------*/
1515
/// <summary>
16-
/// Provides a generic data transfer topic for binding an association of a binding model to an existing <see cref="Topic"/>.
16+
/// Provides a model for binding an association of a <see cref="ITopicBindingModel"/> to another <see cref="Topic"/>.
1717
/// </summary>
1818
/// <remarks>
1919
/// While implementors may choose to create a custom <see cref="IAssociatedTopicBindingModel"/> implementation, the out-of-
@@ -27,7 +27,7 @@ public record AssociatedTopicBindingModel : IAssociatedTopicBindingModel {
2727
| PROPERTY: UNIQUE KEY
2828
\-------------------------------------------------------------------------------------------------------------------------*/
2929
/// <summary>
30-
/// Gets or sets the topic's <see cref="UniqueKey"/> attribute, the unique text identifier for the topic.
30+
/// Gets the topic's <see cref="UniqueKey"/> attribute, the unique text identifier for the topic.
3131
/// </summary>
3232
/// <requires description="The value from the getter must not be null." exception="T:System.ArgumentNullException">
3333
/// value is not null

OnTopic.ViewModels/BindingModels/RelatedTopicBindingModel.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
namespace OnTopic.ViewModels.BindingModels {
1111

1212
/*============================================================================================================================
13-
| CLASS: RELATED TOPIC BINDING MODEL
13+
| BINDING MODEL: RELATED TOPIC
1414
\---------------------------------------------------------------------------------------------------------------------------*/
1515
/// <summary>
16-
/// Provides a generic data transfer topic for binding a relationship of a binding model to an existing <see cref="Topic"/>.
16+
/// Provides a model for binding a relationship of a <see cref="ITopicBindingModel"/> to an existing <see cref="Topic"/>.
1717
/// </summary>
1818
/// <remarks>
1919
/// While implementors may choose to create a custom <see cref="IAssociatedTopicBindingModel"/> implementation, the out-of-

OnTopic.ViewModels/Collections/TopicViewModelCollection.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ namespace OnTopic.ViewModels.Collections {
1616
| VIEW MODEL: TOPIC COLLECTION
1717
\---------------------------------------------------------------------------------------------------------------------------*/
1818
/// <summary>
19-
/// Provides a basic collection interface for use with data transfer objects implementing <see cref="ITopicViewModel"/>,
20-
/// including <see cref="TopicViewModel"/> and derivatives.
19+
/// Provides a basic collection interface for use with models implementing <see cref="ITopicViewModel"/>, including <see
20+
/// cref="TopicViewModel"/> and derivatives.
2121
/// </summary>
2222
/// <remarks>
2323
/// Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains

OnTopic.ViewModels/ContentListTopicViewModel.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ namespace OnTopic.ViewModels {
1212
| VIEW MODEL: CONTENT LIST TOPIC
1313
\---------------------------------------------------------------------------------------------------------------------------*/
1414
/// <summary>
15-
/// Provides a strongly-typed data transfer object for feeding views with information about a content list topic.
15+
/// Provides a strongly-typed model for feeding views with information about a <c>ContentList</c> topic.
1616
/// </summary>
1717
/// <remarks>
1818
/// Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains

OnTopic.ViewModels/IndexTopicViewModel.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace OnTopic.ViewModels {
1010
| VIEW MODEL: INDEX TOPIC
1111
\---------------------------------------------------------------------------------------------------------------------------*/
1212
/// <summary>
13-
/// Provides a strongly-typed data transfer object for feeding views with information about an index topic.
13+
/// Provides a strongly-typed model for feeding views with information about an <c>Index</c> topic.
1414
/// </summary>
1515
/// <remarks>
1616
/// Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains

OnTopic.ViewModels/Items/ContentItemTopicViewModel.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ namespace OnTopic.ViewModels.Items {
1111
| VIEW MODEL: CONTENT ITEM TOPIC
1212
\---------------------------------------------------------------------------------------------------------------------------*/
1313
/// <summary>
14-
/// Provides a strongly-typed data transfer object for feeding views with information about a content item topic.
14+
/// Provides a strongly-typed model for feeding views with information about a <c>ContentItem</c> topic, as used in the <see
15+
/// cref="ContentListTopicViewModel"/> model, and its derivatives.
1516
/// </summary>
1617
/// <remarks>
1718
/// Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains

OnTopic.ViewModels/Items/ItemTopicViewModel.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace OnTopic.ViewModels.Items {
1010
| VIEW MODEL: ITEM TOPIC
1111
\---------------------------------------------------------------------------------------------------------------------------*/
1212
/// <summary>
13-
/// Provides a strongly-typed data transfer object for feeding views with information about an item topic.
13+
/// Provides a strongly-typed model for feeding views with information about an <c>Item</c> topic.
1414
/// </summary>
1515
/// <remarks>
1616
/// Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains

OnTopic.ViewModels/Items/ListTopicViewModel.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace OnTopic.ViewModels.Items {
1111
| VIEW MODEL: LIST
1212
\---------------------------------------------------------------------------------------------------------------------------*/
1313
/// <summary>
14-
/// Provides a strongly-typed data transfer object for modeling a nested topic list.
14+
/// Provides a strongly-typed model for modeling a <c>List</c> topic, as used for nested topics.
1515
/// </summary>
1616
/// <remarks>
1717
/// <para>

OnTopic.ViewModels/Items/LookupListItemTopicViewModel.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace OnTopic.ViewModels.Items {
1010
| VIEW MODEL: LOOKUP LIST ITEM TOPIC
1111
\---------------------------------------------------------------------------------------------------------------------------*/
1212
/// <summary>
13-
/// Provides a strongly-typed data transfer object for feeding views with information about lookup list item topic.
13+
/// Provides a strongly-typed model for feeding views with information about <c>LookupListItem</c> topic.
1414
/// </summary>
1515
/// <remarks>
1616
/// Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains

OnTopic.ViewModels/Items/SlideTopicViewModel.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ namespace OnTopic.ViewModels.Items {
1010
| VIEW MODEL: SLIDE TOPIC
1111
\---------------------------------------------------------------------------------------------------------------------------*/
1212
/// <summary>
13-
/// Provides a strongly-typed data transfer object for feeding views with information about a slide topic.
13+
/// Provides a strongly-typed model for feeding views with information about a <c>Slide</c> topic, as used in e.g. <see cref
14+
/// ="SlideshowTopicViewModel"/>.
1415
/// </summary>
1516
/// <remarks>
1617
/// Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains

0 commit comments

Comments
 (0)