Add many PrivateApi attributes to hide unimportant stuff in docs
This commit is contained in:
parent
087c053bd5
commit
5b8e6d4df6
|
@ -1,7 +1,9 @@
|
||||||
using Oqtane.Models;
|
using Oqtane.Documentation;
|
||||||
|
using Oqtane.Models;
|
||||||
|
|
||||||
namespace Oqtane.Modules.Admin.ModuleCreator
|
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 class ModuleInfo : IModule
|
||||||
{
|
{
|
||||||
public ModuleDefinition ModuleDefinition => new ModuleDefinition
|
public ModuleDefinition ModuleDefinition => new ModuleDefinition
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
|
using Oqtane.Documentation;
|
||||||
using Oqtane.Models;
|
using Oqtane.Models;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText
|
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 class ModuleInfo : IModule
|
||||||
{
|
{
|
||||||
public ModuleDefinition ModuleDefinition => new ModuleDefinition
|
public ModuleDefinition ModuleDefinition => new ModuleDefinition
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
using System.Net.Http;
|
using System.Net.Http;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
|
using Oqtane.Documentation;
|
||||||
using Oqtane.Services;
|
using Oqtane.Services;
|
||||||
using Oqtane.Shared;
|
using Oqtane.Shared;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.Services
|
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 class HtmlTextService : ServiceBase, IHtmlTextService, IService
|
||||||
{
|
{
|
||||||
public HtmlTextService(HttpClient http, SiteState siteState) : base(http, siteState) {}
|
public HtmlTextService(HttpClient http, SiteState siteState) : base(http, siteState) {}
|
||||||
|
|
|
@ -1,9 +1,11 @@
|
||||||
using System.Collections.Generic;
|
using System.Collections.Generic;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
|
using Oqtane.Documentation;
|
||||||
using Oqtane.Modules.HtmlText.Models;
|
using Oqtane.Modules.HtmlText.Models;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.Services
|
namespace Oqtane.Modules.HtmlText.Services
|
||||||
{
|
{
|
||||||
|
[PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")]
|
||||||
public interface IHtmlTextService
|
public interface IHtmlTextService
|
||||||
{
|
{
|
||||||
Task<Models.HtmlText> GetHtmlTextAsync(int ModuleId);
|
Task<Models.HtmlText> GetHtmlTextAsync(int ModuleId);
|
||||||
|
|
|
@ -12,6 +12,7 @@ using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
|
||||||
using Microsoft.AspNetCore.Localization;
|
using Microsoft.AspNetCore.Localization;
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
using Microsoft.Extensions.DependencyInjection;
|
||||||
using Microsoft.JSInterop;
|
using Microsoft.JSInterop;
|
||||||
|
using Oqtane.Documentation;
|
||||||
using Oqtane.Modules;
|
using Oqtane.Modules;
|
||||||
using Oqtane.Services;
|
using Oqtane.Services;
|
||||||
using Oqtane.Shared;
|
using Oqtane.Shared;
|
||||||
|
@ -19,6 +20,7 @@ using Oqtane.UI;
|
||||||
|
|
||||||
namespace Oqtane.Client
|
namespace Oqtane.Client
|
||||||
{
|
{
|
||||||
|
[PrivateApi("Mark Entry-Program as private, since it's not very useful in the public docs")]
|
||||||
public class Program
|
public class Program
|
||||||
{
|
{
|
||||||
public static async Task Main(string[] args)
|
public static async Task Main(string[] args)
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
using Oqtane.Models;
|
using Oqtane.Documentation;
|
||||||
|
using Oqtane.Models;
|
||||||
|
|
||||||
namespace Oqtane.Themes.BlazorTheme
|
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 class ThemeInfo : ITheme
|
||||||
{
|
{
|
||||||
public Theme Theme => new Theme
|
public Theme Theme => new Theme
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
|
using Oqtane.Documentation;
|
||||||
using Oqtane.Models;
|
using Oqtane.Models;
|
||||||
|
|
||||||
namespace Oqtane.Themes.OqtaneTheme
|
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 class ThemeInfo : ITheme
|
||||||
{
|
{
|
||||||
public Theme Theme => new Theme
|
public Theme Theme => new Theme
|
||||||
|
|
|
@ -6,9 +6,11 @@ using Microsoft.AspNetCore.Hosting;
|
||||||
using Oqtane.Extensions;
|
using Oqtane.Extensions;
|
||||||
using Oqtane.Shared;
|
using Oqtane.Shared;
|
||||||
using System.IO;
|
using System.IO;
|
||||||
|
using Oqtane.Documentation;
|
||||||
|
|
||||||
namespace Oqtane.SiteTemplates
|
namespace Oqtane.SiteTemplates
|
||||||
{
|
{
|
||||||
|
[PrivateApi("Mark Site-Template classes as private, since it's not very useful in the public docs")]
|
||||||
public class DefaultSiteTemplate : ISiteTemplate
|
public class DefaultSiteTemplate : ISiteTemplate
|
||||||
{
|
{
|
||||||
|
|
||||||
|
|
|
@ -4,9 +4,11 @@ using System.Collections.Generic;
|
||||||
using Oqtane.Extensions;
|
using Oqtane.Extensions;
|
||||||
using Oqtane.Repository;
|
using Oqtane.Repository;
|
||||||
using Oqtane.Shared;
|
using Oqtane.Shared;
|
||||||
|
using Oqtane.Documentation;
|
||||||
|
|
||||||
namespace Oqtane.SiteTemplates
|
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 class EmptySiteTemplate : ISiteTemplate
|
||||||
{
|
{
|
||||||
public EmptySiteTemplate()
|
public EmptySiteTemplate()
|
||||||
|
|
|
@ -7,10 +7,12 @@ using Oqtane.Enums;
|
||||||
using Oqtane.Infrastructure;
|
using Oqtane.Infrastructure;
|
||||||
using Oqtane.Controllers;
|
using Oqtane.Controllers;
|
||||||
using System.Net;
|
using System.Net;
|
||||||
|
using Oqtane.Documentation;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.Controllers
|
namespace Oqtane.Modules.HtmlText.Controllers
|
||||||
{
|
{
|
||||||
[Route(ControllerRoutes.ApiRoute)]
|
[Route(ControllerRoutes.ApiRoute)]
|
||||||
|
[PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")]
|
||||||
public class HtmlTextController : ModuleControllerBase
|
public class HtmlTextController : ModuleControllerBase
|
||||||
{
|
{
|
||||||
private readonly IHtmlTextRepository _htmlText;
|
private readonly IHtmlTextRepository _htmlText;
|
||||||
|
|
|
@ -7,11 +7,13 @@ using Oqtane.Enums;
|
||||||
using Oqtane.Repository;
|
using Oqtane.Repository;
|
||||||
using Oqtane.Shared;
|
using Oqtane.Shared;
|
||||||
using Oqtane.Migrations.Framework;
|
using Oqtane.Migrations.Framework;
|
||||||
|
using Oqtane.Documentation;
|
||||||
|
|
||||||
// ReSharper disable ConvertToUsingDeclaration
|
// ReSharper disable ConvertToUsingDeclaration
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.Manager
|
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
|
public class HtmlTextManager : MigratableModuleBase, IInstallable, IPortable
|
||||||
{
|
{
|
||||||
private readonly IHtmlTextRepository _htmlText;
|
private readonly IHtmlTextRepository _htmlText;
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
using Microsoft.EntityFrameworkCore.Infrastructure;
|
using Microsoft.EntityFrameworkCore.Infrastructure;
|
||||||
using Microsoft.EntityFrameworkCore.Migrations;
|
using Microsoft.EntityFrameworkCore.Migrations;
|
||||||
using Oqtane.Databases.Interfaces;
|
using Oqtane.Databases.Interfaces;
|
||||||
|
using Oqtane.Documentation;
|
||||||
using Oqtane.Migrations;
|
using Oqtane.Migrations;
|
||||||
using Oqtane.Modules.HtmlText.Migrations.EntityBuilders;
|
using Oqtane.Modules.HtmlText.Migrations.EntityBuilders;
|
||||||
using Oqtane.Modules.HtmlText.Repository;
|
using Oqtane.Modules.HtmlText.Repository;
|
||||||
|
@ -9,6 +10,7 @@ namespace Oqtane.Modules.HtmlText.Migrations
|
||||||
{
|
{
|
||||||
[DbContext(typeof(HtmlTextContext))]
|
[DbContext(typeof(HtmlTextContext))]
|
||||||
[Migration("HtmlText.01.00.00.00")]
|
[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 class InitializeModule : MultiDatabaseMigration
|
||||||
{
|
{
|
||||||
public InitializeModule(IDatabase database) : base(database)
|
public InitializeModule(IDatabase database) : base(database)
|
||||||
|
|
|
@ -2,6 +2,7 @@ using Microsoft.EntityFrameworkCore.Migrations;
|
||||||
using Microsoft.EntityFrameworkCore.Migrations.Operations;
|
using Microsoft.EntityFrameworkCore.Migrations.Operations;
|
||||||
using Microsoft.EntityFrameworkCore.Migrations.Operations.Builders;
|
using Microsoft.EntityFrameworkCore.Migrations.Operations.Builders;
|
||||||
using Oqtane.Databases.Interfaces;
|
using Oqtane.Databases.Interfaces;
|
||||||
|
using Oqtane.Documentation;
|
||||||
using Oqtane.Interfaces;
|
using Oqtane.Interfaces;
|
||||||
using Oqtane.Migrations;
|
using Oqtane.Migrations;
|
||||||
using Oqtane.Migrations.EntityBuilders;
|
using Oqtane.Migrations.EntityBuilders;
|
||||||
|
@ -11,6 +12,7 @@ using Oqtane.Migrations.EntityBuilders;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.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<HtmlTextEntityBuilder>
|
public class HtmlTextEntityBuilder : AuditableBaseEntityBuilder<HtmlTextEntityBuilder>
|
||||||
{
|
{
|
||||||
private const string _entityTableName = "HtmlText";
|
private const string _entityTableName = "HtmlText";
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
using Microsoft.AspNetCore.Http;
|
using Microsoft.AspNetCore.Http;
|
||||||
using Microsoft.EntityFrameworkCore;
|
using Microsoft.EntityFrameworkCore;
|
||||||
|
using Oqtane.Documentation;
|
||||||
using Oqtane.Infrastructure;
|
using Oqtane.Infrastructure;
|
||||||
using Oqtane.Repository;
|
using Oqtane.Repository;
|
||||||
using Oqtane.Repository.Databases.Interfaces;
|
using Oqtane.Repository.Databases.Interfaces;
|
||||||
|
@ -9,6 +10,7 @@ using Oqtane.Repository.Databases.Interfaces;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.Repository
|
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 class HtmlTextContext : DBContextBase, IService, IMultiDatabase
|
||||||
{
|
{
|
||||||
public HtmlTextContext(ITenantManager tenantManager, IHttpContextAccessor httpContextAccessor) : base(tenantManager, httpContextAccessor) { }
|
public HtmlTextContext(ITenantManager tenantManager, IHttpContextAccessor httpContextAccessor) : base(tenantManager, httpContextAccessor) { }
|
||||||
|
|
|
@ -1,9 +1,11 @@
|
||||||
using Microsoft.EntityFrameworkCore;
|
using Microsoft.EntityFrameworkCore;
|
||||||
using System.Linq;
|
using System.Linq;
|
||||||
using Oqtane.Modules.HtmlText.Models;
|
using Oqtane.Modules.HtmlText.Models;
|
||||||
|
using Oqtane.Documentation;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.Repository
|
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
|
public class HtmlTextRepository : IHtmlTextRepository, IService
|
||||||
{
|
{
|
||||||
private readonly HtmlTextContext _db;
|
private readonly HtmlTextContext _db;
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
using Oqtane.Modules.HtmlText.Models;
|
using Oqtane.Documentation;
|
||||||
|
using Oqtane.Modules.HtmlText.Models;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.Repository
|
namespace Oqtane.Modules.HtmlText.Repository
|
||||||
{
|
{
|
||||||
|
[PrivateApi("Mark HtmlText classes as private, since it's not very useful in the public docs")]
|
||||||
public interface IHtmlTextRepository
|
public interface IHtmlTextRepository
|
||||||
{
|
{
|
||||||
Models.HtmlText GetHtmlText(int moduleId);
|
Models.HtmlText GetHtmlText(int moduleId);
|
||||||
|
|
|
@ -7,9 +7,11 @@ using Oqtane.Infrastructure;
|
||||||
using System.Diagnostics;
|
using System.Diagnostics;
|
||||||
using Microsoft.Extensions.Logging;
|
using Microsoft.Extensions.Logging;
|
||||||
using Oqtane.Shared;
|
using Oqtane.Shared;
|
||||||
|
using Oqtane.Documentation;
|
||||||
|
|
||||||
namespace Oqtane.Server
|
namespace Oqtane.Server
|
||||||
{
|
{
|
||||||
|
[PrivateApi("Mark Entry-Program as private, since it's not very useful in the public docs")]
|
||||||
public class Program
|
public class Program
|
||||||
{
|
{
|
||||||
public static void Main(string[] args)
|
public static void Main(string[] args)
|
||||||
|
|
|
@ -2,9 +2,11 @@ using System;
|
||||||
using Oqtane.Models;
|
using Oqtane.Models;
|
||||||
using System.ComponentModel.DataAnnotations;
|
using System.ComponentModel.DataAnnotations;
|
||||||
using System.ComponentModel.DataAnnotations.Schema;
|
using System.ComponentModel.DataAnnotations.Schema;
|
||||||
|
using Oqtane.Documentation;
|
||||||
|
|
||||||
namespace Oqtane.Modules.HtmlText.Models
|
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
|
public class HtmlText : IAuditable
|
||||||
{
|
{
|
||||||
[Key]
|
[Key]
|
||||||
|
|
Loading…
Reference in New Issue
Block a user