STMicroelectronics / stm32l4xx-hal-driver

Provides the STM32Cube MCU Component "hal_driver" of the STM32L4 series.
BSD 3-Clause "New" or "Revised" License
39 stars 15 forks source link

[HAL][GPIO] Fix documentation errors. #11

Closed schilkp closed 10 months ago

schilkp commented 1 year ago

Hi!

This fixes some trivial typos in GPIO function doxygen comments. Most notably some comments specified that:

 This parameter can be any combination of GPIO_Pin_x where x can be (0..15).

While the actual macros are:

#define GPIO_PIN_0                 ((uint16_t)0x0001)  /* Pin 0 selected    */
#define GPIO_PIN_1                 ((uint16_t)0x0002)  /* Pin 1 selected    */
...

This caused some confusion for students in a course I help run.

Please note that this exact typo is found in many places across most other HAL driver repos. Some examples:

....

Thanks!

TOUNSTM commented 11 months ago

ST Internal Reference: 168718