Skip to content

Commit 791c560

Browse files
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.5
1 parent a3402e3 commit 791c560

130 files changed

Lines changed: 3618 additions & 1666 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CI/update/templates/generic_clock.c‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@
1515
#include "pins_arduino.h"
1616

1717
/**
18-
* @brief System Clock Configuration
19-
* @param None
20-
* @retval None
18+
* @brief System Clock Configuration
2119
*/
2220
WEAK void SystemClock_Config(void)
2321
{

0 commit comments

Comments
 (0)