Revision 4:5e5d818d98fa, committed 2014-04-01

Comitter:

screamer

Date:

Tue Apr 01 13:54:59 2014 +0000

Parent:

3:694792b93731

Commit message:

Improved documentation

Changed in this revision

--- a/TMP102.cpp	Thu Mar 07 10:44:42 2013 +0000
+++ b/TMP102.cpp	Tue Apr 01 13:54:59 2014 +0000
@@ -1,4 +1,3 @@
-
 /*
 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
  
@@ -43,7 +42,7 @@
   m_i2c.write(m_addr, &tempRegAddr, 1); //Pointer to the temperature register
  
   char reg[2] = {0,0};
-  m_i2c.read(m_addr, reg, 2); //Rea
+  m_i2c.read(m_addr, reg, 2); //Read
   
   int16_t res  = ((int8_t)reg[0] << 4) | ((uint8_t)reg[1] >> 4);  
   

--- a/TMP102.h	Thu Mar 07 10:44:42 2013 +0000
+++ b/TMP102.h	Tue Apr 01 13:54:59 2014 +0000
@@ -1,4 +1,3 @@
-
 /*
 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
  
@@ -26,30 +25,32 @@
 
 #include "mbed.h"
 
-//!Library for the TI TMP102 temperature sensor.
-/*!
-The TMP102 is an I2C digital temperature sensor in a small SOT563 package, with a 0.0625C resolution and 0.5C accuracy.
-*/
+/**
+ * Library for the TI TMP102 temperature sensor.
+ * The TMP102 is an I2C digital temperature sensor in a small SOT563 package, with a 0.0625C resolution and 0.5C accuracy.
+ */
 class TMP102
 {
 public:
-  //!Creates an instance of the class.
-  /*!
-  Connect module at I2C address addr using I2C port pins sda and scl.
-  TMP102
-  \param addr <table><tr><th>A0 pin connection</th><th>Address</th></tr><tr><td>GND</td><td>0x90</td></tr><tr><td>V+</td><td>0x92</td></tr><tr><td>SDA</td><td>0x94</td></tr><tr><td>SCL</td><td>0x96</td></tr></table>  
-  */
+  /**
+   * \brief Creates an instance of the class.
+   *
+   * Connect module at I2C address addr using I2C port pins sda and scl.
+   * TMP102
+   * \param addr <table><tr><th>A0 pin connection</th><th>Address</th></tr><tr><td>GND</td><td>0x90</td></tr><tr><td>V+</td><td>0x92</td></tr><tr><td>SDA</td><td>0x94</td></tr><tr><td>SCL</td><td>0x96</td></tr></table>  
+   */
   TMP102(PinName sda, PinName scl, int addr);
   
-  /*!
-  Destroys instance.
-  */ 
+  /**
+   * Destroys instance.
+   */ 
   ~TMP102();
   
-  //!Reads the current temperature.
-  /*!
-  Reads the temperature register of the TMP102 and converts it to a useable value.
-  */
+  /**
+   * \brief Reads the current temperature.
+   *
+   * Reads the temperature register of the TMP102 and converts it to a useable value.
+   */
   float read();
   
 private: