Skip to content

Commit a71d004

Browse files
fpistmfpistm
committed
Clean legacy useless comments
Signed-off-by: Frederic.Pillon <[email protected]>
1 parent 65f8d48 commit a71d004

File tree

10 files changed

+13
-356
lines changed

10 files changed

+13
-356
lines changed

‎cores/arduino/stm32/analog.c

+3-63
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,6 @@
3535
*
3636
******************************************************************************
3737
*/
38-
/** @addtogroup CMSIS
39-
* @{
40-
*/
41-
42-
/** @addtogroup stm32f4xx_system
43-
* @{
44-
*/
45-
46-
/** @addtogroup STM32F4xx_System_Private_Includes
47-
* @{
48-
*/
4938
#include "stm32_def.h"
5039
#include "analog.h"
5140
#include "timer.h"
@@ -55,20 +44,7 @@
5544
extern "C" {
5645
#endif
5746

58-
/**
59-
* @}
60-
*/
61-
62-
/** @addtogroup STM32F4xx_System_Private_TypesDefinitions
63-
* @{
64-
*/
65-
/**
66-
* @}
67-
*/
68-
69-
/** @addtogroup STM32F4xx_System_Private_Defines
70-
* @{
71-
*/
47+
/* Private_Defines */
7248
#if defined(ADC_SAMPLETIME_8CYCLES_5)
7349
#define SAMPLINGTIME ADC_SAMPLETIME_8CYCLES_5;
7450
#elif defined(ADC_SAMPLETIME_12CYCLES_5)
@@ -102,30 +78,11 @@ extern "C" {
10278
#ifndef ADC_REGULAR_RANK_1
10379
#define ADC_REGULAR_RANK_1 1
10480
#endif
105-
/**
106-
* @}
107-
*/
108-
109-
/** @addtogroup STM32F4xx_System_Private_Macros
110-
* @{
111-
*/
112-
113-
/**
114-
* @}
115-
*/
11681

117-
/** @addtogroup STM32F4xx_System_Private_Variables
118-
* @{
119-
*/
82+
/* Private_Variables */
12083
static PinName g_current_pin = NC;
12184

122-
/**
123-
* @}
124-
*/
125-
126-
/** @addtogroup STM32F4xx_System_Private_FunctionPrototypes
127-
* @{
128-
*/
85+
/* Private Functions */
12986
static uint32_t get_adc_channel(PinName pin)
13087
{
13188
uint32_t function = pinmap_function(pin, PinMap_ADC);
@@ -804,23 +761,6 @@ void pwm_stop(PinName pin)
804761
HAL_TIM_PWM_DeInit(&timHandle);
805762
}
806763

807-
808-
/**
809-
* @}
810-
*/
811-
812-
813-
/**
814-
* @}
815-
*/
816-
817-
/**
818-
* @}
819-
*/
820-
821-
/**
822-
* @}
823-
*/
824764
#ifdef __cplusplus
825765
}
826766
#endif

‎cores/arduino/stm32/analog.h

-3
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,6 @@
4747
extern "C" {
4848
#endif
4949

50-
/* Exported types ------------------------------------------------------------*/
51-
/* Exported constants --------------------------------------------------------*/
52-
/* Exported macro ------------------------------------------------------------*/
5350
/* Exported functions ------------------------------------------------------- */
5451
void dac_write_value(PinName pin, uint32_t value, uint8_t do_init);
5552
void dac_stop(PinName pin);

‎cores/arduino/stm32/interrupt.cpp

+5-63
Original file line numberDiff line numberDiff line change
@@ -35,57 +35,21 @@
3535
*
3636
******************************************************************************
3737
*/
38-
/** @addtogroup CMSIS
39-
* @{
40-
*/
41-
42-
/** @addtogroup stm32f4xx_system
43-
* @{
44-
*/
45-
46-
/** @addtogroup STM32F4xx_System_Private_Includes
47-
* @{
48-
*/
4938
#include "stm32_def.h"
5039
#include "interrupt.h"
5140

52-
/**
53-
* @}
54-
*/
55-
56-
/** @addtogroup STM32F4xx_System_Private_TypesDefinitions
57-
* @{
58-
*/
41+
/* Private Types */
5942

6043
/*As we can have only one interrupt/pin id, don't need to get the port info*/
6144
typedef struct {
6245
IRQn_Type irqnb;
6346
std::function<void(void)> callback;
6447
} gpio_irq_conf_str;
6548

66-
/**
67-
* @}
68-
*/
69-
70-
/** @addtogroup STM32F4xx_System_Private_Defines
71-
* @{
72-
*/
49+
/* Private_Defines */
7350
#define NB_EXTI (16)
74-
/**
75-
* @}
76-
*/
77-
78-
/** @addtogroup STM32F4xx_System_Private_Macros
79-
* @{
80-
*/
81-
82-
/**
83-
* @}
84-
*/
8551

86-
/** @addtogroup STM32F4xx_System_Private_Variables
87-
* @{
88-
*/
52+
/* Private Variables */
8953
static gpio_irq_conf_str gpio_irq_conf[NB_EXTI] = {
9054
#if defined (STM32F0xx) || defined (STM32L0xx)
9155
{.irqnb = EXTI0_1_IRQn, .callback = NULL}, //GPIO_PIN_0
@@ -123,25 +87,14 @@ static gpio_irq_conf_str gpio_irq_conf[NB_EXTI] = {
12387
{.irqnb = EXTI15_10_IRQn, .callback = NULL} //GPIO_PIN_15
12488
#endif
12589
};
126-
/**
127-
* @}
128-
*/
12990

130-
/** @addtogroup STM32F4xx_System_Private_FunctionPrototypes
131-
* @{
132-
*/
133-
134-
static uint8_t get_pin_id(uint16_t pin);
135-
136-
/**
137-
* @}
138-
*/
91+
/* Private Functions */
13992
/**
14093
* @brief This function returns the pin ID function of the HAL PIN definition
14194
* @param pin : one of the gpio pin
14295
* @retval None
14396
*/
144-
uint8_t get_pin_id(uint16_t pin)
97+
static uint8_t get_pin_id(uint16_t pin)
14598
{
14699
uint8_t id = 0;
147100

@@ -397,15 +350,4 @@ void EXTI15_10_IRQHandler(void)
397350
}
398351
#endif
399352
#endif
400-
/**
401-
* @}
402-
*/
403-
404-
/**
405-
* @}
406-
*/
407-
408-
/**
409-
* @}
410-
*/
411353
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/

‎cores/arduino/stm32/interrupt.h

-3
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,6 @@ typedef std::function<void(void)> callback_function_t;
5454
void stm32_interrupt_enable(GPIO_TypeDef *port, uint16_t pin, callback_function_t callback, uint32_t mode);
5555
#endif
5656

57-
/* Exported types ------------------------------------------------------------*/
58-
/* Exported constants --------------------------------------------------------*/
59-
/* Exported macro ------------------------------------------------------------*/
6057
/* Exported functions ------------------------------------------------------- */
6158
void stm32_interrupt_enable(GPIO_TypeDef *port, uint16_t pin, void (*callback)(void), uint32_t mode);
6259
void stm32_interrupt_disable(GPIO_TypeDef *port, uint16_t pin);

‎cores/arduino/stm32/spi_com.c

+1-70
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,6 @@
3535
*
3636
******************************************************************************
3737
*/
38-
/** @addtogroup CMSIS
39-
* @{
40-
*/
41-
42-
/** @addtogroup stm32f4xx_system
43-
* @{
44-
*/
45-
46-
/** @addtogroup STM32F4xx_System_Private_Includes
47-
* @{
48-
*/
4938
#include "core_debug.h"
5039
#include "stm32_def.h"
5140
#include "spi_com.h"
@@ -56,53 +45,7 @@
5645
extern "C" {
5746
#endif
5847

59-
/**
60-
* @}
61-
*/
62-
63-
/** @addtogroup STM32F4xx_System_Private_Defines
64-
* @{
65-
*/
66-
67-
/**
68-
* @}
69-
*/
70-
71-
/** @addtogroup STM32F4xx_System_Private_TypesDefinitions
72-
* @{
73-
*/
74-
75-
/**
76-
* @}
77-
*/
78-
79-
/** @addtogroup STM32F4xx_System_Private_Macros
80-
* @{
81-
*/
82-
83-
/**
84-
* @}
85-
*/
86-
87-
/** @addtogroup STM32F4xx_System_Private_Variables
88-
* @{
89-
*/
90-
91-
/**
92-
* @}
93-
*/
94-
95-
/** @addtogroup STM32F4xx_System_Private_FunctionPrototypes
96-
* @{
97-
*/
98-
99-
/**
100-
* @}
101-
*/
102-
103-
/** @addtogroup STM32F4xx_System_Private_Functions
104-
* @{
105-
*/
48+
/* Private Functions */
10649
/**
10750
* @brief return clock freq of an SPI instance
10851
* @param spi_inst : SPI instance
@@ -460,18 +403,6 @@ spi_status_e spi_transfer(spi_t *obj, uint8_t *tx_buffer,
460403
return ret;
461404
}
462405

463-
464-
/**
465-
* @}
466-
*/
467-
468-
/**
469-
* @}
470-
*/
471-
472-
/**
473-
* @}
474-
*/
475406
#ifdef __cplusplus
476407
}
477408
#endif

‎cores/arduino/stm32/spi_com.h

-3
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,6 @@ typedef enum {
9494
SPI_ERROR = 2
9595
} spi_status_e;
9696

97-
/* Exported constants --------------------------------------------------------*/
98-
99-
/* Exported macro ------------------------------------------------------------*/
10097
/* Exported functions ------------------------------------------------------- */
10198
void spi_init(spi_t *obj, uint32_t speed, spi_mode_e mode, uint8_t msb);
10299
void spi_deinit(spi_t *obj);

0 commit comments

Comments
 (0)