From e54d48f407a7dfa5d3d63bafc1d5f677114fa387 Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Wed, 18 Mar 2015 17:55:19 -0700 Subject: [PATCH] nrf8001: documentation updates and showing relation to aci lib Signed-off-by: Mihai Tudor Panu --- doxy/Doxyfile.in | 6 ++-- examples/c++/nrf8001-helloworld.cxx | 2 +- src/nrf8001/aci.h | 7 +++-- src/nrf8001/aci_cmds.h | 2 -- src/nrf8001/aci_protocol_defines.h | 8 +++-- src/nrf8001/aci_queue.h | 8 ++--- src/nrf8001/aci_setup.h | 5 +++ src/nrf8001/acilib.h | 2 +- src/nrf8001/acilib_defs.h | 2 +- src/nrf8001/acilib_if.h | 2 +- src/nrf8001/acilib_types.h | 2 +- src/nrf8001/boards.h | 4 ++- src/nrf8001/dtm.h | 2 +- src/nrf8001/hal_aci_tl.h | 7 +++-- src/nrf8001/hal_platform.h | 10 +++--- src/nrf8001/lib_aci.h | 19 +++++++----- src/nrf8001/nrf8001.h | 47 ++++++++++++++++++----------- src/nrf8001/uart_over_ble.h | 10 +++--- 18 files changed, 88 insertions(+), 57 deletions(-) diff --git a/doxy/Doxyfile.in b/doxy/Doxyfile.in index 04ea10b1..a6263e0f 100644 --- a/doxy/Doxyfile.in +++ b/doxy/Doxyfile.in @@ -857,9 +857,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = @PROJECT_SOURCE_DIR@/src/nrf8001/aci* \ - @PROJECT_SOURCE_DIR@/src/nrf8001/lib* \ - @PROJECT_SOURCE_DIR@/src/nrf8001/hal* +EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -870,7 +868,7 @@ EXCLUDE_PATTERNS = @PROJECT_SOURCE_DIR@/src/nrf8001/aci* \ # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = aci_* # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include diff --git a/examples/c++/nrf8001-helloworld.cxx b/examples/c++/nrf8001-helloworld.cxx index a3831428..5866a0f4 100644 --- a/examples/c++/nrf8001-helloworld.cxx +++ b/examples/c++/nrf8001-helloworld.cxx @@ -33,7 +33,7 @@ /* * You can use the nRF UART app in the Apple iOS app store and Google Play for Android 4.3 for Samsung Galaxy S4 -* with this helloworld application + * with this helloworld application */ #ifdef SERVICES_PIPE_TYPE_MAPPING_CONTENT diff --git a/src/nrf8001/aci.h b/src/nrf8001/aci.h index 18810cbb..db67354b 100644 --- a/src/nrf8001/aci.h +++ b/src/nrf8001/aci.h @@ -21,10 +21,13 @@ /** * @file - * + * @ingroup aci + */ + +/** * @defgroup aci aci * @{ - * @ingroup lib + * @ingroup aci-lib * * @brief Definitions for the ACI (Application Control Interface) * @remarks diff --git a/src/nrf8001/aci_cmds.h b/src/nrf8001/aci_cmds.h index 4ce75e11..61f744b1 100644 --- a/src/nrf8001/aci_cmds.h +++ b/src/nrf8001/aci_cmds.h @@ -21,9 +21,7 @@ /** * @file - * * @ingroup aci - * * @brief Definitions for the ACI (Application Control Interface) commands * @remarks * diff --git a/src/nrf8001/aci_protocol_defines.h b/src/nrf8001/aci_protocol_defines.h index 4dc82b50..65b2aad8 100644 --- a/src/nrf8001/aci_protocol_defines.h +++ b/src/nrf8001/aci_protocol_defines.h @@ -19,8 +19,12 @@ * SOFTWARE. */ -/* - * This file contents defines for the position of all the fields of ACI +/** + * @file + * + * @ingroup aci + * + * @brief This file contents defines for the position of all the fields of ACI * command or event messages */ diff --git a/src/nrf8001/aci_queue.h b/src/nrf8001/aci_queue.h index 13ebd6a8..4d95e2aa 100644 --- a/src/nrf8001/aci_queue.h +++ b/src/nrf8001/aci_queue.h @@ -19,14 +19,14 @@ * SOFTWARE. */ -/** @file +/** + * @file * @brief Interface for buffer. + * @ingroup aci */ -/** @defgroup aci_queue aci_queue +/** @{ -@ingroup aci_queue - */ #ifndef ACI_QUEUE_H__ diff --git a/src/nrf8001/aci_setup.h b/src/nrf8001/aci_setup.h index 865d7d3f..7f9a4206 100644 --- a/src/nrf8001/aci_setup.h +++ b/src/nrf8001/aci_setup.h @@ -19,6 +19,11 @@ * SOFTWARE. */ +/** + * @file + * @brief ACI setup functions + * @ingroup aci + */ #ifndef H_ACI_SETUP #define H_ACI_SETUP diff --git a/src/nrf8001/acilib.h b/src/nrf8001/acilib.h index f152e758..d7d20c00 100644 --- a/src/nrf8001/acilib.h +++ b/src/nrf8001/acilib.h @@ -22,7 +22,7 @@ /** * @file * - * @ingroup group_acilib + * @ingroup aci-lib * * @brief Internal prototype for acilib module. */ diff --git a/src/nrf8001/acilib_defs.h b/src/nrf8001/acilib_defs.h index dc64d868..c1934152 100644 --- a/src/nrf8001/acilib_defs.h +++ b/src/nrf8001/acilib_defs.h @@ -22,7 +22,7 @@ /** * @file * - * @ingroup group_acilib + * @ingroup aci-lib * * @brief Definitions for the acilib interfaces */ diff --git a/src/nrf8001/acilib_if.h b/src/nrf8001/acilib_if.h index 1413094b..483e893b 100644 --- a/src/nrf8001/acilib_if.h +++ b/src/nrf8001/acilib_if.h @@ -22,7 +22,7 @@ /** * @file * - * @ingroup group_acilib + * @ingroup aci-lib * * @brief Prototypes for the acilib interfaces. */ diff --git a/src/nrf8001/acilib_types.h b/src/nrf8001/acilib_types.h index 9421478a..438ea3c8 100644 --- a/src/nrf8001/acilib_types.h +++ b/src/nrf8001/acilib_types.h @@ -22,7 +22,7 @@ /** * @file * - * @ingroup group_acilib + * @ingroup aci-lib * * @brief Type used in the acilib interfaces */ diff --git a/src/nrf8001/boards.h b/src/nrf8001/boards.h index 19b3758f..c84db0a4 100644 --- a/src/nrf8001/boards.h +++ b/src/nrf8001/boards.h @@ -19,8 +19,10 @@ * SOFTWARE. */ -/** @file +/** + * @file * @brief Defines for the different Bluetooth low energy boards + * @ingroup nrf8001 */ #ifndef _BLE_BOARDS_H_ diff --git a/src/nrf8001/dtm.h b/src/nrf8001/dtm.h index 7a43e39a..9ae01c5f 100644 --- a/src/nrf8001/dtm.h +++ b/src/nrf8001/dtm.h @@ -22,7 +22,7 @@ /** * @file * - * @ingroup group_acilib + * @ingroup aci-lib * * @brief Internal prototype for acilib module. */ diff --git a/src/nrf8001/hal_aci_tl.h b/src/nrf8001/hal_aci_tl.h index 68e25b37..6511faed 100644 --- a/src/nrf8001/hal_aci_tl.h +++ b/src/nrf8001/hal_aci_tl.h @@ -19,13 +19,14 @@ * SOFTWARE. */ -/** @file +/** + * @file * @brief Interface for hal_aci_tl. + * @ingroup nrf8001 */ -/** @defgroup hal_aci_tl hal_aci_tl +/** @{ -@ingroup hal @brief Module for the ACI Transport Layer interface @details This module is responsible for sending and receiving messages over the ACI interface of the nRF8001 chip. diff --git a/src/nrf8001/hal_platform.h b/src/nrf8001/hal_platform.h index 70f71192..73ac4026 100644 --- a/src/nrf8001/hal_platform.h +++ b/src/nrf8001/hal_platform.h @@ -19,13 +19,15 @@ * SOFTWARE. */ +/** + * @file + * @brief HAL specific macros + * @ingroup nrf8001 + */ + #ifndef PLATFORM_H__ #define PLATFORM_H__ -/** @file -* @brief -*/ - //Board dependent defines #if defined (__AVR__) //For Arduino this AVR specific library has to be used for reading from Flash memory diff --git a/src/nrf8001/lib_aci.h b/src/nrf8001/lib_aci.h index 39266c5f..fc85ef4c 100644 --- a/src/nrf8001/lib_aci.h +++ b/src/nrf8001/lib_aci.h @@ -19,16 +19,21 @@ * SOFTWARE. */ +/** + * @file + * @defgroup aci-lib aci-library + * @brief ACI library + * + * Library for the logical part of the Application Controller Interface (ACI) + * + * @ingroup nrf8001 + */ + #ifndef LIB_ACI_H__ #define LIB_ACI_H__ -/** @file -* @brief ACI library -*/ - -/** @addtogroup lib_aci -@{ -@brief Library for the logical part of the Application Controller Interface (ACI) +/** +* @{ */ #ifdef __cplusplus diff --git a/src/nrf8001/nrf8001.h b/src/nrf8001/nrf8001.h index 746abfd7..c8122055 100644 --- a/src/nrf8001/nrf8001.h +++ b/src/nrf8001/nrf8001.h @@ -21,6 +21,35 @@ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ + +/** + * @file + * @brief C++ API for the Nordic Semiconductor NRF8001 Bluetooth Low Energy + * @ingroup nrf8001 + */ + +/** + * @defgroup nrf8001 libupm-nrf8001 + * @ingroup wifi + * + * @sensor nrf8001 + * @comname NRF8001 Bluetooth Low Energy + * @type wifi + * @man adafruit + * @con spi + * + * @brief nrf8001 Bluetooth Low Energy library + * + * These files define the NRF8001 C++ interface for lib-nrf8001. Interaction + * with this device is done through the ACI routines included with the library. + * You can use the nRF UART app in the Apple iOS app store and Google Play for + * Android 4.3 for Samsung Galaxy S4 to interact with a microcontroller running + * the 'hello world' example. + * + * @snippet nrf8001-helloworld.cxx Interesting + * @snippet nrf8001-broadcast.cxx Interesting + */ + #pragma once #include @@ -31,23 +60,5 @@ #include #include -/** - * @brief nrf8001 Bluetooth Low Energy library - * @defgroup nrf8001 libupm-nrf8001 - */ - -/** - * @brief C++ API for the Nordic Semiconductor NRF8001 Bluetooth Low Energy - * - * This file defines the NRF8001 C++ interface for lib-nrf8001. - * Most of the interaction with this device is done using the ACI classes - * provided by Nordic Semiconductor. Please see our examples for further - * details. - * - * @ingroup nrf8001 spi - * @snippet nrf8001-helloworld.cxx Interesting - * @snippet nrf8001-broadcast.cxx Interesting - */ - void init_local_interfaces (aci_state_t* aci, uint8_t reqn, uint8_t rdyn, uint8_t rst); void close_local_interfaces (aci_state_t* aci); diff --git a/src/nrf8001/uart_over_ble.h b/src/nrf8001/uart_over_ble.h index 06a9e78c..9a72821f 100644 --- a/src/nrf8001/uart_over_ble.h +++ b/src/nrf8001/uart_over_ble.h @@ -27,6 +27,12 @@ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @file + * @brief BLE specific macros + * @ingroup nrf8001 + */ + #ifndef UART_OVER_BLE_H__ #define UART_OVER_BLE_H__ @@ -70,8 +76,4 @@ typedef struct uint8_t uart_rts_remote; /**< State of the remote UART RTS */ } uart_over_ble_t; -/** - * @} - */ - #endif // UART_OVER_BLE_H__