From 0bb5b10dba48c1d44243d8972667cf9480e811f5 Mon Sep 17 00:00:00 2001 From: Stone_Red <56473591+Stone-Red-Code@users.noreply.github.com> Date: Thu, 25 Dec 2025 18:19:30 +0100 Subject: [PATCH] Update AsyncPlugin XML docs for clarity and integration details --- src/DesktopMagicPluginAPI/AsyncPlugin.cs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/DesktopMagicPluginAPI/AsyncPlugin.cs b/src/DesktopMagicPluginAPI/AsyncPlugin.cs index f7897b9..ecb90f2 100644 --- a/src/DesktopMagicPluginAPI/AsyncPlugin.cs +++ b/src/DesktopMagicPluginAPI/AsyncPlugin.cs @@ -5,14 +5,14 @@ using System.Threading.Tasks; namespace DesktopMagic.Api; /// -/// Provides an abstract base class for plugins that execute asynchronously. Derive from this class to implement plugins -/// whose main logic runs in a non-blocking manner using asynchronous operations. +/// Provides an abstract base class for creating asynchronous plugins that can be integrated into the application, supporting periodic updates, +/// rendering, and user interaction. /// -/// AsyncPlugin is intended for scenarios where plugin execution should not block the calling thread. -/// Override the MainAsync method to implement asynchronous plugin behavior. The synchronous Main method is sealed and -/// obsolete; it cannot be used for execution and will always throw an exception. Use MainAsync for all plugin logic. -/// The MainAsync method is typically invoked when the UpdateInterval elapses, allowing periodic asynchronous -/// execution. +/// Derive from this class to implement custom plugin functionality. The class defines lifecycle methods +/// such as , , and for activation, deactivation, and periodic +/// execution. It also provides event handlers for mouse and theme interactions, as well as access to application data +/// and rendering configuration. Implementations should override relevant methods to respond to user input, update +/// intervals, and configuration changes as needed. public abstract class AsyncPlugin : Plugin { ///