fix: adjust enigma mocker comment

qlik-oss · Sep 15, 2022 · afe1421 · afe1421
1 parent 476d7bd
commit afe1421
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 39 deletions.
diff --git a/apis/enigma-mocker/src/index.js b/apis/enigma-mocker/src/index.js
@@ -11,6 +11,7 @@ import fGO from './from-generic-objects';
 /**
  * @entry
  * @alias EnigmaMocker
+ * @description Mocks Engima app functionality for demo and testing purposes.
  */
 const api = /** @lends EnigmaMocker# */ {
   /**

diff --git a/apis/stardust/api-spec/spec.json b/apis/stardust/api-spec/spec.json
@@ -513,6 +513,7 @@
       ]
     },
     "EnigmaMocker": {
+      "description": "Mocks Engima app functionality for demo and testing purposes.",
       "kind": "object",
       "entries": {
         "fromGenericObjects": {
@@ -1361,6 +1362,33 @@
         }
       }
     },
+    "Plugin": {
+      "description": "An object literal containing meta information about the plugin and a function containing the plugin implementation.",
+      "stability": "experimental",
+      "availability": {
+        "since": "1.2.0"
+      },
+      "kind": "interface",
+      "entries": {
+        "info": {
+          "description": "Object that can hold various meta info about the plugin",
+          "kind": "object",
+          "entries": {
+            "name": {
+              "description": "The name of the plugin",
+              "type": "string"
+            }
+          }
+        },
+        "fn": {
+          "description": "The implementation of the plugin. Input and return value is up to the plugin implementation to decide based on its purpose.",
+          "type": "function"
+        }
+      },
+      "examples": [
+        "const plugin = {\n  info: {\n    name: \"example-plugin\",\n    type: \"meta-type\",\n  },\n  fn: () => {\n    // Plugin implementation goes here\n  }\n};"
+      ]
+    },
     "LoadType": {
       "kind": "interface",
       "params": [
@@ -1406,33 +1434,6 @@
         }
       }
     },
-    "Plugin": {
-      "description": "An object literal containing meta information about the plugin and a function containing the plugin implementation.",
-      "stability": "experimental",
-      "availability": {
-        "since": "1.2.0"
-      },
-      "kind": "interface",
-      "entries": {
-        "info": {
-          "description": "Object that can hold various meta info about the plugin",
-          "kind": "object",
-          "entries": {
-            "name": {
-              "description": "The name of the plugin",
-              "type": "string"
-            }
-          }
-        },
-        "fn": {
-          "description": "The implementation of the plugin. Input and return value is up to the plugin implementation to decide based on its purpose.",
-          "type": "function"
-        }
-      },
-      "examples": [
-        "const plugin = {\n  info: {\n    name: \"example-plugin\",\n    type: \"meta-type\",\n  },\n  fn: () => {\n    // Plugin implementation goes here\n  }\n};"
-      ]
-    },
     "ActionToolbarElement": {
       "availability": {
         "since": "2.1.0"
@@ -2391,7 +2392,7 @@
       "entries": {}
     },
     "EnigmaMockerOptions": {
-      "description": "Mocks Engima app functionality for demo and testing purposes.",
+      "description": "Options for Enigma Mocker",
       "stability": "experimental",
       "availability": {
         "since": "3.0.0"

diff --git a/apis/stardust/types/index.d.ts b/apis/stardust/types/index.d.ts
@@ -413,6 +413,16 @@ declare namespace stardust {
         type: "dimension" | "measure";
     }
 
+    /**
+     * An object literal containing meta information about the plugin and a function containing the plugin implementation.
+     */
+    interface Plugin {
+        info: {
+            name: string;
+        };
+        fn: ()=>void;
+    }
+
     interface LoadType {
         (type: {
             name: string;
@@ -427,16 +437,6 @@ declare namespace stardust {
         meta?: object;
     }
 
-    /**
-     * An object literal containing meta information about the plugin and a function containing the plugin implementation.
-     */
-    interface Plugin {
-        info: {
-            name: string;
-        };
-        fn: ()=>void;
-    }
-
     interface ActionToolbarElement extends HTMLElement{
         className: "njs-action-toolbar-popover";
     }
@@ -707,7 +707,7 @@ declare namespace stardust {
     }
 
     /**
-     * Mocks Engima app functionality for demo and testing purposes.
+     * Options for Enigma Mocker
      */
     interface EnigmaMockerOptions {
         delay: number;