remove C# comment style

simraconsulting · Nov 21, 2022 · b44d41b · b44d41b
1 parent 5cdbfef
commit b44d41b
Show file tree

Hide file tree

Showing 17 changed files with 86 additions and 190 deletions.
diff --git a/src/Input/BinSignal.st b/src/Input/BinSignal.st
@@ -34,30 +34,22 @@ NAMESPACE Simatic.Ax.IO.Input
         END_METHOD
 
 
-        /// <summary>
-        /// </summary>
-        /// <RETURNs>Returns if the signal is inverted</RETURNs>
+        ///Returns if the signal is inverted
         METHOD PUBLIC IsInverted : BOOL                        
             IsInverted := invert;
         END_METHOD
 
-        /// <summary>
-        /// </summary>
-        /// <RETURNs>Returns the current status of BinSignal</RETURNs>
+        ///Returns the current status of BinSignal
         METHOD PUBLIC Q : BOOL
             Q := _statusQ;
         END_METHOD
 
-        /// <summary>
-        /// </summary>
-        /// <RETURNs>Returns if a rising edge was detected in the current cycle</RETURNs>
+        ///Returns if a rising edge was detected in the current cycle
         METHOD PUBLIC QRis : BOOL
             QRis := _statusQRis;            
         END_METHOD
 
-        /// <summary>
-        /// </summary>
-        /// <RETURNs>Returns if a falling edge was detected in the current cycle</RETURNs>
+        ///Returns if a falling edge was detected in the current cycle
         METHOD PUBLIC QFal : BOOL
             QFal := _statusQFal;
         END_METHOD

diff --git a/src/Input/BinSignalExt.st b/src/Input/BinSignalExt.st
@@ -11,12 +11,10 @@ NAMESPACE Simatic.Ax.IO.Input
             _signalInOld : BOOL;
         END_VAR
 
-        /// <summary>
         /// Read digital signal (must be executed in every cycle - recommendation: begin of cycle in case of digital input signals)
-        /// </summary>
-        /// <param name="signal">Digital/Boolean signal</param>
-        /// <param name="valid">signal is valid (if FALSE, the default value will be used); default = TRUE</param>
-        /// <param name="default">default value which is used, when valid 0 FALSE</param>        
+        /// Digital/Boolean signal
+        /// signal is valid (if FALSE, the default value will be used); default = TRUE
+        /// default value which is used, when valid 0 FALSE        
         METHOD PUBLIC OVERRIDE ReadCyclic
             VAR_INPUT
                 signal : BOOL;

diff --git a/src/Input/DintInput.st b/src/Input/DintInput.st
@@ -1,7 +1,5 @@
 NAMESPACE Simatic.Ax.IO.Input
-    /// <summary>
-    /// Class to handle DINT input values 
-    /// </summary>
+    /// Class to handle DINT input values
     CLASS DintInput EXTENDS InputBase
 
         VAR PRIVATE
@@ -10,20 +8,16 @@ NAMESPACE Simatic.Ax.IO.Input
             _qBad : BOOL;
         END_VAR
 
-        /// <summary>
         /// The max and min value of datataype Dint
-        /// </summary>
         VAR CONSTANT PUBLIC
             MIN : DINT := DINT#-2147483648;
             MAX : DINT := DINT#2147483647;
         END_VAR
 
-        /// <summary>
         /// Read the input value from Input area of type Double Integer
-        /// </summary>
-        /// <param name="value">The double integer input value</param>
-        /// <param name="valid">The input value is valid (e.g. periphery is ok)</param>
-        /// <param name="default">Default value if valid = FALSE</param>
+        /// The double integer input value
+        /// The input value is valid (e.g. periphery is ok)
+        /// Default value if valid = FALSE
         METHOD PUBLIC ReadCyclic
             VAR_INPUT
                 value : DINT;
@@ -36,10 +30,8 @@ NAMESPACE Simatic.Ax.IO.Input
             _default := default;
         END_METHOD
 
-        /// <summary>
         /// Returns the actual value of double integer
-        /// </summary>
-        /// <returns>Actual value of the DINT</returns>
+        /// Actual value of the DINT
         METHOD PUBLIC Q : DINT
             IF (NOT(THIS.QBad())) THEN 
                 Q := _value;

