Document most models
This commit is contained in:
@ -1,10 +1,16 @@
|
||||
using System;
|
||||
using System.ComponentModel.DataAnnotations.Schema;
|
||||
using Oqtane.Documentation;
|
||||
|
||||
namespace Oqtane.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// Describes a Module type (Definition) in Oqtane.
|
||||
/// The available Modules are determined at StartUp.
|
||||
/// </summary>
|
||||
public class ModuleDefinition : IAuditable
|
||||
{
|
||||
[PrivateApi("The constructor is probably just for internal use and shouldn't appear in the docs")]
|
||||
public ModuleDefinition()
|
||||
{
|
||||
Name = "";
|
||||
@ -26,18 +32,41 @@ namespace Oqtane.Models
|
||||
Template = "";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reference to the <see cref="ModuleDefinition"/>.
|
||||
/// </summary>
|
||||
public int ModuleDefinitionId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Name of the <see cref="ModuleDefinition"/>
|
||||
/// </summary>
|
||||
public string ModuleDefinitionName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Nice name to show in admin / edit dialogs.
|
||||
/// </summary>
|
||||
public string Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Module description for admin dialogs.
|
||||
/// </summary>
|
||||
public string Description { get; set; }
|
||||
public string Categories { get; set; }
|
||||
public string Version { get; set; }
|
||||
|
||||
#region IAuditable Properties
|
||||
|
||||
/// <inheritdoc/>
|
||||
public string CreatedBy { get; set; }
|
||||
/// <inheritdoc/>
|
||||
public DateTime CreatedOn { get; set; }
|
||||
/// <inheritdoc/>
|
||||
public string ModifiedBy { get; set; }
|
||||
/// <inheritdoc/>
|
||||
public DateTime ModifiedOn { get; set; }
|
||||
|
||||
#endregion
|
||||
|
||||
// additional IModule properties
|
||||
[NotMapped]
|
||||
public string Owner { get; set; }
|
||||
|
Reference in New Issue
Block a user