Example program for EVAL-ADMX2001

Dependencies:   ADMX2001

Revision:
9:29db35656fcb
Parent:
8:bd0b93e35392
Child:
10:186e097fb1e3
--- a/calibrate.cpp	Wed Oct 27 21:18:12 2021 +0000
+++ b/calibrate.cpp	Tue Nov 02 10:14:25 2021 +0000
@@ -79,6 +79,7 @@
  * @param [in] calType - Type of Calibrate
  * @param [in] stdR - stdR value
  * @param [in] stdX - stdX value
+ * @return Returns 0 for success or negative error code.
  * \ref Calibrate
  */
 int32_t Calibrate(CAL_TYPE calType, float stdR, float stdX)
@@ -155,6 +156,7 @@
 
 /**
  * @brief  Function to read and display calibrated values
+ * @return Returns 0 for success or negative error code.
  */
 int32_t ReadAndDisplayCalibratedValue()
 {
@@ -199,8 +201,11 @@
 }
 
 /**
- * @brief  Dsiplays the output value
- * \ref DisplayCalibratedValue
+ * @brief  Displays the output value
+ * @param [in] displayVal1 - display value 1
+ * @param [in] displayVal2 - display value 2
+ * @param [in] sweepVar - sweep variable
+ * @return Returns 0 for success or negative error code.
  */
 void DisplayCalibratedValue(double displayVal1, double displayVal2,
                             double sweepVar)