From 85dd8d704b76c91924f392184e5e614e11e21e37 Mon Sep 17 00:00:00 2001 From: Kyle Kearney Date: Mon, 26 Aug 2019 14:05:58 -0700 Subject: [PATCH] Clean up unnecessary doxygen comments Fix incorrect file names in a few headers --- .../TARGET_CY8CKIT_062S2_43012/cybsp.h | 31 ----------------- .../TARGET_CY8CKIT_062_BLE/cybsp.c | 3 +- .../TARGET_CY8CKIT_062_BLE/cybsp.h | 29 ---------------- .../TARGET_CY8CKIT_062_WIFI_BT/cybsp.h | 6 ---- .../TARGET_CY8CPROTO_062_4343W/cybsp.h | 34 ------------------- .../TARGET_CYW943012P6EVB_01/cybsp.h | 32 ----------------- .../TARGET_PSOC6/common/cy_network_buffer.c | 2 +- .../TARGET_PSOC6/common/cy_network_buffer.h | 11 +++--- .../TARGET_PSOC6/common/cybsp_core.h | 10 +++--- .../TARGET_PSOC6/common/cybsp_wifi.c | 2 +- 10 files changed, 13 insertions(+), 147 deletions(-) diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062S2_43012/cybsp.h b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062S2_43012/cybsp.h index 09e992a74b..776bfe39bc 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062S2_43012/cybsp.h +++ b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062S2_43012/cybsp.h @@ -23,35 +23,6 @@ * limitations under the License. *******************************************************************************/ -/** -* \addtogroup group_bsp_cy8ckit_062s2_43012 CY8CKIT-062S2-43012 -* \ingroup group_bsp -* \{ -* The CY8CKIT-062S2-43012 PSoC 6 Wi-Fi BT Pioneer Kit is a low-cost hardware platform that enables design and debug of PSoC 6 MCUs. -* It comes with a Murata LBEE5KL1DX module, based on the CYW43012 combo device, industry-leading CapSense for touch buttons and slider, on-board debugger/programmer with KitProg3, microSD card interface, 512-Mb Quad-SPI NOR flash, PDM-PCM microphone, and a thermistor. This kit is designed with a snap-away form-factor, allowing the user to separate the different components and features that come with this kit and use independently. -* In addition, support for Digilent's Pmod interface is also provided with this kit. -* -*
Kit Features:
-* -* -*
Kit Contents:
-* -* -* \defgroup group_bsp_cy8ckit_062s2_43012_macros Macros -* \defgroup group_bsp_cy8ckit_062s2_43012_functions Functions -* \defgroup group_bsp_cy8ckit_062s2_43012_enums Enumerated Types -*/ - - #pragma once #include "cybsp_types.h" @@ -73,5 +44,3 @@ extern "C" { #if defined(__cplusplus) } #endif - -/** \} group_bsp_cy8ckit_062s2_43012 */ diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_BLE/cybsp.c b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_BLE/cybsp.c index 9d1e579ed4..a8d64758c8 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_BLE/cybsp.c +++ b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_BLE/cybsp.c @@ -2,8 +2,7 @@ * \file CY8CKIT-062-BLE/cybsp.c * * Description: -* Provides APIs for interacting with the hardware contained on the Cypress -* CY8CKIT-062-BLE pioneer kit. +* Provides basic hardware initialization for the CY8CKIT-062-BLE pioneer kit. * ******************************************************************************** * \copyright diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_BLE/cybsp.h b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_BLE/cybsp.h index 326ec3ffb4..33d9e0352e 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_BLE/cybsp.h +++ b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_BLE/cybsp.h @@ -23,33 +23,6 @@ * limitations under the License. *******************************************************************************/ -/** -* \addtogroup group_bsp_cy8ckit_062_ble CY8CKIT-062-BLE -* \ingroup group_bsp -* \{ -* The PSoC 6 BLE Pioneer Kit is a low-cost hardware platform -* that enables design and debug of the PSoC 63 MCU (CY8C6347BZI-BLD53). -* -*
Kit Features:
-* -* -*
Kit Contents:
-* -* -* \defgroup group_bsp_cy8ckit_062_ble_macros Macros -* \defgroup group_bsp_cy8ckit_062_ble_functions Functions -* \defgroup group_bsp_cy8ckit_062_ble_enums Enumerated Types -*/ - #pragma once #include "cybsp_types.h" @@ -67,5 +40,3 @@ extern "C" { #if defined(__cplusplus) } #endif - -/** \} group_bsp_cy8ckit_062_ble */ diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_WIFI_BT/cybsp.h b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_WIFI_BT/cybsp.h index cc73fc97e7..1d404085a1 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_WIFI_BT/cybsp.h +++ b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CKIT_062_WIFI_BT/cybsp.h @@ -40,8 +40,6 @@ extern "C" { #endif -/** \cond INTERNAL */ - // HAL HW configuration data extern cyhal_qspi_t cybsp_qspi; extern cyhal_uart_t cybsp_bt_uart; @@ -49,10 +47,6 @@ extern cyhal_uart_t cybsp_debug_uart; extern cyhal_i2c_t cybsp_i2c; extern cyhal_rtc_t cybsp_rtc; -/** \endcond */ - #if defined(__cplusplus) } #endif - -/** \} group_bsp_cy8ckit_062_wifi_bt */ diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CMOD_062_4343W/TARGET_CY8CPROTO_062_4343W/cybsp.h b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CMOD_062_4343W/TARGET_CY8CPROTO_062_4343W/cybsp.h index 2484d7d111..2cb1397f9a 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CMOD_062_4343W/TARGET_CY8CPROTO_062_4343W/cybsp.h +++ b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CY8CMOD_062_4343W/TARGET_CY8CPROTO_062_4343W/cybsp.h @@ -23,34 +23,6 @@ * limitations under the License. *******************************************************************************/ -/** -* \addtogroup group_bsp_cy8cproto_062_4343w CY8CPROTO-062-4343W -* \ingroup group_bsp -* \{ -* The CY8CPROTO-062-4343W PSoC 6 Wi-Fi BT Prototyping Kit is a low-cost hardware platform that enables design and debug of PSoC 6 MCUs. -* It comes with a Murata LBEE5KL1DX module, based on the CYW4343W combo device, industry-leading CapSense for touch buttons and slider, on-board debugger/programmer with KitProg3, microSD card interface, 512-Mb Quad-SPI NOR flash, PDM-PCM microphone, and a thermistor. This kit is designed with a snap-away form-factor, allowing the user to separate the different components and features that come with this kit and use independently. -* In addition, support for Digilent's Pmod interface is also provided with this kit. -* -*
Kit Features:
-* -* -*
Kit Contents:
-* -* -* \defgroup group_bsp_cy8cproto_062_4343w_macros Macros -* \defgroup group_bsp_cy8cproto_062_4343w_functions Functions -* \defgroup group_bsp_cy8cproto_062_4343w_enums Enumerated Types -*/ - #pragma once #include "cybsp_types.h" @@ -67,12 +39,6 @@ extern "C" { #endif -/** \cond INTERNAL */ - -/** \endcond */ - #if defined(__cplusplus) } #endif - -/** \} group_bsp_cy8cproto_062_4343w */ diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CYW943012P6EVB_01/cybsp.h b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CYW943012P6EVB_01/cybsp.h index 3d135b0c71..7f1228bd8f 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CYW943012P6EVB_01/cybsp.h +++ b/targets/TARGET_Cypress/TARGET_PSOC6/TARGET_CYW943012P6EVB_01/cybsp.h @@ -23,33 +23,6 @@ * limitations under the License. *******************************************************************************/ -/** -* \addtogroup group_bsp_cyw943012p6evb_01 CYW943012P6EVB-01 -* \ingroup group_bsp -* \{ -* The PSoC 6 CYW943012P6EVB-01 board is a low-cost hardware platform that -* enables design and debug of the PSoC 62 MCU (CY8C6247BZI-D54) and the -* Murata LBEE59B1LV Module (CYW43012 WiFi + Bluetooth Combo Chip). -* -*
Kit Features:
-* -* -*
Kit Contents:
-* -* -* \defgroup group_bsp_cyw943012p6evb_01_macros Macros -* \defgroup group_bsp_cyw943012p6evb_01_functions Functions -* \defgroup group_bsp_cyw943012p6evb_01_enums Enumerated Types -*/ - #pragma once #include "cybsp_types.h" @@ -66,11 +39,6 @@ extern "C" { #endif -/** \cond INTERNAL */ -/** \endcond */ - #if defined(__cplusplus) } #endif - -/** \} group_bsp_cyw943012p6evb_01 */ diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/common/cy_network_buffer.c b/targets/TARGET_Cypress/TARGET_PSOC6/common/cy_network_buffer.c index a0a672d7f2..01d2cb06da 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/common/cy_network_buffer.c +++ b/targets/TARGET_Cypress/TARGET_PSOC6/common/cy_network_buffer.c @@ -1,5 +1,5 @@ /***************************************************************************//** -* \file cy_network_buffer.h +* \file cy_network_buffer.c * * \brief * Basic set of APIs for dealing with network packet buffers. This is used by WHD diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/common/cy_network_buffer.h b/targets/TARGET_Cypress/TARGET_PSOC6/common/cy_network_buffer.h index b313756e49..17dc536de2 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/common/cy_network_buffer.h +++ b/targets/TARGET_Cypress/TARGET_PSOC6/common/cy_network_buffer.h @@ -24,12 +24,11 @@ *******************************************************************************/ /** -* \addtogroup group_abstraction_buffer Buffer management abstraction -* \ingroup group_abstraction +* \addtogroup group_bsp_network_buffer Buffer management * \{ * Basic set of APIs for dealing with network packet buffers * -* \defgroup group_abstraction_buffer_functions Functions +* \defgroup group_bsp_network_buffer_functions Functions */ #pragma once @@ -48,7 +47,7 @@ extern "C" { /** -* \addtogroup group_abstraction_buffer_functions +* \addtogroup group_bsp_network_buffer_functions * \{ */ @@ -171,7 +170,7 @@ whd_result_t cy_buffer_add_remove_at_front(whd_buffer_t *buffer, int32_t add_rem */ void cy_network_process_ethernet_data(whd_interface_t interface, whd_buffer_t buffer); -/** \} group_abstraction_buffer_functions */ +/** \} group_bsp_network_buffer_functions */ #ifdef __cplusplus } @@ -179,4 +178,4 @@ void cy_network_process_ethernet_data(whd_interface_t interface, whd_buffer_t bu #endif /* defined(TARGET_WHD) */ -/** \} group_abstraction_buffer */ +/** \} group_bsp_network_buffer */ diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/common/cybsp_core.h b/targets/TARGET_Cypress/TARGET_PSOC6/common/cybsp_core.h index 76e7b0ce01..2b644341ce 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/common/cybsp_core.h +++ b/targets/TARGET_Cypress/TARGET_PSOC6/common/cybsp_core.h @@ -47,17 +47,17 @@ extern "C" { #endif /** -* \addtogroup group_abstraction_board_macros +* \addtogroup group_bsp_core_macros * \{ */ /** Failed to configure sysclk power management callback */ #define CYBSP_RSLT_ERR_SYSCLK_PM_CALLBACK (CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_ABSTRACTION_BSP, 0)) -/** \} group_abstraction_board_macros */ +/** \} group_bsp_core_macros */ /** -* \addtogroup group_abstraction_board_functions +* \addtogroup group_bsp_core_functions * \{ */ @@ -140,10 +140,10 @@ void cybsp_btn_set_interrupt(cybsp_btn_t which, cyhal_gpio_event_t type, cyhal_g */ cy_rslt_t cybsp_register_sysclk_pm_callback(void); -/** \} group_abstraction_board_functions */ +/** \} group_bsp_core_functions */ #ifdef __cplusplus } #endif /* __cplusplus */ -/** \} group_abstraction_board */ +/** \} group_bsp_core */ diff --git a/targets/TARGET_Cypress/TARGET_PSOC6/common/cybsp_wifi.c b/targets/TARGET_Cypress/TARGET_PSOC6/common/cybsp_wifi.c index f24382e0fb..8f8694c22e 100644 --- a/targets/TARGET_Cypress/TARGET_PSOC6/common/cybsp_wifi.c +++ b/targets/TARGET_Cypress/TARGET_PSOC6/common/cybsp_wifi.c @@ -1,5 +1,5 @@ /***************************************************************************//** -* \file cybsp_utils.c +* \file cybsp_wifi.c * * \brief * Provides utility functions that are used by board support packages.