1 Merge branch 'improvement/documentation' into develop · OnTopicCMS/OnTopic-Library@219ece4 · GitHub
Skip to content

Commit 219ece4

Browse files
JeremyCaneyJeremyCaney
committed
Merge branch 'improvement/documentation' into develop
Configured the solution to automatically generate an XML Doc file for each project during compilation. In addition, resolved quite a few outstanding issues with the existing documentation, such as missing or malformed references, which didn't get picked up until we added the flag for generating the documentation.
2 parents 145c2a4 + 726ba44 commit 219ece4

27 files changed

Lines changed: 63 additions & 59 deletions

‎Directory.Build.props‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<NeutralLanguage>en</NeutralLanguage>
1818
<IncludeSymbols>true</IncludeSymbols>
1919
<EmbedUntrackedSources>true</EmbedUntrackedSources>
20+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
2021
</PropertyGroup>
2122

2223
<PropertyGroup Condition="'$(TF_BUILD)' == 'true'">

‎OnTopic.AspNetCore.Mvc.Host/Components/MenuViewComponent.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
\=============================================================================================================================*/
66
using Microsoft.AspNetCore.Mvc;
77
using OnTopic.AspNetCore.Mvc.Components;
8+
using OnTopic.AspNetCore.Mvc.Controllers;
89
using OnTopic.AspNetCore.Mvc.Models;
910
using OnTopic.Mapping.Hierarchical;
1011
using OnTopic.Repositories;
@@ -16,7 +17,7 @@ namespace OnTopic.AspNetCore.Mvc.Host.Components {
1617
| CLASS: MENU VIEW COMPONENT
1718
\---------------------------------------------------------------------------------------------------------------------------*/
1819
/// <summary>
19-
/// Defines a <see cref="ViewComponent"/> which provides access to a menu of <typeparamref name="NavigationTopicViewModel"/>
20+
/// Defines a <see cref="ViewComponent"/> which provides access to a menu of <see cref="NavigationTopicViewModel"/>
2021
/// instances.
2122
/// </summary>
2223
/// <remarks>

‎OnTopic.AspNetCore.Mvc.Host/Components/PageLevelNavigationViewComponent.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
\=============================================================================================================================*/
66
using Microsoft.AspNetCore.Mvc;
77
using OnTopic.AspNetCore.Mvc.Components;
8+
using OnTopic.AspNetCore.Mvc.Controllers;
89
using OnTopic.AspNetCore.Mvc.Models;
910
using OnTopic.Mapping.Hierarchical;
1011
using OnTopic.Repositories;
@@ -16,15 +17,14 @@ namespace OnTopic.AspNetCore.Mvc.Host.Components {
1617
| CLASS: PAGE-LEVEL NAVIGATION VIEW COMPONENT
1718
\---------------------------------------------------------------------------------------------------------------------------*/
1819
/// <summary>
19-
/// Defines a <see cref="ViewComponent"/> which provides access to a menu of <typeparamref name="NavigationTopicViewModel"/>
20+
/// Defines a <see cref="ViewComponent"/> which provides access to a menu of <see cref="NavigationTopicViewModel"/>
2021
/// instances representing the nearest page-level navigation.
2122
/// </summary>
2223
/// <remarks>
2324
/// <para>
2425
/// As a best practice, global data required by the layout view are requested independent of the current page. This
25-
/// allows each layout element to be provided with its own layout data, in the form of <see
26-
/// cref="NavigationViewModel{T}"/>s, instead of needing to add this data to every view model returned by <see
27-
/// cref="TopicController"/>.
26+
/// allows each layout element to be provided with its own layout data, in the form of <see cref="NavigationViewModel{T}"
27+
/// />s, instead of needing to add this data to every view model returned by <see cref="TopicController"/>.
2828
/// </para>
2929
/// </remarks>
3030
public class PageLevelNavigationViewComponent : PageLevelNavigationViewComponentBase<NavigationTopicViewModel> {

‎OnTopic.AspNetCore.Mvc.Host/SampleActivator.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ public class SampleActivator : IControllerActivator, IViewComponentActivator {
4646
| CONSTRUCTOR
4747
\-------------------------------------------------------------------------------------------------------------------------*/
4848
/// <summary>
49-
/// Establishes a new instance of the <see cref="SampleControllerFactory"/>, including any shared dependencies to be used
50-
/// across instances of controllers.
49+
/// Establishes a new instance of the <see cref="SampleActivator"/>, including any shared dependencies to be used across
50+
/// instances of controllers.
5151
/// </summary>
5252
/// <remarks>
5353
/// The constructor is responsible for establishing dependencies with the singleton lifestyle so that they are available
@@ -88,7 +88,7 @@ public SampleActivator(string connectionString) {
8888
/// <summary>
8989
/// Registers dependencies, and injects them into new instances of controllers in response to each request.
9090
/// </summary>
91-
/// <returns>A concrete instance of an <see cref="IController"/>.</returns>
91+
/// <returns>A concrete instance of an <see cref="Controller"/>.</returns>
9292
public object Create(ControllerContext context) {
9393

9494
/*------------------------------------------------------------------------------------------------------------------------
@@ -128,7 +128,7 @@ public object Create(ControllerContext context) {
128128
/// <summary>
129129
/// Registers dependencies, and injects them into new instances of view components in response to each request.
130130
/// </summary>
131-
/// <returns>A concrete instance of an <see cref="IController"/>.</returns>
131+
/// <returns>A concrete instance of an <see cref="ViewComponent"/>.</returns>
132132
public object Create(ViewComponentContext context) {
133133

134134
/*------------------------------------------------------------------------------------------------------------------------

‎OnTopic.AspNetCore.Mvc.Tests/TopicControllerTest.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ namespace OnTopic.Tests {
2525
\---------------------------------------------------------------------------------------------------------------------------*/
2626
/// <summary>
2727
/// Provides unit tests for the <see cref="TopicController"/>, and other <see cref="Controller"/> classes that are part of
28-
/// the <see cref="OnTopic.Web.Mvc"/> namespace.
28+
/// the <see cref="OnTopic.AspNetCore.Mvc"/> namespace.
2929
/// </summary>
3030
[TestClass]
3131
public class TopicControllerTest {
@@ -104,7 +104,7 @@ public async Task TopicController_IndexAsync_ReturnsTopicViewResult() {
104104
| TEST: REDIRECT CONTROLLER: REDIRECT: RETURNS REDIRECT RESULT
105105
\-------------------------------------------------------------------------------------------------------------------------*/
106106
/// <summary>
107-
/// Triggers the <see cref="FallbackController.Index()" /> action.
107+
/// Triggers the <see cref="RedirectController.Redirect(Int32)" /> action.
108108
/// </summary>
109109
[TestMethod]
110110
public void RedirectController_TopicRedirect_ReturnsRedirectResult() {
@@ -124,7 +124,7 @@ public void RedirectController_TopicRedirect_ReturnsRedirectResult() {
124124
| TEST: SITEMAP CONTROLLER: INDEX: RETURNS SITEMAP XML
125125
\-------------------------------------------------------------------------------------------------------------------------*/
126126
/// <summary>
127-
/// Triggers the index action of the <see cref="SitemapController.Index()" /> action.
127+
/// Triggers the index action of the <see cref="SitemapController.Index(Boolean, Boolean)" /> action.
128128
/// </summary>
129129
[TestMethod]
130130
public void SitemapController_Index_ReturnsSitemapXml() {
@@ -152,8 +152,8 @@ public void SitemapController_Index_ReturnsSitemapXml() {
152152
| TEST: SITEMAP CONTROLLER: INDEX: EXCLUDES CONTENT TYPES
153153
\-------------------------------------------------------------------------------------------------------------------------*/
154154
/// <summary>
155-
/// Triggers the index action of the <see cref="SitemapController.Index()" /> action and verifies that it properly
156-
/// excludes <c>List</c> content types, and skips over <c>Container</c> and <c>PageGroup</c>.
155+
/// Triggers the index action of the <see cref="SitemapController.Index(Boolean, Boolean)" /> action and verifies that it
156+
/// properly excludes <c>List</c> content types, and skips over <c>Container</c> and <c>PageGroup</c>.
157157
/// </summary>
158158
[TestMethod]
159159
public void SitemapController_Index_ExcludesContentTypes() {
@@ -198,8 +198,8 @@ public void SitemapController_Index_ExcludesContentTypes() {
198198
| TEST: SITEMAP CONTROLLER: INDEX: EXCLUDES ATTRIBUTES
199199
\-------------------------------------------------------------------------------------------------------------------------*/
200200
/// <summary>
201-
/// Triggers the index action of the <see cref="SitemapController.Index()" /> action and verifies that it properly
202-
/// excludes the <c>Body</c> and <c>IsHidden</c> attributes.
201+
/// Triggers the index action of the <see cref="SitemapController.Index(Boolean, Boolean)" /> action and verifies that it
202+
/// properly excludes the <c>Body</c> and <c>IsHidden</c> attributes.
203203
/// </summary>
204204
[TestMethod]
205205
public void SitemapController_Index_ExcludesAttributes() {

‎OnTopic.AspNetCore.Mvc.Tests/TopicViewComponentTest.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
using Microsoft.AspNetCore.Mvc.ViewComponents;
1010
using Microsoft.AspNetCore.Routing;
1111
using Microsoft.VisualStudio.TestTools.UnitTesting;
12+
using OnTopic.AspNetCore.Mvc.Components;
1213
using OnTopic.AspNetCore.Mvc.Host.Components;
1314
using OnTopic.AspNetCore.Mvc.Models;
1415
using OnTopic.Data.Caching;

‎OnTopic.AspNetCore.Mvc.Tests/ValidateTopicAttributeTest.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
using OnTopic.AspNetCore.Mvc;
1515
using OnTopic.AspNetCore.Mvc.Controllers;
1616
using OnTopic.Attributes;
17+
using OnTopic.Metadata;
1718
using OnTopic.TestDoubles;
1819

1920
namespace OnTopic.Tests {

‎OnTopic.AspNetCore.Mvc/Components/MenuViewComponentBase{T}.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
using System;
77
using System.Threading.Tasks;
88
using Microsoft.AspNetCore.Mvc;
9+
using OnTopic.AspNetCore.Mvc.Controllers;
910
using OnTopic.AspNetCore.Mvc.Models;
1011
using OnTopic.Internal.Diagnostics;
1112
using OnTopic.Mapping.Hierarchical;

‎OnTopic.AspNetCore.Mvc/Components/NavigationTopicViewComponentBase{T}.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ IHierarchicalTopicMappingService<T> hierarchicalTopicMappingService
5252
/// on the route data.
5353
/// </summary>
5454
/// <returns>
55-
/// The <see cref="ITopicRepository"/> associated with the <see cref="TopicViewComponentBase{T}"/>.
55+
/// The <see cref="ITopicRepository"/> associated with the <see cref="NavigationTopicViewComponentBase{T}"/>.
5656
/// </returns>
5757
protected ITopicRepository TopicRepository { get; }
5858

@@ -64,7 +64,8 @@ IHierarchicalTopicMappingService<T> hierarchicalTopicMappingService
6464
/// be mapped.
6565
/// </summary>
6666
/// <returns>
67-
/// The <see cref="IHierarchicalTopicMappingService{T}"/> associated with the <see cref="TopicViewComponentBase{T}"/>.
67+
/// The <see cref="IHierarchicalTopicMappingService{T}"/> associated with the <see cref="
68+
/// NavigationTopicViewComponentBase{T}"/>.
6869
/// </returns>
6970
protected IHierarchicalTopicMappingService<T> HierarchicalTopicMappingService { get; }
7071

‎OnTopic.AspNetCore.Mvc/Components/PageLevelNavigationViewComponentBase{T}.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
\=============================================================================================================================*/
66
using System.Threading.Tasks;
77
using Microsoft.AspNetCore.Mvc;
8+
using OnTopic.AspNetCore.Mvc.Controllers;
89
using OnTopic.AspNetCore.Mvc.Models;
910
using OnTopic.Mapping.Hierarchical;
1011
using OnTopic.Models;
@@ -16,8 +17,8 @@ namespace OnTopic.AspNetCore.Mvc.Components {
1617
| CLASS: PAGE-LEVEL NAVIGATION VIEW COMPONENT
1718
\---------------------------------------------------------------------------------------------------------------------------*/
1819
/// <summary>
19-
/// Defines a <see cref="ViewComponent"/> which provides access to a menu of <typeparamref name="NavigationTopicViewModel"/>
20-
/// instances representing the nearest page-level navigation.
20+
/// Defines a <see cref="ViewComponent"/> which provides access to a menu of <typeparamref name="T"/> instances representing
21+
/// the nearest page-level navigation.
2122
/// </summary>
2223
/// <remarks>
2324
/// <para>

0 commit comments

Comments
 (0)