kocoded/oqtane.framework
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #3624 from thabaum/documentation-spelling-correction

Browse Source 
Documentation spelling correction.  Fixes #3623
This commit is contained in:
Shaun Walker 2024-01-09 14:52:55 -05:00 committed by GitHub
commit cd6be0d755
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Oqtane.Client/Services/Interfaces/IModuleService.cs
View File

@ -5,7 +5,7 @@ using System.Threading.Tasks;
namespace Oqtane.Services namespace Oqtane.Services
{ {
/// <summary> /// <summary>
/// Service to retreive and store modules (<see cref="Module"/>) /// Service to retrieve and store modules (<see cref="Module"/>)
/// </summary> /// </summary>
public interface IModuleService public interface IModuleService
{ {

2
Oqtane.Client/Services/Interfaces/INotificationService.cs
View File

@ -5,7 +5,7 @@ using System.Threading.Tasks;
namespace Oqtane.Services namespace Oqtane.Services
{ {
/// <summary> /// <summary>
/// Service to store and retreive notifications (<see cref="Notification"/>) /// Service to store and retrieve notifications (<see cref="Notification"/>)
/// </summary> /// </summary>
public interface INotificationService public interface INotificationService
{ {

2
Oqtane.Client/Services/Interfaces/IPageModuleService.cs
View File

@ -4,7 +4,7 @@ using System.Threading.Tasks;
namespace Oqtane.Services namespace Oqtane.Services
{ {
/// <summary> /// <summary>
/// Service to store and retreive a <see cref="PageModule"/> /// Service to store and retrieve a <see cref="PageModule"/>
/// </summary> /// </summary>
public interface IPageModuleService public interface IPageModuleService
{ {

2
Oqtane.Client/Services/Interfaces/IProfileService.cs
View File

@ -5,7 +5,7 @@ using System.Threading.Tasks;
namespace Oqtane.Services namespace Oqtane.Services
{ {
/// <summary> /// <summary>
/// Service to store and retreive <see cref="Profile"/> entries /// Service to store and retrieve <see cref="Profile"/> entries
/// </summary> /// </summary>
public interface IProfileService public interface IProfileService
{ {

2
Oqtane.Client/Services/Interfaces/ISiteService.cs
View File

@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace Oqtane.Services namespace Oqtane.Services
{ {
/// <summary> /// <summary>
/// Service to store and retreive <see cref="Site"/> entries /// Service to store and retrieve <see cref="Site"/> entries
/// </summary> /// </summary>
public interface ISiteService public interface ISiteService
{ {

2
Oqtane.Client/Services/Interfaces/ISiteTemplateService.cs
View File

@ -5,7 +5,7 @@ using System.Threading.Tasks;
namespace Oqtane.Services namespace Oqtane.Services
{ {
/// <summary> /// <summary>
/// Service to retreive <see cref="SiteTemplate"/> entries /// Service to retrieve <see cref="SiteTemplate"/> entries
/// </summary> /// </summary>
public interface ISiteTemplateService public interface ISiteTemplateService
{ {

4
Oqtane.Client/Services/Interfaces/IThemeService.cs
View File

@ -17,7 +17,7 @@ namespace Oqtane.Services
Task<List<Theme>> GetThemesAsync(); Task<List<Theme>> GetThemesAsync();
/// <summary> /// <summary>
/// Returns a specific thenme /// Returns a specific theme
/// </summary> /// </summary>
/// <param name="themeId"></param> /// <param name="themeId"></param>
/// <param name="siteId"></param> /// <param name="siteId"></param>
@ -56,7 +56,7 @@ namespace Oqtane.Services
List<ThemeControl> GetContainerControls(List<Theme> themes, string themeControlType); List<ThemeControl> GetContainerControls(List<Theme> themes, string themeControlType);
/// <summary> /// <summary>
/// Updates a existing theem /// Updates a existing theme
/// </summary> /// </summary>
/// <param name="theme"></param> /// <param name="theme"></param>
/// <returns></returns> /// <returns></returns>

2
Oqtane.Shared/Documentation/readme.md
View File

@ -2,6 +2,6 @@
This folder contains special attributes for the API Code Generator. This folder contains special attributes for the API Code Generator.
The idea is that only items marked with special attributes are valide public APIs, and only these will be documented in the public docs The idea is that only items marked with special attributes are valid public APIs, and only these will be documented in the public docs
As of 2020, all APIs are documented, and only these marked as `[PrivateApi]` will be excluded. In future, we may reverse this to only document things marked as `[PublicApi]`. As of 2020, all APIs are documented, and only these marked as `[PrivateApi]` will be excluded. In future, we may reverse this to only document things marked as `[PublicApi]`.