#1394 more refactor renames and added comments

Author: jantje

io.sloeber.core/src/io/sloeber/core/api/ISerialUser.java

@@ -1,9 +1,40 @@
 package io.sloeber.core.api;
 
+/*
+ * this interface allows none gui core classes to control the gui driven serial communication
+ * 
+ * You should not use this class directly but use the static methods in SerialManager 
+ * as the serial monitor registers on the serialManager and as sutch allowing for gui 
+ * actions from the core
+ * 
+ * 
+ */
 public interface ISerialUser {
-    public boolean PauzePort(String PortName);
 
-    public void ResumePort(String PortName);
+    /**
+     * Pause the serial monitor
+     * This is used for uploads before the upload is started.
+     * After the pause a resumePort call is expected
+     * 
+     * @param PortName
+     * @return true if the pause was executed correctly
+     */
+    public boolean pausePort(String PortName);
 
+    /**
+     * Resume the serial monitor
+     * This is used for uploads after the upload is done.
+     * A pausePort should have been called before calling this method
+     * 
+     * @param PortName
+     */
+    public void resumePort(String PortName);
+
+    /**
+     * Remove the serial connection from the serial monitor
+     * 
+     * @param mComPort
+     * @return
+     */
     public boolean stopPort(String mComPort);
 }

io.sloeber.core/src/io/sloeber/core/api/SerialManager.java

@@ -36,9 +36,9 @@ public static void UnRegisterSerialUser() {
         otherSerialUser = null;
     }
 
-    public static boolean pauzeSerialMonitor(String mComPort) {
+    public static boolean pauseSerialMonitor(String mComPort) {
         if (otherSerialUser != null) {
-            return otherSerialUser.PauzePort(mComPort);
+            return otherSerialUser.pausePort(mComPort);
         }
         return false;
     }
@@ -52,7 +52,7 @@ public static boolean stopSerialMonitor(String mComPort) {
 
     public static void resumeSerialMonitor(String mComPort) {
         if (otherSerialUser != null) {
-            otherSerialUser.ResumePort(mComPort);
+            otherSerialUser.resumePort(mComPort);
         }
 
     }

io.sloeber.core/src/io/sloeber/core/toolchain/SloeberBuildRunner.java

@@ -54,10 +54,10 @@ public boolean invokeBuild(int kind, IProject project, IConfiguration configurat
             }
         }
 
-        boolean theComPortIsPauzed = false;
+        boolean theComPortIsPaused = false;
         if (!actualUploadPort.isBlank()) {
             try {
-                theComPortIsPauzed = SerialManager.pauzeSerialMonitor(actualUploadPort);
+                theComPortIsPaused = SerialManager.pauseSerialMonitor(actualUploadPort);
             } catch (Exception e) {
                 Status ret = new Status(IStatus.WARNING, Const.CORE_PLUGIN_ID, Messages.Upload_Error_com_port, e);
                 Common.log(ret);
@@ -93,7 +93,7 @@ protected IStatus run(IProgressMonitor _monitor) {
         boolean ret = super.invokeBuild(kind, project, configuration, builder, console, markerGenerator, projectBuilder,
                 monitor);
 
-        if (theComPortIsPauzed) {
+        if (theComPortIsPaused) {
             try {
                 SerialManager.resumeSerialMonitor(actualUploadPort);
             } catch (Exception e) {

io.sloeber.core/src/io/sloeber/core/tools/uploaders/UploadSketchWrapper.java

@@ -134,7 +134,7 @@ public UploadJobWrapper(String name, SloeberProject project, ICConfigurationDesc
         @Override
         protected IStatus run(IProgressMonitor monitor) {
             IStatus ret = Status.OK_STATUS;
-            boolean theComPortIsPauzed = false;
+            boolean theComPortIsPaused = false;
 
             String projectName = myProject.getName();
             BoardDescription boardDescriptor = mySProject.getBoardDescription(myConfDes.getName(), true);
@@ -168,7 +168,7 @@ public void run() {
                 highLevelStream.println(message);
                 monitor.beginTask(message, 2);
                 try {
-                    theComPortIsPauzed = SerialManager.pauzeSerialMonitor(myProvidedUploadPort);
+                    theComPortIsPaused = SerialManager.pauseSerialMonitor(myProvidedUploadPort);
                 } catch (Exception e) {
                     ret = new Status(IStatus.WARNING, CORE_PLUGIN_ID, Upload_Error_com_port, e);
                     log(ret);
@@ -185,7 +185,7 @@ public void run() {
                 log(new Status(IStatus.ERROR, CORE_PLUGIN_ID, error, e));
             } finally {
                 try {
-                    if (theComPortIsPauzed) {
+                    if (theComPortIsPaused) {
                         // wait for the port to reappear
                         boolean portFound = false;
                         int counter = 0;

io.sloeber.ui/src/io/sloeber/ui/monitor/views/SerialMonitor.java

@@ -673,7 +673,7 @@ public void ComboSerialChanged() {
 	 * done ResumePort will be called
 	 */
 	@Override
-	public boolean PauzePort(String portName) {
+	public boolean pausePort(String portName) {
 		Serial theSerial = GetSerial(portName);
 		if (theSerial != null) {
 			theSerial.disconnect();
@@ -686,7 +686,7 @@ public boolean PauzePort(String portName) {
 	 * see PauzePort
 	 */
 	@Override
-	public void ResumePort(String portName) {
+	public void resumePort(String portName) {
 		Serial theSerial = GetSerial(portName);
 		if (theSerial != null) {
 			if (MyPreferences.getCleanSerialMonitorAfterUpload()) {