Diff: max32630fthr.h

Revision:

7:9157b152011b

Parent:

6:92b485e70885

Child:

8:69740ee6903a

diff -r 92b485e70885 -r 9157b152011b max32630fthr.h
--- a/max32630fthr.h	Thu Dec 08 03:33:50 2016 +0000
+++ b/max32630fthr.h	Thu Dec 08 03:38:29 2016 +0000
@@ -152,16 +152,76 @@
     ///@returns 0 if no errors, -1 if error.
     int32_t getBatteryVoltage(float *battVolts);
     
+    
+    ///@brief Gets system voltage voltage as float.\n
+    ///
+    ///On Entry:
+    ///@param[in] sysVolts - pointer to float for storing system voltage 
+    ///
+    ///On Exit:
+    ///@param[out] sysVolts - holds system voltage on success
+    ///
+    ///@returns 0 if no errors, -1 if error.
     int32_t getSysVoltage(float *sysVolts);
     
+    
+    ///@brief Gets buck 1 voltage as float.\n
+    ///
+    ///On Entry:
+    ///@param[in] buckVolts - pointer to float for storing buck 1 voltage 
+    ///
+    ///On Exit:
+    ///@param[out] buckVolts - holds buck 1 voltage on success
+    ///
+    ///@returns 0 if no errors, -1 if error.
     int32_t getBuck1Voltage(float *buckVolts);
     
+    
+    ///@brief Gets buck 2 voltage as float.\n
+    ///
+    ///On Entry:
+    ///@param[in] buckVolts - pointer to float for storing buck 2 voltage 
+    ///
+    ///On Exit:
+    ///@param[out] buckVolts - holds buck 2 voltage on success
+    ///
+    ///@returns 0 if no errors, -1 if error.
     int32_t getBuck2Voltage(float *buckVolts);
     
+    
+    ///@brief Gets LDO1 voltage as float.\n
+    ///
+    ///On Entry:
+    ///@param[in] ldoVolts - pointer to float for storing LDO1 voltage 
+    ///
+    ///On Exit:
+    ///@param[out] ldoVolts - holds LDO1 voltage on success
+    ///
+    ///@returns 0 if no errors, -1 if error.
     int32_t getLDO1Voltage(float *ldoVolts);
     
+    
+    ///@brief Gets LDO2 voltage as float.\n
+    ///
+    ///On Entry:
+    ///@param[in] ldoVolts - pointer to float for storing LDO2 voltage 
+    ///
+    ///On Exit:
+    ///@param[out] ldoVolts - holds LDO2 voltage on success
+    ///
+    ///@returns 0 if no errors, -1 if error.
     int32_t getLDO2Voltage(float *ldoVolts);
     
+    
+    ///@brief Gets LDO3 voltage as float.\n
+    ///
+    ///On Entry:
+    ///@param[in] ldoVolts - pointer to float for storing LDO3 voltage 
+    ///
+    ///On Exit:
+    ///@param[out] ldoVolts - holds LDO3 voltage on success
+    ///
+    ///@returns 0 if no errors, -1 if error.
     int32_t getLDO3Voltage(float *ldoVolts);