App: more documentation for DialogExecScript

src/app/dialog_exec_script.cpp

@@ -71,6 +71,9 @@ void DialogExecScript::setScriptFilePath(const FilePath& scriptFilePath)
 
 void DialogExecScript::startScript()
 {
+    if (m_scriptExecIsRunning)
+        return;
+
     m_scriptExecTaskId = m_taskMgr.newTask([=](TaskProgress*) {
         // Override the "console output" handler of LogMessageHandler, first keep the current handler
         // so it can be restored before exiting

src/app/dialog_exec_script.h

@@ -8,24 +8,29 @@
 #include "../base/task_manager.h"
 
 #include <QtWidgets/QDialog>
-
 #include <functional>
 
 class QJSEngine;
 
 namespace Mayo {
 
-using ScriptEngineCreator = std::function<QJSEngine*(QObject*)>;
-
+// Provides a dialog to control execution of a JS script
 class DialogExecScript : public QDialog {
     Q_OBJECT
 public:
+    // Ctor & dtor
     DialogExecScript(QWidget* parent = nullptr);
     ~DialogExecScript();
 
+    // Set the function used to create a JS engine to evaluate scripts
+    using ScriptEngineCreator = std::function<QJSEngine*(QObject*)>;
     void setScriptEngineCreator(ScriptEngineCreator fn);
+
+    // Path to the script file to be executed
     void setScriptFilePath(const FilePath& scriptFilePath);
 
+    // Asynchronous execution of script file defined with setScriptFilePath()
+    // Does nothing(returns) if script execution is currently running
     void startScript();
 
 private:
@@ -39,7 +44,7 @@ class DialogExecScript : public QDialog {
     struct Message {
         QtMsgType type = QtDebugMsg;
         QString text;
-        QString contextFile = nullptr;
+        QString contextFile;
         int contextLine = -1;
     };