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:
committed by
Brendan Le Foll
parent
83a67b96fd
commit
d7490d87f2
@@ -36,7 +36,7 @@ namespace mraa
|
||||
*
|
||||
* This file defines the aio interface for libmraa
|
||||
*
|
||||
* @snippet AioA0.cpp Interesting
|
||||
* @snippet aio.cpp Interesting
|
||||
*/
|
||||
class Aio
|
||||
{
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -38,7 +38,7 @@ namespace mraa
|
||||
* selecting the correct address
|
||||
* @htmlinclude i2c.txt
|
||||
*
|
||||
* @snippet I2c-compass.cpp Interesting
|
||||
* @snippet i2c.cpp Interesting
|
||||
*/
|
||||
class I2c
|
||||
{
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -36,6 +36,7 @@ namespace mraa
|
||||
*
|
||||
* This file defines the LED interface for libmraa
|
||||
*
|
||||
* @snippet led.cpp Interesting
|
||||
*/
|
||||
class Led
|
||||
{
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user