comments on the method

apps/remix-ide-e2e/src/tests/plugin_api.ts

@@ -91,6 +91,17 @@ const checkForAcceptAndRemember = async function (browser: NightwatchBrowser) {
   })
 }
 
+/**
+ * performs an action on the test local plugin calling a method on a plugin
+ *
+ * @param {NightwatchBrowser} browser
+ * @param {string} buttonText the button which needs to be clicked formatted as pluginname:methodname, ie 'fileManager:writeFile'
+ * @param {any} methodResult can be a string expected or an object. it is the result of the method called. strings are evaluated as part of the result, an object should be exactly the result
+ * @param {any} eventResult can be a string expected or an object. it is the event generated by the method called. strings are evaluated as part of the result, an object should be exactly the result
+ * @param {any} payload can be a string expected or an object. it is the payload passed to the call
+ * @return {Promise}
+ */
+
 const clickAndCheckLog = async (browser: NightwatchBrowser, buttonText: string, methodResult: any, eventResult: any, payload: any) => {
   if (payload) {
     await setPayload(browser, payload)