Repository navigation
Commit 791c560
committed
docs: homogenize doxygen comments across core, libraries and variants
Review doxygen comments in headers and sources under cores/, libraries/,
system/STM32* and variants/ (excluding cores/arduino/api, system/Drivers
and system/Middlewares) and apply one style:
- API contracts (@brief, @PARAM, @return, @note) live in headers. Functions
declared in a header are documented there and their duplicate blocks are
removed from the source file.
- Static and source-only functions are documented directly above their
definition in the .c/.cpp file.
- Parameter names in header declarations now match their definitions in
HardwareTimer.h, analog.h, Wire.h, and VirtIO mbox_ipcc.h. This is a
name-only change with no ABI impact.
- @RetVal None on void functions is replaced by @return or dropped. Remaining
@RetVal tags are kept only in ST-derived HAL/LL, system and middleware files.
- Undocumented functions are documented, including HardwareTimer methods,
Wire and twi helpers, SPI, EEPROM, Servo, USBDevice, Serial Uart, WSerial
serialEvent hooks, pins_arduino, variant clock helpers, and assert_failed in
the hal_conf_default headers.
Function-level 'not documented' doxygen warnings drop from 197 to 2. In
USBDevice, the #ifdef blocks in usbd_cdc.h and usbd_hid_composite.h are
reordered with equivalent declarations. Comment-stripped code is otherwise
unchanged.
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
Assisted-by: GitHub Copilot: Claude Haiku 5.51 parent a3402e3 commit 791c560
130 files changed
Lines changed: 3618 additions & 1666 deletions
File tree
- CI/update/templates
- cores/arduino
- avr
- libraries
- EEPROM/src
- utility
- IWatchdog/src
- RGB_LED_TLC59731/src
- SPI/src
- utility
- Servo/src
- stm32
- SoftwareSerial/src
- SrcWrapper
- inc
- src
- stm32
- SubGhz/src
- USBDevice
- inc
- src
- cdc
- hid
- VirtIO
- inc
- src
- Wire/src
- utility
- system
- STM32C0xx
- STM32F0xx
- STM32F1xx
- STM32F2xx
- STM32F3xx
- STM32F4xx
- STM32F7xx
- STM32G0xx
- STM32G4xx
- STM32H5xx
- STM32H7xx
- STM32L0xx
- STM32L1xx
- STM32L4xx
- STM32L5xx
- STM32MP1xx
- STM32U0xx
- STM32U3xx
- STM32U5xx
- STM32WB0x
- STM32WBAxx
- STM32WBxx
- STM32WL3x
- STM32WLxx
- variants/STM32H7xx/H742V(G-I)(H-T)_H743V(G-I)(H-T)_H750VBT_H753VI(H-T)
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
19 | | - | |
20 | | - | |
| 18 | + | |
21 | 19 | | |
22 | 20 | | |
23 | 21 | | |
| |||
0 commit comments