Some docs

XanderStoffels · Jan 22, 2023 · 5e04721 · 5e04721
1 parent dbda3e2
commit 5e04721
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/Beacon.API/Plugins/IPlugin.cs b/Beacon.API/Plugins/IPlugin.cs
@@ -4,8 +4,17 @@ namespace Beacon.API.Plugins;
 
 public interface IPlugin
 {
-
+    /// <summary>
+    /// Configure any services that this plugin provides.
+    /// Services include Event Handlers, Commands, shared services and more.
+    /// </summary>
+    /// <remarks>Gets called when the plugin is loaded, before <see cref="EnableAsync"/></remarks>
+    /// <param name="services"></param>
     void ConfigureServices(IServiceRegistration services);
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <returns></returns>
     Task EnableAsync();
     Task DisableAsync();
 }
diff --git a/Beacon.API/Plugins/Services/IServiceRegistration.cs b/Beacon.API/Plugins/Services/IServiceRegistration.cs
@@ -21,7 +21,7 @@ public interface IServiceRegistration
     /// <typeparam name="TInterface"></typeparam>
     /// <typeparam name="TImplementation"></typeparam>
     /// <returns>The service will have be registered as a singleton.</returns>
-    IServiceRegistration RegisterPluginService<TInterface, TImplementation>()
+    IServiceRegistration RegisterSharedService<TInterface, TImplementation>()
         where TInterface : class
         where TImplementation : class, TInterface;