doc: replace @return by Return:

Sphinx expects Return: and not @return to indicate a return value.

find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Heinrich Schuchardt 2022-01-19 18:05:50 +01:00
parent 6a685753ce
commit 185f812c41
524 changed files with 2505 additions and 2505 deletions

View file

@ -366,7 +366,7 @@ static u8 stm32prog_start(struct stm32prog_data *data, u32 address)
* get_address() - Get address if it is valid
*
* @tmp_xor: Current xor value to update
* @return The address area
* Return: The address area
*/
static u32 get_address(u8 *tmp_xor)
{
@ -791,7 +791,7 @@ error:
* stm32prog_serial_loop() - USART bootloader Loop routine
*
* @data: Current command context
* @return true if reset is needed after loop
* Return: true if reset is needed after loop
*/
bool stm32prog_serial_loop(struct stm32prog_data *data)
{