diff --git a/src/Input/InputBase.st b/src/Input/InputBase.st
@@ -1,27 +1,21 @@
 NAMESPACE Simatic.Ax.IO.Input
-    /// <summary>
     /// QBad-Status of binary input signal
-    /// </summary>
     CLASS InputBase
         VAR PROTECTED
             _isQBad : BOOL; // TRUE : signal is invalid
         END_VAR
 
-    /// <summary>
     /// Set the status to QBad
-    /// </summary>
-    /// <param name="value">OnDelay value for BinSignal</param>
+    /// OnDelay value for BinSignal
     METHOD PROTECTED QBad
         VAR_INPUT
             value : BOOL;
         END_VAR
         _isQBad := value; 
     END_METHOD
 
-    /// <summary>
     /// Returns the QBad-Status of BinSignal. If valid = FALSE --> QBad = TRUE 
-    /// </summary>
-    /// <returns>The QBad-Status of BinSignal</returns>
+    /// The QBad-Status of BinSignal
     METHOD PUBLIC QBad : BOOL
         QBad := _isQBad;
         ;

diff --git a/src/Input/IntInput.st b/src/Input/IntInput.st
@@ -1,27 +1,21 @@
 NAMESPACE Simatic.Ax.IO.Input
-    /// <summary>
     /// Class to handle INT input values 
-    /// </summary>
     CLASS IntInput EXTENDS InputBase
 
         VAR PRIVATE
             _value : INT := 0;
             _default : INT := 0;
         END_VAR
-        /// <summary>
         /// The max and min value of datataype int
-        /// </summary>
         VAR CONSTANT PUBLIC
             MAX : INT := 32767;
             MIN : INT := -32768;
         END_VAR
 
-        /// <summary>
         /// Read the input value from Input area of type Integer
-        /// </summary>
-        /// <param name="value">The integer input value</param>
-        /// <param name="valid">The input value is valid (e.g. periphery is ok)</param>
-        /// <param name="default">Default value if valid = FALSE</param>
+        /// The integer input value
+        /// The input value is valid (e.g. periphery is ok)
+        /// Default value if valid = FALSE
         METHOD PUBLIC ReadCyclic
             VAR_INPUT
                 value : INT;
@@ -34,10 +28,8 @@ NAMESPACE Simatic.Ax.IO.Input
             _default := default;
         END_METHOD
 
-        /// <summary>
         /// Returns the actual value of integer
-        /// </summary>
-        /// <returns>Actual value of the INT</returns>
+        /// Actual value of the INT
         METHOD PUBLIC Q : Int
             IF (NOT(THIS.QBad())) THEN 
                 Q := _value;

diff --git a/src/Input/LRealInput.st b/src/Input/LRealInput.st
@@ -1,28 +1,22 @@
 NAMESPACE Simatic.Ax.IO.Input
-    /// <summary>
     /// Class to handle LREAL input values 
-    /// </summary>
     CLASS LRealInput EXTENDS InputBase
 
         VAR PRIVATE
             _value : LREAL := LREAL#0.0;
             _default : LREAL := LREAL#0.0;
         END_VAR
 
-        /// <summary>
         /// The max and min value of datataype LReal
-        /// </summary>
         VAR CONSTANT PUBLIC
             MAX : LREAL := LREAL#1.79769313486231e+308;
             MIN : LREAL := LREAL#-1.79769313486231e+308;
         END_VAR
 
-        /// <summary>
         /// Read the input value from Input area of type Real
-        /// </summary>
-        /// <param name="value">The integer input value</param>
-        /// <param name="valid">The input value is valid (e.g. periphery is ok)</param>
-        /// <param name="default">Default value if valid = FALSE</param>
+        /// The integer input value
+        /// The input value is valid (e.g. periphery is ok)
+        /// Default value if valid = FALSE
         METHOD PUBLIC ReadCyclic
             VAR_INPUT
                 value : LWORD;
@@ -35,12 +29,10 @@ NAMESPACE Simatic.Ax.IO.Input
             _default := default;
         END_METHOD
 
-        /// <summary>
         /// Read the input value from Input area of type Real
