update code/doc

stefanwerfling · Nov 9, 2024 · f957e84 · f957e84
1 parent 2e783bc
commit f957e84
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 7 deletions.
diff --git a/core/src/inc/PluginSystem/APlugin.ts b/core/src/inc/PluginSystem/APlugin.ts
@@ -1,9 +1,8 @@
 import {PluginDefinition} from './PluginDefinition.js';
 import {PluginManager} from './PluginManager.js';
-import {PluginServiceNames} from './PluginServiceNames.js';
 
 /**
- * Plugin
+ * Abstract Plugin class
  */
 export abstract class APlugin {
 
@@ -21,7 +20,8 @@ export abstract class APlugin {
 
     /**
      * constructor
-     * @param info
+     * @param {PluginDefinition} info
+     * @param {PluginManager} pm
      */
     public constructor(info: PluginDefinition, pm: PluginManager) {
         this._info = info;
@@ -31,23 +31,27 @@ export abstract class APlugin {
     /**
      * getPluginManager
      * @protected
+     * @returns {PluginManager}
      */
     protected getPluginManager(): PluginManager {
         return this._pluginManager;
     }
 
     /**
      * plugin name
+     * @returns {string}
      */
     public abstract getName(): string;
 
     /**
      * onEnable
+     * @returns {boolean}
      */
     public abstract onEnable(): boolean;
 
     /**
      * onDisable
+     * @returns {boolean}
      */
     public abstract onDisable(): boolean;
 

diff --git a/core/src/inc/PluginSystem/APluginEvent.ts b/core/src/inc/PluginSystem/APluginEvent.ts
@@ -4,7 +4,8 @@
 export abstract class APluginEvent {
 
     /**
-     * getName
+     * Return the name
+     * @returns {string}
      */
     public abstract getName(): string;
 

diff --git a/core/src/inc/PluginSystem/PluginManager.ts b/core/src/inc/PluginSystem/PluginManager.ts
@@ -251,8 +251,9 @@ export class PluginManager {
     }
 
     /**
-     * getAllEvents
-     * @param aClass
+     * Return all Events
+     * @param {Function} aClass
+     * @returns {APluginEvent[]}
      */
     // eslint-disable-next-line @typescript-eslint/ban-types
     public getAllEvents<T extends APluginEvent>(aClass: Function): T[] {

diff --git a/core/src/inc/PluginSystem/PluginServiceNames.ts b/core/src/inc/PluginSystem/PluginServiceNames.ts
@@ -8,4 +8,4 @@ export enum PluginServiceNames {
     iptable = 'iptable',
     sshserver = 'sshserver',
     vpn = 'vpn'
-};
+}