mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-08-31 19:08:29 +00:00
docs: update XML comments for Essentials Core
This commit is contained in:
parent
0764685c51
commit
f88bb13367
260 changed files with 7018 additions and 1318 deletions
|
|
@ -15,6 +15,9 @@ namespace PepperDash.Essentials.Core
|
|||
/// </summary>
|
||||
public class ProcessorExtensionDeviceFactory
|
||||
{
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
public ProcessorExtensionDeviceFactory() {
|
||||
var assy = Assembly.GetExecutingAssembly();
|
||||
PluginLoader.SetEssentialsAssembly(assy.GetName().Name, assy);
|
||||
|
|
@ -50,7 +53,8 @@ namespace PepperDash.Essentials.Core
|
|||
/// <summary>
|
||||
/// Adds a plugin factory method
|
||||
/// </summary>
|
||||
/// <param name="dc"></param>
|
||||
/// <param name="extensionName">name fo extension to add</param>
|
||||
/// <param name="method">method to add</param>
|
||||
/// <returns></returns>
|
||||
public static void AddFactoryForType(string extensionName, Func<DeviceConfig, IKeyed> method)
|
||||
{
|
||||
|
|
@ -58,6 +62,13 @@ namespace PepperDash.Essentials.Core
|
|||
ProcessorExtensionDeviceFactory.ProcessorExtensionFactoryMethods.Add(extensionName, new DeviceFactoryWrapper() { FactoryMethod = method });
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds a plugin factory method with type and description
|
||||
/// </summary>
|
||||
/// <param name="extensionName">name of extension to add</param>
|
||||
/// <param name="description">description of extension to add</param>
|
||||
/// <param name="Type">type of extension to add</param>
|
||||
/// <param name="method">method to add</param>
|
||||
public static void AddFactoryForType(string extensionName, string description, Type Type, Func<DeviceConfig, IKeyed> method)
|
||||
{
|
||||
//Debug.LogMessage(LogEventLevel.Debug, "Adding factory method for type '{0}'", typeName);
|
||||
|
|
|
|||
|
|
@ -17,6 +17,10 @@ namespace PepperDash.Essentials.Core
|
|||
/// </summary>
|
||||
public bool IsReady { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Constructor
|
||||
/// </summary>
|
||||
/// <param name="data">indicates if the object is ready</param>
|
||||
public IsReadyEventArgs(bool data)
|
||||
{
|
||||
IsReady = data;
|
||||
|
|
@ -28,7 +32,14 @@ namespace PepperDash.Essentials.Core
|
|||
/// </summary>
|
||||
public interface IHasReady
|
||||
{
|
||||
/// <summary>
|
||||
/// Fires when the IsReady property changes
|
||||
/// </summary>
|
||||
event EventHandler<IsReadyEventArgs> IsReadyEvent;
|
||||
|
||||
/// <summary>
|
||||
/// indicates whether the object is ready
|
||||
/// </summary>
|
||||
bool IsReady { get; }
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue