maxds3231m: adding doxygen comments

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-04-14 15:23:24 -07:00
parent 68fcd45873
commit a327872241

View File

@ -65,12 +65,20 @@ struct Time3231 {
/** /**
* @brief maxds3231m proximity sensor library * @brief maxds3231m proximity sensor library
* @defgroup maxds3231m libupm-maxds3231m * @defgroup maxds3231m libupm-maxds3231m
* @ingroup generic i2c light
*/ */
/** /**
* @library libupm-maxds3231m
* @sensor maxds3231m
* @comname maxds3231m proximity sensor
* @type light
* @man generic
* @con i2c
*
* @brief C++ API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor) * @brief C++ API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor)
* *
* @ingroup maxds3231m i2c * This file defines the maxds3231m C++ interface for maxds3231m
*
* @snippet maxds3231m.cxx Interesting * @snippet maxds3231m.cxx Interesting
*/ */
class MAXDS3231M { class MAXDS3231M {