From d7490d87f290fa229f0c68270d67df040afdaf48 Mon Sep 17 00:00:00 2001 From: Manivannan Sadhasivam Date: Wed, 24 Jan 2018 15:13:27 +0530 Subject: [PATCH] api: mraa: Add cleaned-up C++ examples to doxygen doc Add the cleaned-up C++ examples to doxygen doc by modifying the @snippet tag. Signed-off-by: Manivannan Sadhasivam Signed-off-by: Brendan Le Foll --- api/mraa/aio.hpp | 2 +- api/mraa/gpio.hpp | 2 +- api/mraa/i2c.hpp | 2 +- api/mraa/iio.hpp | 2 +- api/mraa/led.hpp | 1 + api/mraa/pwm.hpp | 2 +- api/mraa/spi.hpp | 2 +- api/mraa/uart.hpp | 2 +- api/mraa/uart_ow.hpp | 2 +- 9 files changed, 9 insertions(+), 8 deletions(-) diff --git a/api/mraa/aio.hpp b/api/mraa/aio.hpp index e6ea2a1..75c45bf 100644 --- a/api/mraa/aio.hpp +++ b/api/mraa/aio.hpp @@ -36,7 +36,7 @@ namespace mraa * * This file defines the aio interface for libmraa * - * @snippet AioA0.cpp Interesting + * @snippet aio.cpp Interesting */ class Aio { diff --git a/api/mraa/gpio.hpp b/api/mraa/gpio.hpp index 395f862..6529455 100644 --- a/api/mraa/gpio.hpp +++ b/api/mraa/gpio.hpp @@ -90,7 +90,7 @@ typedef enum { * * This file defines the gpio interface for libmraa * - * @snippet Blink-IO.cpp Interesting + * @snippet gpio.cpp Interesting */ class Gpio { diff --git a/api/mraa/i2c.hpp b/api/mraa/i2c.hpp index 92defb4..e0ea945 100644 --- a/api/mraa/i2c.hpp +++ b/api/mraa/i2c.hpp @@ -38,7 +38,7 @@ namespace mraa * selecting the correct address * @htmlinclude i2c.txt * - * @snippet I2c-compass.cpp Interesting + * @snippet i2c.cpp Interesting */ class I2c { diff --git a/api/mraa/iio.hpp b/api/mraa/iio.hpp index 7e88d7a..4987cfe 100644 --- a/api/mraa/iio.hpp +++ b/api/mraa/iio.hpp @@ -67,7 +67,7 @@ public: * * This file defines the C++ iio interface for libmraa * - * @snippet Iio-dummy.cpp Interesting + * @snippet iio.cpp Interesting */ class Iio { diff --git a/api/mraa/led.hpp b/api/mraa/led.hpp index ca66e63..542e032 100644 --- a/api/mraa/led.hpp +++ b/api/mraa/led.hpp @@ -36,6 +36,7 @@ namespace mraa * * This file defines the LED interface for libmraa * + * @snippet led.cpp Interesting */ class Led { diff --git a/api/mraa/pwm.hpp b/api/mraa/pwm.hpp index 8ef915b..494541b 100644 --- a/api/mraa/pwm.hpp +++ b/api/mraa/pwm.hpp @@ -36,7 +36,7 @@ namespace mraa * * This file defines the PWM interface for libmraa * - * @snippet Pwm3-cycle.cpp Interesting + * @snippet pwm.cpp Interesting */ class Pwm { diff --git a/api/mraa/spi.hpp b/api/mraa/spi.hpp index b7df1dd..855d389 100644 --- a/api/mraa/spi.hpp +++ b/api/mraa/spi.hpp @@ -51,7 +51,7 @@ typedef enum { * * This file defines the SPI interface for libmraa * -* @snippet Spi-pot.cpp Interesting +* @snippet spi.cpp Interesting */ class Spi { diff --git a/api/mraa/uart.hpp b/api/mraa/uart.hpp index 6b9c6ed..c7b217e 100644 --- a/api/mraa/uart.hpp +++ b/api/mraa/uart.hpp @@ -40,7 +40,7 @@ namespace mraa * * This file defines the UART interface for libmraa * - * @snippet Uart-example.cpp Interesting + * @snippet uart.cpp Interesting */ class Uart { diff --git a/api/mraa/uart_ow.hpp b/api/mraa/uart_ow.hpp index 972310f..05607e3 100644 --- a/api/mraa/uart_ow.hpp +++ b/api/mraa/uart_ow.hpp @@ -37,7 +37,7 @@ namespace mraa * * This file defines the UartOW (UART to Dallas 1-wire) interface for libmraa * - * @snippet UartOW.cpp Interesting + * @snippet uart_ow.cpp Interesting */ class UartOW {