max31855: Adding doxygen comments and removing image

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-04-14 15:36:11 -07:00
parent 3567e079f9
commit 6da2d5047d
2 changed files with 8 additions and 3 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 KiB

View File

@ -32,9 +32,16 @@ namespace upm {
/** /**
* @brief max31855 thermocouple library * @brief max31855 thermocouple library
* @defgroup max31855 libupm-max31855 * @defgroup max31855 libupm-max31855
* @ingroup maxim spi other
*/ */
/** /**
* @library libupm-max31855
* @sensor max31855
* @comname max31855 thermocouple library
* @type other
* @man maxim
* @con spi
*
* @brief C++ API for MAX31855 * @brief C++ API for MAX31855
* *
* The Maxim Integrated * The Maxim Integrated
@ -45,9 +52,7 @@ namespace upm {
* (http://datasheets.maximintegrated.com/en/ds/MAX31855PMB1.pdf) from the * (http://datasheets.maximintegrated.com/en/ds/MAX31855PMB1.pdf) from the
* analog PMOD kit. * analog PMOD kit.
* *
* @ingroup max31855 spi
* @snippet max31855.cxx Interesting * @snippet max31855.cxx Interesting
* @image html max31855.jpeg
*/ */
class MAX31855 { class MAX31855 {
public: public: