From 138c5af5f8b01483e863b2afa4352feebb9f4942 Mon Sep 17 00:00:00 2001 From: sisinty sasmita patra Date: Tue, 8 Sep 2015 11:03:36 -0700 Subject: [PATCH] doxygen: Modified header files to show detail description from doxygen Signed-off-by: sisinty sasmita patra --- src/buzzer/buzzer.h | 2 +- src/hcsr04/hcsr04.h | 2 +- src/joystick12/joystick12.h | 2 +- src/ldt0028/ldt0028.h | 2 +- src/lol/lol.h | 2 +- src/lsm303/lsm303.h | 2 +- src/maxds3231m/maxds3231m.h | 2 +- src/mic/mic.h | 2 +- src/mlx90614/mlx90614.h | 2 +- src/mpu9150/mpu9150.h | 2 +- src/mpu9150/mpu9250.h | 2 +- src/my9221/my9221.h | 2 +- src/nrf24l01/nrf24l01.h | 2 +- src/servo/es08a.h | 2 +- src/sm130/sm130.h | 2 +- src/st7735/st7735.h | 2 +- src/stepmotor/stepmotor.h | 2 +- src/tcs3414cs/tcs3414cs.h | 2 +- src/th02/th02.h | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/buzzer/buzzer.h b/src/buzzer/buzzer.h index 46af0f33..c42c7599 100644 --- a/src/buzzer/buzzer.h +++ b/src/buzzer/buzzer.h @@ -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 diff --git a/src/hcsr04/hcsr04.h b/src/hcsr04/hcsr04.h index 78a24017..cf54999d 100644 --- a/src/hcsr04/hcsr04.h +++ b/src/hcsr04/hcsr04.h @@ -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 */ diff --git a/src/joystick12/joystick12.h b/src/joystick12/joystick12.h index 28e35e56..2157fa67 100644 --- a/src/joystick12/joystick12.h +++ b/src/joystick12/joystick12.h @@ -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. diff --git a/src/ldt0028/ldt0028.h b/src/ldt0028/ldt0028.h index 3ab8cc56..532d47f0 100644 --- a/src/ldt0028/ldt0028.h +++ b/src/ldt0028/ldt0028.h @@ -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 diff --git a/src/lol/lol.h b/src/lol/lol.h index 2d076c0e..c44d1cc9 100644 --- a/src/lol/lol.h +++ b/src/lol/lol.h @@ -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 diff --git a/src/lsm303/lsm303.h b/src/lsm303/lsm303.h index 8f0e69f2..58ab4cf5 100644 --- a/src/lsm303/lsm303.h +++ b/src/lsm303/lsm303.h @@ -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. diff --git a/src/maxds3231m/maxds3231m.h b/src/maxds3231m/maxds3231m.h index 62822eb7..1f15e130 100644 --- a/src/maxds3231m/maxds3231m.h +++ b/src/maxds3231m/maxds3231m.h @@ -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 */ diff --git a/src/mic/mic.h b/src/mic/mic.h index e2dfb5b0..e0a8ee2f 100644 --- a/src/mic/mic.h +++ b/src/mic/mic.h @@ -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 diff --git a/src/mlx90614/mlx90614.h b/src/mlx90614/mlx90614.h index f6b96d9e..a7249107 100644 --- a/src/mlx90614/mlx90614.h +++ b/src/mlx90614/mlx90614.h @@ -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 diff --git a/src/mpu9150/mpu9150.h b/src/mpu9150/mpu9150.h index 6f341fb0..32a69445 100644 --- a/src/mpu9150/mpu9150.h +++ b/src/mpu9150/mpu9150.h @@ -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 diff --git a/src/mpu9150/mpu9250.h b/src/mpu9150/mpu9250.h index 90ff1dfa..2b2b95c7 100644 --- a/src/mpu9150/mpu9250.h +++ b/src/mpu9150/mpu9250.h @@ -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 */ diff --git a/src/my9221/my9221.h b/src/my9221/my9221.h index 6e094bbf..d1a9cdf5 100644 --- a/src/my9221/my9221.h +++ b/src/my9221/my9221.h @@ -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 diff --git a/src/nrf24l01/nrf24l01.h b/src/nrf24l01/nrf24l01.h index 03bbfbed..d004f442 100644 --- a/src/nrf24l01/nrf24l01.h +++ b/src/nrf24l01/nrf24l01.h @@ -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 diff --git a/src/servo/es08a.h b/src/servo/es08a.h index 4ae6926e..2c28096a 100644 --- a/src/servo/es08a.h +++ b/src/servo/es08a.h @@ -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 diff --git a/src/sm130/sm130.h b/src/sm130/sm130.h index 544cae28..2002c7ff 100644 --- a/src/sm130/sm130.h +++ b/src/sm130/sm130.h @@ -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 diff --git a/src/st7735/st7735.h b/src/st7735/st7735.h index bb932a41..50f58fe7 100644 --- a/src/st7735/st7735.h +++ b/src/st7735/st7735.h @@ -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 diff --git a/src/stepmotor/stepmotor.h b/src/stepmotor/stepmotor.h index e5eee5c4..4416aaee 100644 --- a/src/stepmotor/stepmotor.h +++ b/src/stepmotor/stepmotor.h @@ -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. * diff --git a/src/tcs3414cs/tcs3414cs.h b/src/tcs3414cs/tcs3414cs.h index 652baeba..a1c4b835 100644 --- a/src/tcs3414cs/tcs3414cs.h +++ b/src/tcs3414cs/tcs3414cs.h @@ -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 diff --git a/src/th02/th02.h b/src/th02/th02.h index baed1fd0..404180a4 100644 --- a/src/th02/th02.h +++ b/src/th02/th02.h @@ -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.