Revision 6:6b8a9d1ad49a, committed 2013-08-09

Comitter:

neilt6

Date:

Fri Aug 09 19:14:47 2013 +0000

Parent:

5:f8b36d66b768

Child:

7:bebde8098fca

Commit message:

Fixed mistakes in documentation

Changed in this revision

--- a/LM75B.h	Wed Aug 07 18:34:19 2013 +0000
+++ b/LM75B.h	Fri Aug 09 19:14:47 2013 +0000
@@ -106,79 +106,79 @@
 
     /** Get the current power mode of the LM75B
      *
-     * @returns The current power mode as an LM75B_OS_Mode_t enum.
+     * @returns The current power mode as a PowerMode enum.
      */
     LM75B::PowerMode getPowerMode(void);
 
     /** Set the power mode of the LM75B
      *
-     * @param mode The new power mode as an LM75B_OS_Mode_t enum.
+     * @param mode The new power mode as a PowerMode enum.
      */
     void setPowerMode(PowerMode mode);
 
     /** Get the current OS pin mode of the LM75B
      *
-     * @returns The current OS pin mode as an LM75B_OS_Mode_t enum.
+     * @returns The current OS pin mode as an OSMode enum.
      */
     LM75B::OSMode getOSMode(void);
 
     /** Set the OS pin mode of the LM75B
      *
-     * @param mode The new OS pin mode as an LM75B_OS_Mode_t enum.
+     * @param mode The new OS pin mode as an OSMode enum.
      */
     void setOSMode(OSMode mode);
 
     /** Get the current OS pin polarity of the LM75B
      *
-     * @returns The current OS pin polarity as an LM75B_OS_Polarity_t enum.
+     * @returns The current OS pin polarity as an OSPolarity enum.
      */
     LM75B::OSPolarity getOSPolarity(void);
 
     /** Set the OS pin polarity of the LM75B
      *
-     * @param polarity The new OS pin polarity as an LM75B_OS_Polarity_t enum.
+     * @param polarity The new OS pin polarity as an OSPolarity enum.
      */
     void setOSPolarity(OSPolarity polarity);
 
     /** Get the current OS pin fault queue length of the LM75B
      *
-     * @returns The current OS pin fault queue length as an LM75B_OS_FaultQueue_t enum.
+     * @returns The current OS pin fault queue length as an OSFaultQueue enum.
      */
     LM75B::OSFaultQueue getOSFaultQueue(void);
 
     /** Set the OS pin fault queue length of the LM75B
      *
-     * @param queue The new OS pin fault queue length as an LM75B_OS_FaultQueue_t enum.
+     * @param queue The new OS pin fault queue length as an OSFaultQueue enum.
      */
     void setOSFaultQueue(OSFaultQueue queue);
 
     /** Get the current alert temperature threshold of the LM75B
      *
-     * @returns The current alert temperature threshold as a float.
+     * @returns The current alert temperature threshold in °C.
      */
     float getAlertTemp(void);
 
     /** Set the alert temperature threshold of the LM75B
      *
-     * @param temp The new alert temperature threshold as a float.
+     * @param temp The new alert temperature threshold in °C.
      */
     void setAlertTemp(float temp);
 
     /** Get the current alert temperature hysteresis threshold of the LM75B
      *
-     * @returns The current alert temperature hysteresis threshold as a float.
+     * @returns The current alert temperature hysteresis threshold in °C.
      */
     float getAlertHyst(void);
 
     /** Set the alert temperature hysteresis threshold of the LM75B
      *
-     * @param temp The new alert temperature hysteresis threshold as a float.
+     * @param temp The new alert temperature hysteresis threshold in °C.
      */
     void setAlertHyst(float temp);
 
     /** Get the current temperature measurement of the LM75B
      *
-     * @returns The current temperature measurement as a float.
+     * @returns The current temperature measurement in °C.
      */
     float getTemp(void);