From 5b8e6d4df6b0b1a02a777a20f7072e842767557d Mon Sep 17 00:00:00 2001 From: ijungleboy Date: Thu, 11 Nov 2021 20:01:55 +0100 Subject: [PATCH] Add many PrivateApi attributes to hide unimportant stuff in docs --- Oqtane.Client/Modules/Admin/ModuleCreator/ModuleInfo.cs | 4 +++- Oqtane.Client/Modules/HtmlText/ModuleInfo.cs | 2 ++ Oqtane.Client/Modules/HtmlText/Services/HtmlTextService.cs | 2 ++ Oqtane.Client/Modules/HtmlText/Services/IHtmlTextService.cs | 4 +++- Oqtane.Client/Program.cs | 2 ++ Oqtane.Client/Themes/BlazorTheme/ThemeInfo.cs | 4 +++- Oqtane.Client/Themes/OqtaneTheme/ThemeInfo.cs | 2 ++ .../Infrastructure/SiteTemplates/DefaultSiteTemplate.cs | 2 ++ .../Infrastructure/SiteTemplates/EmptySiteTemplate.cs | 2 ++ .../Modules/HtmlText/Controllers/HtmlTextController.cs | 2 ++ Oqtane.Server/Modules/HtmlText/Manager/HtmlTextManager.cs | 2 ++ .../Modules/HtmlText/Migrations/01000000_InitializeModule.cs | 2 ++ .../Migrations/EntityBuilders/HtmlTextEntityBuilder.cs | 2 ++ Oqtane.Server/Modules/HtmlText/Repository/HtmlTextContext.cs | 2 ++ .../Modules/HtmlText/Repository/HtmlTextRepository.cs | 4 +++- .../Modules/HtmlText/Repository/IHtmlTextRepository.cs | 4 +++- Oqtane.Server/Program.cs | 2 ++ Oqtane.Shared/Modules/HtmlText/Models/HtmlText.cs | 2 ++ 18 files changed, 41 insertions(+), 5 deletions(-) diff --git a/Oqtane.Client/Modules/Admin/ModuleCreator/ModuleInfo.cs b/Oqtane.Client/Modules/Admin/ModuleCreator/ModuleInfo.cs index 81b82a6d..7eb2f372 100644 --- a/Oqtane.Client/Modules/Admin/ModuleCreator/ModuleInfo.cs +++ b/Oqtane.Client/Modules/Admin/ModuleCreator/ModuleInfo.cs @@ -1,7 +1,9 @@ -using Oqtane.Models; +using Oqtane.Documentation; +using Oqtane.Models; namespace Oqtane.Modules.Admin.ModuleCreator { + [PrivateApi("Mark this as private, since it's not very useful in the public docs")] public class ModuleInfo : IModule { public ModuleDefinition ModuleDefinition => new ModuleDefinition diff --git a/Oqtane.Client/Modules/HtmlText/ModuleInfo.cs b/Oqtane.Client/Modules/HtmlText/ModuleInfo.cs index fbe6cf9e..36e674fe 100644 --- a/Oqtane.Client/Modules/HtmlText/ModuleInfo.cs +++ b/Oqtane.Client/Modules/HtmlText/ModuleInfo.cs @@ -1,7 +1,9 @@ +using Oqtane.Documentation; using Oqtane.Models; namespace Oqtane.Modules.HtmlText { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class ModuleInfo : IModule { public ModuleDefinition ModuleDefinition => new ModuleDefinition diff --git a/Oqtane.Client/Modules/HtmlText/Services/HtmlTextService.cs b/Oqtane.Client/Modules/HtmlText/Services/HtmlTextService.cs index 73776394..85583f7e 100644 --- a/Oqtane.Client/Modules/HtmlText/Services/HtmlTextService.cs +++ b/Oqtane.Client/Modules/HtmlText/Services/HtmlTextService.cs @@ -1,10 +1,12 @@ using System.Net.Http; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Services; using Oqtane.Shared; namespace Oqtane.Modules.HtmlText.Services { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class HtmlTextService : ServiceBase, IHtmlTextService, IService { public HtmlTextService(HttpClient http, SiteState siteState) : base(http, siteState) {} diff --git a/Oqtane.Client/Modules/HtmlText/Services/IHtmlTextService.cs b/Oqtane.Client/Modules/HtmlText/Services/IHtmlTextService.cs index c663882a..80d725a9 100644 --- a/Oqtane.Client/Modules/HtmlText/Services/IHtmlTextService.cs +++ b/Oqtane.Client/Modules/HtmlText/Services/IHtmlTextService.cs @@ -1,9 +1,11 @@ -using System.Collections.Generic; +using System.Collections.Generic; using System.Threading.Tasks; +using Oqtane.Documentation; using Oqtane.Modules.HtmlText.Models; namespace Oqtane.Modules.HtmlText.Services { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public interface IHtmlTextService { Task GetHtmlTextAsync(int ModuleId); diff --git a/Oqtane.Client/Program.cs b/Oqtane.Client/Program.cs index 68bcc7a2..162b9e2a 100644 --- a/Oqtane.Client/Program.cs +++ b/Oqtane.Client/Program.cs @@ -12,6 +12,7 @@ using Microsoft.AspNetCore.Components.WebAssembly.Hosting; using Microsoft.AspNetCore.Localization; using Microsoft.Extensions.DependencyInjection; using Microsoft.JSInterop; +using Oqtane.Documentation; using Oqtane.Modules; using Oqtane.Services; using Oqtane.Shared; @@ -19,6 +20,7 @@ using Oqtane.UI; namespace Oqtane.Client { + [PrivateApi("Mark Entry-Program as private, since it's not very useful in the public docs")] public class Program { public static async Task Main(string[] args) diff --git a/Oqtane.Client/Themes/BlazorTheme/ThemeInfo.cs b/Oqtane.Client/Themes/BlazorTheme/ThemeInfo.cs index 7c52e766..2b9e4e84 100644 --- a/Oqtane.Client/Themes/BlazorTheme/ThemeInfo.cs +++ b/Oqtane.Client/Themes/BlazorTheme/ThemeInfo.cs @@ -1,7 +1,9 @@ -using Oqtane.Models; +using Oqtane.Documentation; +using Oqtane.Models; namespace Oqtane.Themes.BlazorTheme { + [PrivateApi("Mark Build-In Theme-Info classes as private, since it's not very useful in the public docs")] public class ThemeInfo : ITheme { public Theme Theme => new Theme diff --git a/Oqtane.Client/Themes/OqtaneTheme/ThemeInfo.cs b/Oqtane.Client/Themes/OqtaneTheme/ThemeInfo.cs index 4ac16269..763c694c 100644 --- a/Oqtane.Client/Themes/OqtaneTheme/ThemeInfo.cs +++ b/Oqtane.Client/Themes/OqtaneTheme/ThemeInfo.cs @@ -1,7 +1,9 @@ +using Oqtane.Documentation; using Oqtane.Models; namespace Oqtane.Themes.OqtaneTheme { + [PrivateApi("Mark Build-In Theme-Info classes as private, since it's not very useful in the public docs")] public class ThemeInfo : ITheme { public Theme Theme => new Theme diff --git a/Oqtane.Server/Infrastructure/SiteTemplates/DefaultSiteTemplate.cs b/Oqtane.Server/Infrastructure/SiteTemplates/DefaultSiteTemplate.cs index 5e7e39bc..a1370f9f 100644 --- a/Oqtane.Server/Infrastructure/SiteTemplates/DefaultSiteTemplate.cs +++ b/Oqtane.Server/Infrastructure/SiteTemplates/DefaultSiteTemplate.cs @@ -6,9 +6,11 @@ using Microsoft.AspNetCore.Hosting; using Oqtane.Extensions; using Oqtane.Shared; using System.IO; +using Oqtane.Documentation; namespace Oqtane.SiteTemplates { + [PrivateApi("Mark Site-Template classes as private, since it's not very useful in the public docs")] public class DefaultSiteTemplate : ISiteTemplate { diff --git a/Oqtane.Server/Infrastructure/SiteTemplates/EmptySiteTemplate.cs b/Oqtane.Server/Infrastructure/SiteTemplates/EmptySiteTemplate.cs index e37cbbcb..c5aa907d 100644 --- a/Oqtane.Server/Infrastructure/SiteTemplates/EmptySiteTemplate.cs +++ b/Oqtane.Server/Infrastructure/SiteTemplates/EmptySiteTemplate.cs @@ -4,9 +4,11 @@ using System.Collections.Generic; using Oqtane.Extensions; using Oqtane.Repository; using Oqtane.Shared; +using Oqtane.Documentation; namespace Oqtane.SiteTemplates { + [PrivateApi("Mark Site-Template classes as private, since it's not very useful in the public docs")] public class EmptySiteTemplate : ISiteTemplate { public EmptySiteTemplate() diff --git a/Oqtane.Server/Modules/HtmlText/Controllers/HtmlTextController.cs b/Oqtane.Server/Modules/HtmlText/Controllers/HtmlTextController.cs index 4f0f75e2..020d6e48 100644 --- a/Oqtane.Server/Modules/HtmlText/Controllers/HtmlTextController.cs +++ b/Oqtane.Server/Modules/HtmlText/Controllers/HtmlTextController.cs @@ -7,10 +7,12 @@ using Oqtane.Enums; using Oqtane.Infrastructure; using Oqtane.Controllers; using System.Net; +using Oqtane.Documentation; namespace Oqtane.Modules.HtmlText.Controllers { [Route(ControllerRoutes.ApiRoute)] + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class HtmlTextController : ModuleControllerBase { private readonly IHtmlTextRepository _htmlText; diff --git a/Oqtane.Server/Modules/HtmlText/Manager/HtmlTextManager.cs b/Oqtane.Server/Modules/HtmlText/Manager/HtmlTextManager.cs index d38183b2..f9a862e8 100644 --- a/Oqtane.Server/Modules/HtmlText/Manager/HtmlTextManager.cs +++ b/Oqtane.Server/Modules/HtmlText/Manager/HtmlTextManager.cs @@ -7,11 +7,13 @@ using Oqtane.Enums; using Oqtane.Repository; using Oqtane.Shared; using Oqtane.Migrations.Framework; +using Oqtane.Documentation; // ReSharper disable ConvertToUsingDeclaration namespace Oqtane.Modules.HtmlText.Manager { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class HtmlTextManager : MigratableModuleBase, IInstallable, IPortable { private readonly IHtmlTextRepository _htmlText; diff --git a/Oqtane.Server/Modules/HtmlText/Migrations/01000000_InitializeModule.cs b/Oqtane.Server/Modules/HtmlText/Migrations/01000000_InitializeModule.cs index 094c32e3..9068d6c6 100644 --- a/Oqtane.Server/Modules/HtmlText/Migrations/01000000_InitializeModule.cs +++ b/Oqtane.Server/Modules/HtmlText/Migrations/01000000_InitializeModule.cs @@ -1,6 +1,7 @@ using Microsoft.EntityFrameworkCore.Infrastructure; using Microsoft.EntityFrameworkCore.Migrations; using Oqtane.Databases.Interfaces; +using Oqtane.Documentation; using Oqtane.Migrations; using Oqtane.Modules.HtmlText.Migrations.EntityBuilders; using Oqtane.Modules.HtmlText.Repository; @@ -9,6 +10,7 @@ namespace Oqtane.Modules.HtmlText.Migrations { [DbContext(typeof(HtmlTextContext))] [Migration("HtmlText.01.00.00.00")] + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class InitializeModule : MultiDatabaseMigration { public InitializeModule(IDatabase database) : base(database) diff --git a/Oqtane.Server/Modules/HtmlText/Migrations/EntityBuilders/HtmlTextEntityBuilder.cs b/Oqtane.Server/Modules/HtmlText/Migrations/EntityBuilders/HtmlTextEntityBuilder.cs index 15fdb296..2866140f 100644 --- a/Oqtane.Server/Modules/HtmlText/Migrations/EntityBuilders/HtmlTextEntityBuilder.cs +++ b/Oqtane.Server/Modules/HtmlText/Migrations/EntityBuilders/HtmlTextEntityBuilder.cs @@ -2,6 +2,7 @@ using Microsoft.EntityFrameworkCore.Migrations; using Microsoft.EntityFrameworkCore.Migrations.Operations; using Microsoft.EntityFrameworkCore.Migrations.Operations.Builders; using Oqtane.Databases.Interfaces; +using Oqtane.Documentation; using Oqtane.Interfaces; using Oqtane.Migrations; using Oqtane.Migrations.EntityBuilders; @@ -11,6 +12,7 @@ using Oqtane.Migrations.EntityBuilders; namespace Oqtane.Modules.HtmlText.Migrations.EntityBuilders { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class HtmlTextEntityBuilder : AuditableBaseEntityBuilder { private const string _entityTableName = "HtmlText"; diff --git a/Oqtane.Server/Modules/HtmlText/Repository/HtmlTextContext.cs b/Oqtane.Server/Modules/HtmlText/Repository/HtmlTextContext.cs index 0232cd43..e0c4c99f 100644 --- a/Oqtane.Server/Modules/HtmlText/Repository/HtmlTextContext.cs +++ b/Oqtane.Server/Modules/HtmlText/Repository/HtmlTextContext.cs @@ -1,5 +1,6 @@ using Microsoft.AspNetCore.Http; using Microsoft.EntityFrameworkCore; +using Oqtane.Documentation; using Oqtane.Infrastructure; using Oqtane.Repository; using Oqtane.Repository.Databases.Interfaces; @@ -9,6 +10,7 @@ using Oqtane.Repository.Databases.Interfaces; namespace Oqtane.Modules.HtmlText.Repository { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class HtmlTextContext : DBContextBase, IService, IMultiDatabase { public HtmlTextContext(ITenantManager tenantManager, IHttpContextAccessor httpContextAccessor) : base(tenantManager, httpContextAccessor) { } diff --git a/Oqtane.Server/Modules/HtmlText/Repository/HtmlTextRepository.cs b/Oqtane.Server/Modules/HtmlText/Repository/HtmlTextRepository.cs index 633a5b25..a2229f0e 100644 --- a/Oqtane.Server/Modules/HtmlText/Repository/HtmlTextRepository.cs +++ b/Oqtane.Server/Modules/HtmlText/Repository/HtmlTextRepository.cs @@ -1,9 +1,11 @@ -using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore; using System.Linq; using Oqtane.Modules.HtmlText.Models; +using Oqtane.Documentation; namespace Oqtane.Modules.HtmlText.Repository { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class HtmlTextRepository : IHtmlTextRepository, IService { private readonly HtmlTextContext _db; diff --git a/Oqtane.Server/Modules/HtmlText/Repository/IHtmlTextRepository.cs b/Oqtane.Server/Modules/HtmlText/Repository/IHtmlTextRepository.cs index 75daf276..014c5adc 100644 --- a/Oqtane.Server/Modules/HtmlText/Repository/IHtmlTextRepository.cs +++ b/Oqtane.Server/Modules/HtmlText/Repository/IHtmlTextRepository.cs @@ -1,7 +1,9 @@ -using Oqtane.Modules.HtmlText.Models; +using Oqtane.Documentation; +using Oqtane.Modules.HtmlText.Models; namespace Oqtane.Modules.HtmlText.Repository { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public interface IHtmlTextRepository { Models.HtmlText GetHtmlText(int moduleId); diff --git a/Oqtane.Server/Program.cs b/Oqtane.Server/Program.cs index 14a64abc..49a5542a 100644 --- a/Oqtane.Server/Program.cs +++ b/Oqtane.Server/Program.cs @@ -7,9 +7,11 @@ using Oqtane.Infrastructure; using System.Diagnostics; using Microsoft.Extensions.Logging; using Oqtane.Shared; +using Oqtane.Documentation; namespace Oqtane.Server { + [PrivateApi("Mark Entry-Program as private, since it's not very useful in the public docs")] public class Program { public static void Main(string[] args) diff --git a/Oqtane.Shared/Modules/HtmlText/Models/HtmlText.cs b/Oqtane.Shared/Modules/HtmlText/Models/HtmlText.cs index 25efbb23..988fc8bc 100644 --- a/Oqtane.Shared/Modules/HtmlText/Models/HtmlText.cs +++ b/Oqtane.Shared/Modules/HtmlText/Models/HtmlText.cs @@ -2,9 +2,11 @@ using System; using Oqtane.Models; using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations.Schema; +using Oqtane.Documentation; namespace Oqtane.Modules.HtmlText.Models { + [PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")] public class HtmlText : IAuditable { [Key]