Added documentation to the DesktopMagicPluginAPI

src/DesktopMagicPluginAPI/Plugin.cs

@@ -3,10 +3,16 @@ using System.Drawing;
 
 namespace DesktopMagicPluginAPI
 {
+    /// <summary>
+    /// The plugin class
+    /// </summary>
     public abstract class Plugin
     {
         private IPluginData application = null;
 
+        /// <summary>
+        /// Informations about the main application
+        /// </summary>
         public IPluginData Application
         {
             get => application;
@@ -23,14 +29,29 @@ namespace DesktopMagicPluginAPI
             }
         }
 
+        /// <summary>
+        /// Gets or sets the interval, expressed in milliseconds, at which to call the <see cref="Main"/> method.
+        /// </summary>
         public virtual int UpdateInterval { get; set; } = 1000;
 
+        /// <summary>
+        /// Occurs when the <see cref="UpdateInterval"/> elapses.
+        /// </summary>
+        /// <returns></returns>
         public abstract Bitmap Main();
 
+        /// <summary>
+        /// Occurs when the window is clicked by the mouse.
+        /// </summary>
+        /// <param name="position"></param>
         public virtual void OnMouseClick(Point position)
         {
         }
 
+        /// <summary>
+        /// Occurs when the mouse pointer is moved over the control.
+        /// </summary>
+        /// <param name="position"></param>
         public virtual void OnMouseMove(Point position)
         {
         }