style(bktemp-updateLoopPI):add function comment

[BK-2020-03.git] / unitproc / bktemp-updateLoopPI

diff --git a/unitproc/bktemp-updateLoopPI b/unitproc/bktemp-updateLoopPI
index 84adb77be28b03112923739f52deb023facfae23..2c345ab1b23b2b2e8b0e33822c1dc764c23c3618 100644 (file)
--- a/unitproc/bktemp-updateLoopPI
+++ b/unitproc/bktemp-updateLoopPI
@@ -9,7 +9,7 @@ update_pi() {
     #   process variable (PV). Uses proportional integral (PI)
     #   control.
     # Usage: update_pi arg1 arg2 arg3 arg4 arg5 arg6
     #   process variable (PV). Uses proportional integral (PI)
     #   control.
     # Usage: update_pi arg1 arg2 arg3 arg4 arg5 arg6

-    # Version: 0.1.0
+    # Version: 0.1.1

     # Input: arg1: path_loop_name (control loop name path)
     #        arg2: var_pv (process variable)
     #        arg3: var_sp (set point)
     # Input: arg1: path_loop_name (control loop name path)
     #        arg2: var_pv (process variable)
     #        arg3: var_sp (set point)


@@ -98,7 +98,7 @@ update_pi() {
     echo "$var_cv";
 
     #yell "DEBUG:=============END_ROUND===============";
     echo "$var_cv";
 
     #yell "DEBUG:=============END_ROUND===============";

-}
+} # update specified PI loop

 #==END function definition==
 
 #==BEGIN Example code==
 #==END function definition==
 
 #==BEGIN Example code==