More documentation - almost all Models done

https://github.com/oqtane/oqtane.framework/issues/1382
Should not contain any code changes, just docs
This commit is contained in:
ijungleboy
2021-05-26 00:01:22 +02:00
parent 7ec3376308
commit bcff9caf5c
16 changed files with 479 additions and 9 deletions

View File

@ -3,6 +3,9 @@ using System.Collections.Generic;
namespace Oqtane.Models
{
/// <summary>
/// Information about a Theme in Oqtane.
/// </summary>
public class Theme
{
public Theme()
@ -20,14 +23,47 @@ namespace Oqtane.Models
PackageName = "";
}
/// <summary>
/// Full Namespace / Identifier of the Theme.
/// </summary>
public string ThemeName { get; set; }
/// <summary>
/// Nice Name of the Theme.
/// </summary>
public string Name { get; set; }
/// <summary>
/// Version as determined by the DLL / NuGet Package.
/// </summary>
public string Version { get; set; }
/// <summary>
/// Author / Creator of the Theme.
/// </summary>
public string Owner { get; set; }
/// <summary>
/// URL (in NuGet) of the Theme
/// </summary>
public string Url { get; set; }
/// <summary>
/// Author Contact information
/// </summary>
public string Contact { get; set; }
/// <summary>
/// Theme License, like `MIT` etc.
/// </summary>
public string License { get; set; }
/// <summary>
/// Theme Dependencies (DLLs) which the system will check if they exist
/// </summary>
public string Dependencies { get; set; }
public string ThemeSettingsType { get; set; } // added in 2.0.2
public string ContainerSettingsType { get; set; } // added in 2.0.2
public string PackageName { get; set; } // added in 2.1.0