From 025ce478be5af77c0f266ff34e4ff3320dbe586f Mon Sep 17 00:00:00 2001 From: John Van Drasek Date: Thu, 22 Jan 2015 11:29:31 -0800 Subject: [PATCH] nrf8001: Doxygen documentation warning fixes Signed-off-by: John Van Drasek Signed-off-by: Mihai Tudor Panu --- src/nrf8001/boards.h | 8 ++++---- src/nrf8001/dtm.h | 20 ++++++++++---------- src/nrf8001/uart_over_ble.h | 8 ++++++-- 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/src/nrf8001/boards.h b/src/nrf8001/boards.h index d49ef6e0..21173db1 100644 --- a/src/nrf8001/boards.h +++ b/src/nrf8001/boards.h @@ -26,9 +26,9 @@ #ifndef _BLE_BOARDS_H_ #define _BLE_BOARDS_H_ -#define BOARD_DEFAULT 0 //Use this if you do not know the board you are using or you are creating a new one -#define REDBEARLAB_SHIELD_V1_1 1 //Redbearlab Bluetooth low energy shield v1.1 -#define REDBEARLAB_SHIELD_V2012_07 1 //Identical to Redbearlab v1.1 shield -#define REDBEARLAB_SHIELD_V2 0 //Redbearlab Bluetooth low energy shield v2.x - No special handling required for pin reset same as default +#define BOARD_DEFAULT 0 //!< Use this if you do not know the board you are using or you are creating a new one +#define REDBEARLAB_SHIELD_V1_1 1 //!< Redbearlab Bluetooth low energy shield v1.1 +#define REDBEARLAB_SHIELD_V2012_07 1 //!< Identical to Redbearlab v1.1 shield +#define REDBEARLAB_SHIELD_V2 0 //!< Redbearlab Bluetooth low energy shield v2.x - No special handling required for pin reset same as default #endif diff --git a/src/nrf8001/dtm.h b/src/nrf8001/dtm.h index ef5ab649..7a43e39a 100644 --- a/src/nrf8001/dtm.h +++ b/src/nrf8001/dtm.h @@ -32,10 +32,10 @@ /** @brief DTM command codes (upper two bits in the DTM command), use a bitwise OR with the frequency N = 0x00 - 0x27: N = (F-2402)/2 Frequency Range 2402 MHz to 2480 MHz*/ -#define DTM_LE_CMD_RESET 0x00 -#define DTM_LE_CMD_RECEIVER_TEST 0x40 -#define DTM_LE_CMD_TRANSMITTER_TEST 0x80 -#define DTM_LE_CMD_TEST_END 0xC0 +#define DTM_LE_CMD_RESET 0x00 /**< DTM reset command code */ +#define DTM_LE_CMD_RECEIVER_TEST 0x40 /**< DTM receiver test command code */ +#define DTM_LE_CMD_TRANSMITTER_TEST 0x80 /**< DTM transmitter test command code */ +#define DTM_LE_CMD_TEST_END 0xC0 /**< DTM test end command code */ /** @brief Defined packet types for DTM */ @@ -45,16 +45,16 @@ to 2480 MHz*/ #define DTM_LE_PKT_VENDOR 0x03 /**< Vendor specific. Nordic: continous carrier test */ /** @brief Defined bit fields for DTM responses. */ -#define LE_PACKET_REPORTING_EVENT_MSB_BIT 0x80 -#define LE_TEST_STATUS_EVENT_LSB_BIT 0x01 +#define LE_PACKET_REPORTING_EVENT_MSB_BIT 0x80 /**< Bit field for most significant bit */ +#define LE_TEST_STATUS_EVENT_LSB_BIT 0x01 /**< Bit field for least significant bit */ /** @brief DTM response types. */ -#define LE_TEST_STATUS_EVENT 0x00 -#define LE_TEST_PACKET_REPORT_EVENT 0x80 +#define LE_TEST_STATUS_EVENT 0x00 /**< DTM event response */ +#define LE_TEST_PACKET_REPORT_EVENT 0x80 /**< DTM packet report reponse */ /** @brief DTM return values. */ -#define LE_TEST_STATUS_SUCCESS 0x00 -#define LE_TEST_STATUS_FAILURE 0x01 +#define LE_TEST_STATUS_SUCCESS 0x00 /**< DTM success return value */ +#define LE_TEST_STATUS_FAILURE 0x01 /**< DTM failure return value */ diff --git a/src/nrf8001/uart_over_ble.h b/src/nrf8001/uart_over_ble.h index b941c6e1..06a9e78c 100644 --- a/src/nrf8001/uart_over_ble.h +++ b/src/nrf8001/uart_over_ble.h @@ -60,10 +60,14 @@ */ #define UART_OVER_BLE_TRANSMIT_OK (0x04) +/** + * @struct uart_over_ble_t + * @brief State of the UART RTS over Bluetooth Low Energy(BLE) + */ typedef struct { - uint8_t uart_rts_local; /* State of the local UART RTS */ - uint8_t uart_rts_remote; /* State of the remote UART RTS */ + uint8_t uart_rts_local; /**< State of the local UART RTS */ + uint8_t uart_rts_remote; /**< State of the remote UART RTS */ } uart_over_ble_t; /**