Private
Public Access
2
0

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 <manivannan.sadhasivam@linaro.org>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Manivannan Sadhasivam
2018-01-24 15:13:27 +05:30
committed by Brendan Le Foll
parent 83a67b96fd
commit d7490d87f2
9 changed files with 9 additions and 8 deletions

View File

@@ -36,7 +36,7 @@ namespace mraa
* *
* This file defines the aio interface for libmraa * This file defines the aio interface for libmraa
* *
* @snippet AioA0.cpp Interesting * @snippet aio.cpp Interesting
*/ */
class Aio class Aio
{ {

View File

@@ -90,7 +90,7 @@ typedef enum {
* *
* This file defines the gpio interface for libmraa * This file defines the gpio interface for libmraa
* *
* @snippet Blink-IO.cpp Interesting * @snippet gpio.cpp Interesting
*/ */
class Gpio class Gpio
{ {

View File

@@ -38,7 +38,7 @@ namespace mraa
* selecting the correct address * selecting the correct address
* @htmlinclude i2c.txt * @htmlinclude i2c.txt
* *
* @snippet I2c-compass.cpp Interesting * @snippet i2c.cpp Interesting
*/ */
class I2c class I2c
{ {

View File

@@ -67,7 +67,7 @@ public:
* *
* This file defines the C++ iio interface for libmraa * This file defines the C++ iio interface for libmraa
* *
* @snippet Iio-dummy.cpp Interesting * @snippet iio.cpp Interesting
*/ */
class Iio class Iio
{ {

View File

@@ -36,6 +36,7 @@ namespace mraa
* *
* This file defines the LED interface for libmraa * This file defines the LED interface for libmraa
* *
* @snippet led.cpp Interesting
*/ */
class Led class Led
{ {

View File

@@ -36,7 +36,7 @@ namespace mraa
* *
* This file defines the PWM interface for libmraa * This file defines the PWM interface for libmraa
* *
* @snippet Pwm3-cycle.cpp Interesting * @snippet pwm.cpp Interesting
*/ */
class Pwm class Pwm
{ {

View File

@@ -51,7 +51,7 @@ typedef enum {
* *
* This file defines the SPI interface for libmraa * This file defines the SPI interface for libmraa
* *
* @snippet Spi-pot.cpp Interesting * @snippet spi.cpp Interesting
*/ */
class Spi class Spi
{ {

View File

@@ -40,7 +40,7 @@ namespace mraa
* *
* This file defines the UART interface for libmraa * This file defines the UART interface for libmraa
* *
* @snippet Uart-example.cpp Interesting * @snippet uart.cpp Interesting
*/ */
class Uart class Uart
{ {

View File

@@ -37,7 +37,7 @@ namespace mraa
* *
* This file defines the UartOW (UART to Dallas 1-wire) interface for libmraa * This file defines the UartOW (UART to Dallas 1-wire) interface for libmraa
* *
* @snippet UartOW.cpp Interesting * @snippet uart_ow.cpp Interesting
*/ */
class UartOW class UartOW
{ {