-        /// </summary>
-        /// <param name="value">The LREAL input value</param>
-        /// <param name="valid">The input value is valid (e.g. periphery is ok)</param>
-        /// <param name="default">Default value if valid = FALSE</param>
+        /// The LREAL input value
+        /// The input value is valid (e.g. periphery is ok)
+        /// Default value if valid = FALSE
         METHOD PUBLIC ReadCyclic
             VAR_INPUT
                 value : LREAL;
@@ -53,10 +45,8 @@ NAMESPACE Simatic.Ax.IO.Input
             _default := default;
         END_METHOD
 
-        /// <summary>
         /// Returns the actual value of integer
-        /// </summary>
-        /// <returns>Actual value of the LREAL input</returns>
+        /// Actual value of the LREAL input
         METHOD PUBLIC Q : LREAL
             IF (NOT(THIS.QBad())) THEN 
                 Q := _value;

diff --git a/src/Input/RealInput.st b/src/Input/RealInput.st
@@ -1,28 +1,22 @@
 NAMESPACE Simatic.Ax.IO.Input
-    /// <summary>
     /// Class to handle REAL input values 
-    /// </summary>
     CLASS RealInput EXTENDS InputBase
 
         VAR PRIVATE
             _value : REAL := REAL#0.0;
             _default : REAL := REAL#0.0;
         END_VAR
 
-        /// <summary>
         /// The max and min value of datataype LReal
-        /// </summary>
         VAR CONSTANT PUBLIC
             MAX : REAL := REAL#+3.402823e+38;
             MIN : REAL := REAL#-3.402823e+38;
         END_VAR
-
-        /// <summary>
+
         /// Read the input value from Input area of type Real
-        /// </summary>
-        /// <param name="value">The integer input value</param>
-        /// <param name="valid">The input value is valid (e.g. periphery is ok)</param>
-        /// <param name="default">Default value if valid = FALSE</param>
+        /// The integer input value
+        /// The input value is valid (e.g. periphery is ok)
+        /// Default value if valid = FALSE
         METHOD PUBLIC ReadCyclic
             VAR_INPUT
                 value : DWORD;
@@ -35,10 +29,8 @@ NAMESPACE Simatic.Ax.IO.Input
             _default := default;
         END_METHOD
 
-        /// <summary>
         /// Returns the actual value of integer
-        /// </summary>
-        /// <returns>Actual value of the REAL input</returns>
+        /// Actual value of the REAL input
         METHOD PUBLIC Q : REAL
             IF (NOT(THIS.QBad())) THEN 
                 Q := _value;

diff --git a/src/Input/WordInput.st b/src/Input/WordInput.st
@@ -1,28 +1,25 @@
 NAMESPACE Simatic.Ax.IO.Input
-    /// <summary>
-    /// Class to handle WORD input values 
-    /// </summary>
+
+    /// Class to handle WORD input values  
     CLASS WordInput EXTENDS InputBase
 
         VAR PRIVATE
             _value : WORD := WORD#16#0;
             _default : WORD := WORD#16#0;
         END_VAR
 
-        /// <summary>
+
         /// The max and min value of datataype word
-        /// </summary>
         VAR CONSTANT PUBLIC
             MIN : WORD := WORD#16#0;
             MAX : WORD := WORD#16#FFFF;
         END_VAR
 
-        /// <summary>
+
         /// Read the input value from Input area of type Integer
-        /// </summary>
-        /// <param name="value">The integer input value</param>
-        /// <param name="valid">The input value is valid (e.g. periphery is ok)</param>
-        /// <param name="default">Default value if valid = FALSE</param>
+        /// The integer input value
+        /// The input value is valid (e.g. periphery is ok)
+        /// Default value if valid = FALSE
         METHOD PUBLIC ReadCyclic
             VAR_INPUT
                 value : WORD;
@@ -35,10 +32,9 @@ NAMESPACE Simatic.Ax.IO.Input
             _default := default;
         END_METHOD
 
-        /// <summary>
+
         /// Returns the actual value of integer
-        /// </summary>
-        /// <returns>Actual value of the WORD input</returns>
+        /// Actual value of the WORD input
         METHOD PUBLIC Q : WORD
             IF (NOT(THIS.QBad())) THEN 
                 Q := _value;