doxygen: Modified header files to show detail description from doxygen

Signed-off-by: sisinty sasmita patra <sisinty.s.patra@intel.com>
This commit is contained in:
sisinty sasmita patra 2015-09-08 11:03:36 -07:00 committed by Mihai Tudor Panu
parent 6793c892ed
commit 138c5af5f8
19 changed files with 19 additions and 19 deletions

View File

@ -53,7 +53,7 @@ namespace upm {
*
* @brief API for the Buzzer component
*
* This file defines the Buzzer interface for libbuzzer.
* This module defines the Buzzer interface for libbuzzer.
* This sensor can make different tones when connected to
* a pin capable of analog pulse-width modulation. It emits
* sound using a piezoelectric material that vibrates at different

View File

@ -56,7 +56,7 @@ namespace upm {
*
* @brief API for the HC-SR04 Ultrasonic Sensor
*
* This file defines the HC-SR04 interface for libhcsr04
* This module defines the HC-SR04 interface for libhcsr04
*
* @snippet hcsr04.cxx Interesting
*/

View File

@ -46,7 +46,7 @@ namespace upm {
*
* @brief API for the ElecFreaks* Joystick v 1.2-1.4 Breakout
*
* This file defines the Joystick API, and implementation for the X and Y
* This module defines the Joystick API, and implementation for the X and Y
* buttons could be treated as normal GPIO - this enables easier
* interrupt support. This driver should be compatible with any
* 2-axis analog joystick.

View File

@ -46,7 +46,7 @@ namespace upm {
* @brief API for LDT0-028 PZT film-based sensors,
* such as a Grove Piezo Vibration sensor
*
* This file defines the LDT0-028 interface for libupm-ldt0028
* This module defines the LDT0-028 interface for libupm-ldt0028
*
* @image html ldt0028.jpg
* @snippet ldt0028.cxx Interesting

View File

@ -49,7 +49,7 @@ namespace upm {
*
* @brief API for the Olimex LoL array
*
* This file defines the LoL API and implementation for a simple framebuffer.
* This module defines the LoL API and implementation for a simple framebuffer.
*
* @image html lolshield.jpg
* @snippet lol-example.cxx Interesting

View File

@ -78,7 +78,7 @@ namespace upm {
*
* @brief API for the LSM303 Accelerometer & Compass
*
* This file defines the LSM303DLH 3-axis magnetometer/3-axis accelerometer.
* This module defines the LSM303DLH 3-axis magnetometer/3-axis accelerometer.
* This module was tested with the Seeed Studio* Grove 6-Axis Accelerometer & Compass
* module used over I2C. The magnometer and acceleromter are accessed
* at two seperate I2C addresses.

View File

@ -77,7 +77,7 @@ struct Time3231 {
*
* @brief API for the MAXDS3231M I2C Real-Time Clock
*
* This file defines the API for MAXDS3231M
* This module defines the API for MAXDS3231M
*
* @snippet maxds3231m.cxx Interesting
*/

View File

@ -53,7 +53,7 @@ namespace upm {
*
* @brief API for the Analog Microphone
*
* This file defines the Analog Microphone sensor
* This module defines the Analog Microphone sensor
*
* @image html mic.jpg
* @snippet mic.cxx Interesting

View File

@ -67,7 +67,7 @@ namespace upm {
*
* @brief API for the MLX90614 Temperature Sensor
*
* This file defines the MLX90614 interface for libmlx90614
* This module defines the MLX90614 interface for libmlx90614
*
* @image html mlx90614.jpg
* @snippet mlx90614.cxx Interesting

View File

@ -51,7 +51,7 @@ namespace upm {
*
* @brief API for MPU9150 chip (Accelerometer, Gyro and Magnometer Sensor)
*
* This file defines the MPU9150 interface for libmpu9150
* This module defines the MPU9150 interface for libmpu9150
*
* @image html mpu9150.jpg
* @snippet mpu9150.cxx Interesting

View File

@ -44,7 +44,7 @@ namespace upm {
*
* @brief API for MPU9250 chip (Accelerometer, Gyro and Magnometer Sensor)
*
* This file defines the MPU9250 interface for libmpu9150
* This module defines the MPU9250 interface for libmpu9150
*
* @snippet mpu9250.cxx Interesting
*/

View File

@ -55,7 +55,7 @@ namespace upm {
*
* @brief API for MY9221-based LED Bars
*
* This file defines the MY9221 interface for libmy9221
* This module defines the MY9221 interface for libmy9221
*
* @image html my9221.jpg
* @snippet my9221-ledbar.cxx Interesting

View File

@ -166,7 +166,7 @@ typedef enum {
*
* @brief API for the NRF24L01 Transceiver Module
*
* This file defines the NRF24L01 interface for libnrf24l01
* This module defines the NRF24L01 interface for libnrf24l01
*
* @image html nrf24l01.jpg
* @snippet nrf24l01-receiver.cxx Interesting

View File

@ -41,7 +41,7 @@ namespace upm {
*
* @brief API for the ES08A Servo
*
* This file defines the ES08A interface for ES08A servos.
* This module defines the ES08A interface for ES08A servos.
* Like other servos, the ES08A servo has a shaft that can be controlled
* by setting the desired angle. There are also routines for setting
* and getting the minimum and maximum pulse width as well as the

View File

@ -60,7 +60,7 @@ namespace upm {
*
* @brief API for the SM130 RFID Reader Module
*
* This file defines the SM130 interface for the sm130 RFID library
* This module defines the SM130 interface for the sm130 RFID library
*
* This module was developed using an SM130 and a Sparkfun RFID
* Evaluation shield using a UART for communications. It should be

View File

@ -509,7 +509,7 @@ const unsigned char font[] = {
*
* @brief API for the ST7735 LCD
*
* This file defines the interface for the ST7735 display library
* This module defines the interface for the ST7735 display library
*
* @image html st7735.jpg
* @snippet st7735.cxx Interesting

View File

@ -57,7 +57,7 @@ namespace upm {
*
* @brief API for the Stepper Motor
*
* This file defines the Stepper Motor interface. It is compatible with stepper
* This module defines the Stepper Motor interface. It is compatible with stepper
* motor drivers that use 2 pins to control the motor, like an Easy Driver
* from Brian Schmalz.
*

View File

@ -121,7 +121,7 @@ typedef struct {
*
* @brief API for the TCS3414CS Color Sensor
*
* This file defines the TCS3414CS interface for the color sensor
* This module defines the TCS3414CS interface for the color sensor
*
* @image html tcs3414cs.jpg
* @snippet tcs3414cs.cxx Interesting

View File

@ -61,7 +61,7 @@ namespace upm {
*
* @brief API for the TH02 Temperature & Humidity Sensor
*
* This file defines the TH02 interface for libth02
* This module defines the TH02 interface for libth02
*
* Note: For use on Intel(R) Edison with an Arduino* breakout board, Intel
* Edison must be set to 3 V rather than 5 V.