diff --git a/Oqtane.Shared/Interfaces/IAuditable.cs b/Oqtane.Shared/Interfaces/IAuditable.cs
index 83cd1c1f..7e8c5dce 100644
--- a/Oqtane.Shared/Interfaces/IAuditable.cs
+++ b/Oqtane.Shared/Interfaces/IAuditable.cs
@@ -1,12 +1,30 @@
-using System;
+using System;
namespace Oqtane.Models
{
+ ///
+ /// Basic create/edit information - used in many objects.
+ ///
public interface IAuditable
{
+ ///
+ /// Username of the creator of this Object.
+ ///
string CreatedBy { get; set; }
+
+ ///
+ /// Created Timestamp for this Object.
+ ///
DateTime CreatedOn { get; set; }
+
+ ///
+ /// Username of the last user who modified this Object.
+ ///
string ModifiedBy { get; set; }
+
+ ///
+ /// Modified Timestamp for this Object.
+ ///
DateTime ModifiedOn { get; set; }
}
}
diff --git a/Oqtane.Shared/Interfaces/IDeletable.cs b/Oqtane.Shared/Interfaces/IDeletable.cs
index 7880f8ff..1f155224 100644
--- a/Oqtane.Shared/Interfaces/IDeletable.cs
+++ b/Oqtane.Shared/Interfaces/IDeletable.cs
@@ -1,11 +1,25 @@
-using System;
+using System;
namespace Oqtane.Models
{
+ ///
+ /// Audit information for things than can be deleted.
+ ///
public interface IDeletable
{
+ ///
+ /// who deleted this object.
+ ///
string DeletedBy { get; set; }
+
+ ///
+ /// Timestamp when it was deleted.
+ ///
DateTime? DeletedOn { get; set; }
+
+ ///
+ /// If something is deleted, this will be true.
+ ///
bool IsDeleted { get; set; }
}
}
diff --git a/Oqtane.Shared/Interfaces/IModuleControl.cs b/Oqtane.Shared/Interfaces/IModuleControl.cs
index 1002bd2d..7d9dd5c7 100644
--- a/Oqtane.Shared/Interfaces/IModuleControl.cs
+++ b/Oqtane.Shared/Interfaces/IModuleControl.cs
@@ -1,4 +1,4 @@
-using Oqtane.Models;
+using Oqtane.Models;
using Oqtane.Shared;
using System.Collections.Generic;
@@ -6,10 +6,29 @@ namespace Oqtane.Modules
{
public interface IModuleControl
{
- SecurityAccessLevel SecurityAccessLevel { get; } // defines the security access level for this control - defaults to View
- string Title { get; } // title to display for this control - defaults to module title
- string Actions { get; } // allows for routing by configuration rather than by convention ( comma delimited ) - defaults to using component file name
- bool UseAdminContainer { get; } // container for embedding module control - defaults to true. false will suppress the default modal UI popup behavior and render the component in the page.
- List Resources { get; } // identifies all resources in a module
+ ///
+ /// Defines the security access level for this control - defaults to View
+ ///
+ SecurityAccessLevel SecurityAccessLevel { get; }
+
+ ///
+ /// Title to display for this control - defaults to module title
+ ///
+ string Title { get; }
+
+ ///
+ /// Allows for routing by configuration rather than by convention ( comma delimited ) - defaults to using component file name
+ ///
+ string Actions { get; }
+
+ ///
+ /// Container for embedding module control - defaults to true. false will suppress the default modal UI popup behavior and render the component in the page.
+ ///
+ bool UseAdminContainer { get; }
+
+ ///
+ /// Identifies all resources in a module
+ ///
+ List Resources { get; }
}
}
diff --git a/Oqtane.Shared/Interfaces/IService.cs b/Oqtane.Shared/Interfaces/IService.cs
index b7330d81..ff30723a 100644
--- a/Oqtane.Shared/Interfaces/IService.cs
+++ b/Oqtane.Shared/Interfaces/IService.cs
@@ -1,7 +1,9 @@
-namespace Oqtane.Modules
+namespace Oqtane.Modules
{
+ ///
+ /// Empty interface used to decorate module services for auto registration
+ ///
public interface IService
{
- // empty interface used to decorate module services for auto registration
}
}
diff --git a/Oqtane.Shared/Interfaces/IThemeControl.cs b/Oqtane.Shared/Interfaces/IThemeControl.cs
index f147afba..ef5d9bc2 100644
--- a/Oqtane.Shared/Interfaces/IThemeControl.cs
+++ b/Oqtane.Shared/Interfaces/IThemeControl.cs
@@ -1,13 +1,28 @@
-using Oqtane.Models;
+using Oqtane.Models;
using System.Collections.Generic;
namespace Oqtane.Themes
{
public interface IThemeControl
{
- string Name { get; } // friendly name for a theme
- string Thumbnail { get; } // screen shot of a theme - assumed to be in the ThemePath() folder
- string Panes { get; } // identifies all panes in a theme ( delimited by "," or ";") - assumed to be a layout if no panes specified
- List Resources { get; } // identifies all resources in a theme
+ ///
+ /// Friendly name for a theme
+ ///
+ string Name { get; }
+
+ ///
+ /// Screen shot of a theme - assumed to be in the ThemePath() folder
+ ///
+ string Thumbnail { get; }
+
+ ///
+ /// Identifies all panes in a theme ( delimited by "," or ";") - assumed to be a layout if no panes specified
+ ///
+ string Panes { get; }
+
+ ///
+ /// Identifies all resources in a theme
+ ///
+ List Resources { get; }
}
}