alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

max5847: Adding doxygen comments and removing image

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-04-14 15:44:30 -07:00
parent 897b0a48c6
commit 2ac8f8f6ef
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/max5487.jpeg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 4.9 KiB

13
src/max5487/max5487.h
View File

@ -36,9 +36,16 @@ namespace upm {
/** /**
* @brief max5847 digital potentiometer library * @brief max5847 digital potentiometer library
* @defgroup max5847 libupm-max5847 * @defgroup max5847 libupm-max5847
* @ingroup maxim spi digipot
*/ */
/** /**
* @library libupm-max5847
* @sensor max5847
* @comname max5847 potentiometer sensor
* @type digipot
* @man maxim
* @con spi
*
* @brief C++ API for MAX5487 chip (SPI digital potentionmeter) * @brief C++ API for MAX5487 chip (SPI digital potentionmeter)
* *
* The Maxim Integrated * The Maxim Integrated
@ -48,9 +55,7 @@ namespace upm {
* PMOD module](http://datasheets.maximintegrated.com/en/ds/MAX5487PMB1.pdf) * PMOD module](http://datasheets.maximintegrated.com/en/ds/MAX5487PMB1.pdf)
* from the analog PMOD kit. * from the analog PMOD kit.
* *
* @ingroup max5847 spi * @snippet max5847.cxx Interesting
* @snippet max5487.cxx Interesting
* @image html max5487.jpeg
*/ */
class MAX5487 { class MAX5487 {
public: public: