diff --git a/docs/images/gprs.jpg b/docs/images/gprs.jpg new file mode 100644 index 00000000..59165745 Binary files /dev/null and b/docs/images/gprs.jpg differ diff --git a/docs/images/grovegprs.jpg b/docs/images/grovegprs.jpg new file mode 100644 index 00000000..59165745 Binary files /dev/null and b/docs/images/grovegprs.jpg differ diff --git a/docs/images/groveo2.jpg b/docs/images/groveo2.jpg new file mode 100644 index 00000000..806e40d3 Binary files /dev/null and b/docs/images/groveo2.jpg differ diff --git a/docs/images/grovespeaker.jpg b/docs/images/grovespeaker.jpg new file mode 100644 index 00000000..f4e901d4 Binary files /dev/null and b/docs/images/grovespeaker.jpg differ diff --git a/docs/images/slide.jpeg b/docs/images/slide.jpg similarity index 100% rename from docs/images/slide.jpeg rename to docs/images/slide.jpg diff --git a/src/collision/collision.hpp b/src/collision/collision.hpp index 18c6099e..dd288b39 100644 --- a/src/collision/collision.hpp +++ b/src/collision/collision.hpp @@ -47,7 +47,7 @@ namespace upm { * collision movement or vibration happens. * It outputs a low pulse signal when vibration is detected. * - * @image html grovecollision.jpg + * @image html collision.jpg * @snippet collision.cxx Interesting */ class Collision { diff --git a/src/emg/emg.hpp b/src/emg/emg.hpp index 9a9121e3..d65424a0 100644 --- a/src/emg/emg.hpp +++ b/src/emg/emg.hpp @@ -36,7 +36,8 @@ namespace upm { /** * @library emg * @sensor emg - * @comname Grove EMG Sensor + * @comname EMG Sensor + * @altname Grove EMG Sensor * @type electric * @man seeed * @con analog @@ -46,7 +47,7 @@ namespace upm { * Grove EMG muscle signal reader gathers small muscle signals, * then processes them, and returns the result * - * @image html emg.jpg + * @image html emg.jpg * @snippet emg.cxx Interesting */ class EMG { diff --git a/src/gprs/gprs.hpp b/src/gprs/gprs.hpp index 22028db0..ff05d035 100644 --- a/src/gprs/gprs.hpp +++ b/src/gprs/gprs.hpp @@ -40,7 +40,7 @@ namespace upm { /** - * @brief GPRS Module library + * @brief GPRS Module library * @defgroup gprs libupm-gprs * @ingroup seeed uart wifi */ @@ -48,13 +48,14 @@ namespace upm { /** * @library gprs * @sensor gprs - * @comname GPRS Module + * @comname GPRS Module + * @altname Grove GPRS Module * @type wifi * @man seeed * @con uart * @web http://www.seeedstudio.com/wiki/GPRS_Shield_V2.0 * - * @brief API for the GPRS Module + * @brief API for the GPRS Module * * The driver was tested with the GPRS Module, V2. It's a * GSM GPRS module based on the SIM900. This module uses a diff --git a/src/groveo2/groveo2.hpp b/src/groveo2/groveo2.hpp index 16081d23..6ba48d23 100644 --- a/src/groveo2/groveo2.hpp +++ b/src/groveo2/groveo2.hpp @@ -45,7 +45,7 @@ namespace upm { * * The Grove O2 Oxygen Gas sensor measures the oxygen concentration in the air * - * @image html groveo2.jpg + * @image html groveo2.jpg * @snippet groveo2.cxx Interesting */ class GroveO2 { diff --git a/src/led/led.hpp b/src/led/led.hpp index 8a728302..64e21420 100644 --- a/src/led/led.hpp +++ b/src/led/led.hpp @@ -31,6 +31,11 @@ #include "led.hpp" namespace upm { +/** + * @brief Led Sensor library + * @defgroup led libupm-led + * @ingroup seeed gpio led gsk + */ /** * @library led diff --git a/src/linefinder/linefinder.hpp b/src/linefinder/linefinder.hpp index e807c0f9..0bc36367 100644 --- a/src/linefinder/linefinder.hpp +++ b/src/linefinder/linefinder.hpp @@ -28,23 +28,24 @@ namespace upm { /** - * @brief Line Finder Sensor library + * @brief Line Finder Sensor library * @defgroup linefinder libupm-linefinder - * @ingroup seeed gpio color robok + * @ingroup seeed dfrobot gpio color robok */ /** * @library linefinder * @sensor linefinder - * @comname Line Finder + * @comname Line Finder + * @altname Grove Line Finder, DFRobot Line Tracking sensor * @type color - * @man seeed + * @man seeed, dfrobot * @con gpio * @kit robok * * @brief API for the Line Finder Sensor * - * UPM module for the Line Finder sensor. It outputs a + * UPM module for the Line Finder sensor. It outputs a * digital signal indicating whether it is detecting black on a * white background, or white on a black background. * diff --git a/src/md/md.hpp b/src/md/md.hpp index 190c2278..f5599b60 100644 --- a/src/md/md.hpp +++ b/src/md/md.hpp @@ -43,6 +43,7 @@ namespace upm { * @library md * @sensor md * @comname I2C Motor Driver + * @altname Grove Motor Driver * @type motor * @man seeed * @con i2c diff --git a/src/moisture/moisture.hpp b/src/moisture/moisture.hpp index 8728db2c..4e424378 100644 --- a/src/moisture/moisture.hpp +++ b/src/moisture/moisture.hpp @@ -52,7 +52,7 @@ namespace upm { * Note: this sensor is not designed to be left in soil * nor to be used outdoors. * - * @image html grovemoisture.jpg + * @image html moisture.jpg * @snippet moisture.cxx Interesting */ class Moisture { diff --git a/src/o2/o2.hpp b/src/o2/o2.hpp index a62341b1..7a045b55 100644 --- a/src/o2/o2.hpp +++ b/src/o2/o2.hpp @@ -36,7 +36,8 @@ namespace upm { /** * @library o2 * @sensor o2 - * @comname Grove O2 Sensor + * @comname O2 Sensor + * @altname Grove O2 Sensor * @type gaseous * @man seeed * @con analog @@ -45,7 +46,7 @@ namespace upm { * * The Grove O2 Oxygen Gas sensor measures the oxygen concentration in the air * - * @image html o2.jpg + * @image html o2.jpg * @snippet o2.cxx Interesting */ class O2 { diff --git a/src/relay/relay.hpp b/src/relay/relay.hpp index dc7e36a4..305806b3 100644 --- a/src/relay/relay.hpp +++ b/src/relay/relay.hpp @@ -30,28 +30,34 @@ #include namespace upm { + /** + * @brief relay sensor library + * @defgroup relay libupm-relay + * @ingroup seeed gpio relay gsk eak hak + */ -/** - * @library relay - * @defgroup relay libupm-relay - * @sensor relay - * @comname Grove Relay - * @type relay - * @man seeed - * @con gpio - * @kit gsk eak hak - * - * @brief API for the Relay - * - * UPM module for the relay switch. The relay is a - * digital normally-open switch that uses low voltage or current to - * control a higher voltage and/or higher current. When closed, - * the indicator LED lights up and current is allowed to flow. - * - * @image html relay.jpg - * @snippet relay.cxx Interesting - */ -class Relay{ + /** + * @library relay + * @sensor relay + * @comname Relay + * @altname Grove Relay + * @type relay + * @man seeed + * @con gpio + * @kit gsk eak hak + * + * @brief API for the Relay + * + * UPM module for the relay switch. The relay is a + * digital normally-open switch that uses low voltage or current to + * control a higher voltage and/or higher current. When closed, + * the indicator LED lights up and current is allowed to flow. + * + * @image html relay.jpg + * @snippet relay.cxx Interesting + */ + + class Relay{ public: /** * relay constructor @@ -92,5 +98,5 @@ class Relay{ std::string name(){ return "Relay Switch";} private: mraa_gpio_context m_gpio; -}; + }; } diff --git a/src/scam/scam.hpp b/src/scam/scam.hpp index 929c0145..cd80c9ca 100644 --- a/src/scam/scam.hpp +++ b/src/scam/scam.hpp @@ -55,8 +55,9 @@ namespace upm { /** * @library scam - * @sensor scam - * @comname Serial Camera + * @sensor scam + * @comname Serial Camera + * @altname Grove Serial Camera * @type other * @man seeed * @con uart @@ -70,7 +71,7 @@ namespace upm { * sketch. * * It is connected via a UART at 115,200 baud. - * + * * @image html scam.jpg * @snippet scam.cxx Interesting */ diff --git a/src/slide/slide.hpp b/src/slide/slide.hpp index 6c659464..24320bdf 100644 --- a/src/slide/slide.hpp +++ b/src/slide/slide.hpp @@ -30,23 +30,29 @@ #include namespace upm { + /** + * @brief Slide Sensor library + * @defgroup slide libupm-slide + * @ingroup seeed analog ainput + */ -/** - * @library slide - * @sensor slide - * @comname Slide Potentiometer - * @type ainput - * @man seeed - * @con analog - * - * @brief API for the Slide Potentiometer - * - * Basic UPM module for the slide potentiometer on analog that - * returns either a raw value or a scaled voltage value. - * - * @image html slide.jpeg - * @snippet slide.cxx Interesting - */ + /** + * @library slide + * @sensor slide + * @comname Slide Potentiometer + * @altname Grove Slide + * @type ainput + * @man seeed + * @con analog + * + * @brief API for the Slide Potentiometer + * + * Basic UPM module for the slide potentiometer on analog that + * returns either a raw value or a scaled voltage value. + * + * @image html slide.jpg + * @snippet slide.cxx Interesting + */ class Slide { public: /** diff --git a/src/speaker/speaker.hpp b/src/speaker/speaker.hpp index b897d667..b00cfe3c 100644 --- a/src/speaker/speaker.hpp +++ b/src/speaker/speaker.hpp @@ -32,11 +32,7 @@ #define LOW 0 namespace upm { - /** - * @brief Speaker library - * @defgroup speaker libupm-speaker - * @ingroup seeed gpio sound hak - */ + typedef struct { int delayTimeLow; @@ -46,10 +42,18 @@ typedef struct int delayTimeHigh; int delayTimeHighSharp; } NoteData; + + /** + * @brief Speaker library + * @defgroup speaker libupm-speaker + * @ingroup seeed gpio sound hak + */ + /** * @library speaker * @sensor speaker libupm-speaker * @comname Speaker + * @altname Grove Speaker * @type sound * @man seeed * @con gpio @@ -60,8 +64,8 @@ typedef struct * UPM module for the Speaker. * This sensor can generate different tones and sounds depending on the * frequency of the input signal. - * - * @image html speaker.jpg + * + * @image html speaker.jpg * @snippet speaker.cxx Interesting */ class Speaker { diff --git a/src/vdiv/vdiv.hpp b/src/vdiv/vdiv.hpp index 416744a3..9fc41748 100644 --- a/src/vdiv/vdiv.hpp +++ b/src/vdiv/vdiv.hpp @@ -45,6 +45,7 @@ namespace upm { * @library vdiv * @sensor vdiv * @comname Voltage Divider + * @altname Grove Voltage Divider * @type electric * @man seeed * @con analog diff --git a/src/wfs/wfs.hpp b/src/wfs/wfs.hpp index 2cd20795..6d6c7f34 100644 --- a/src/wfs/wfs.hpp +++ b/src/wfs/wfs.hpp @@ -39,7 +39,8 @@ namespace upm { /** * @library wfs * @sensor wfs - * @comname Grove Water Flow Sensor + * @comname Water Flow Sensor + * @altname Grove Water Flow Sensor * @type liquid * @man seeed * @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor