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>
eclipse · Jan 25, 2018 · d7490d8 · d7490d8
1 parent 83a67b9
commit d7490d8
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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
@@ -67,7 +67,7 @@ class IioHandler
  *
  * 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
 {