nrf8001: Adding doxygen comments and image from Adafruit website

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-04-14 13:56:54 -07:00
parent 1ffbcd59ad
commit 6abf66ddbc
2 changed files with 9 additions and 11 deletions

BIN
docs/images/nrf8001.jpg Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 206 KiB

View File

@ -23,20 +23,18 @@
*/ */
/** /**
* @file * @brief nrf8001 Bluetooth Low Energy library
* @brief C++ API for the Nordic Semiconductor NRF8001 Bluetooth Low Energy
* @ingroup nrf8001
*/
/**
* @defgroup nrf8001 libupm-nrf8001 * @defgroup nrf8001 libupm-nrf8001
* @ingroup wifi * @ingroup adafruit wifi aio gpio spi
* */
/**
* @library libupm-nrf8001
* @sensor nrf8001 * @sensor nrf8001
* @comname NRF8001 Bluetooth Low Energy * @comname Bluetooth Low Energy
* @type wifi * @type wifi
* @man adafruit * @man adafruit
* @con spi * @web https://learn.adafruit.com/getting-started-with-the-nrf8001-bluefruit-le-breakout/introduction
* @con spi gpio aio
* *
* @brief nrf8001 Bluetooth Low Energy library * @brief nrf8001 Bluetooth Low Energy library
* *
@ -46,10 +44,10 @@
* Android 4.3 for Samsung Galaxy S4 to interact with a microcontroller running * Android 4.3 for Samsung Galaxy S4 to interact with a microcontroller running
* the 'hello world' example. * the 'hello world' example.
* *
* @image html nrf8001.jpg
* @snippet nrf8001-helloworld.cxx Interesting * @snippet nrf8001-helloworld.cxx Interesting
* @snippet nrf8001-broadcast.cxx Interesting * @snippet nrf8001-broadcast.cxx Interesting
*/ */
#pragma once #pragma once
#include <string> #include <string>