Repository navigation
Conversation
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
Document the purpose, usage and configuration of each script in CI/update: - stm32variant.py, - stm32variantv2.py, - stm32cube.py, - stm32cubev2.py, - stm32wrapper.py, - stm32svd.py, - fqbn.py, - stm32api.py - stm32libraries.py. Correct the stm32variant.py description (GitHub database by default, --cube option, CUBEMX_DIRECTORY and STM32CUBECLT_PATH settings). Signed-off-by: Frederic Pillon <frederic.pillon@st.com> Assisted-by: GitHub Copilot: Claude Haiku 5.5
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
fpistm
added
enhancement
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.