diff --git a/docs/images/rpr220.JPG b/docs/images/rpr220.JPG new file mode 100755 index 00000000..ef5d9442 Binary files /dev/null and b/docs/images/rpr220.JPG differ diff --git a/src/rpr220/rpr220.h b/src/rpr220/rpr220.h index e375f6f0..5b98c212 100644 --- a/src/rpr220/rpr220.h +++ b/src/rpr220/rpr220.h @@ -28,25 +28,38 @@ namespace upm { - /** - * @brief C++ API for the RPR220 based Grove IR Reflective Sensor. - * - * UPM module for the Grove IR Reflective Sensor. The sensitivity - * can be adjusted with the potentiometer on the sensor module. It - * has a range of approximately 15mm, and a fast response time. - * - * It detects high contrast dark areas on a light background. - * - * This module allows the user to determine the current status - * (black detected or not). Additionally, if desired, an Interrupt - * Service Routine (ISR) can be installed that will be called when - * black is detected. Either method can be used, depending on your - * use case. - - * @ingroup grove gpio - * @snippet rpr220.cxx Interesting - * @snippet rpr220-intr.cxx Interesting - */ +/** + * @brief RPR220 IR Reflective Sensor library + * @defgroup rpr220 libupm-rpr220 + * @ingroup seeed gpio light + */ +/** + * @library libupm-rpr220 + * @sensor rpr220 + * @comname rpr220 IR reflective sensor + * @type light + * @man seeed + * @web http://www.seeedstudio.com/wiki/Grove_-_Infrared_Reflective_Sensor + * @con gpio + * + * @brief C++ API for the RPR220 based Grove IR Reflective Sensor + * + * UPM module for the Grove IR Reflective Sensor. The sensitivity + * can be adjusted with the potentiometer on the sensor module. It + * has a range of approximately 15mm, and a fast response time. + * + * It detects high contrast dark areas on a light background. + * + * This module allows the user to determine the current status + * (black detected or not). Additionally, if desired, an Interrupt + * Service Routine (ISR) can be installed that will be called when + * black is detected. Either method can be used, depending on your + * use case. + * + * @image html rpr220.jpeg + * @snippet rpr220.cxx Interesting + * @snippet rpr220-intr.cxx Interesting + */ class RPR220 { public: /**