Update from PSI

r1039 | ffr | 2006-08-03 09:59:29 +1000 (Thu, 03 Aug 2006) | 2 lines

scanvar.h

@@ -21,7 +21,7 @@
                    float      fStep;
                    float      *fData;
                    int        dataList;
-                   int logVar;
+                   int        logVar;
                   }VarEntry, *pVarEntry;
 
 /*---------------------------------------------------------------------*/
@@ -35,22 +35,21 @@
   * @param start The start position from which to scan
   * @param step The step width with which to scan.
   * @return A pointer to a new scan variable object on success, NULL
-  * else NULL
+  * else
   */
   pVarEntry MakeScanVar(SicsInterp *pSics, SConnection *pCon, char
                         *name, float start, float step);
-  /*
-   * Make a variable which is logged during the scan
-   * @param pSics The SICS interpreter to search for the variable
-   * @param pCon A connection to report problems to
-   * @param name The name of the variable to log
-  * @return A pointer to a new scan variable object on success, NULL
-  * else NULL
+  /**
+    * make a variable which is logged during the scan but not driven.
+  * @param pSics The interpreter in order to locate the variable.
+  * @param pCon A connection object for error reporting
+  * @param name The name of the variable to log
   */
-  pVarEntry MakeLogVar(SicsInterp *pSics, SConnection *pCon, char *name);                      
+  pVarEntry MakeLogVar(SicsInterp *pSics, 
+        SConnection *pCon, char *name);
   /**
     * InitScanVar clears the list of scan points
-    * @param pvar The scan variable to clear
+    * @param pvar The scna variable to clear
     */
   void InitScanVar(pVarEntry pVar);
   /**
@@ -76,14 +75,6 @@
     * @return The step width for the scan.
     */
   float ScanVarStep(pVarEntry pVar);
-  /**
-   * check if the scan is possible, i.e the scan variable does
-   * not violate the limits in the scan
-   * @param pVar The scan variable to check
-   * @param pCon The connection to report errors to
-   * @return 1 when OK, 0 when the limits are violated.
-   */ 
-  int CheckScanVar(pVarEntry pVar, SConnection *pCon, int np);
   /**
     * StartScanVar starts the scan variable to drive to the next
     * position.
@@ -115,7 +106,19 @@
     */
   void CopyScanVar(pVarEntry pVar, float *fData, int np);
   /**
-   * enquires if a variable is a logged variable or a proper scan variable
-   */
+    * CheckScanVar checks if the scan variable can be driven through the
+    * whole range.
+    * @param pVar The scan variable to check
+    * @param pCon The connection object to which to report errors.
+    * @param np The number of  points to check for.
+    * @return 0 on failuyre, 1 on success
+    */
+  int CheckScanVar(pVarEntry pVar, SConnection *pCon, int np);
+  /**
+    * queries if the variable is alogged variable or a drive one.
+    * @param pVar The variable to query.
+    * @return 1 if log var, 0 else
+    */
   int isLogVar(pVarEntry pVar);
+
 #endif