RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

drivers/periph_spi: fix Doxygen commands

Browse Source 
use @retval to document individual return values rather than @return
This commit is contained in:
Marian Buschsieweke 2021-03-17 10:34:20 +01:00
parent 6f011c8220
commit 40859b61f0
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
drivers/include/periph/spi.h
View File

@ -350,10 +350,10 @@ int spi_init_with_gpio_mode(spi_t bus, spi_gpio_mode_t mode);
* @param[in] clk bus clock speed to use for the transaction
*
* @retval 0 success
* @return -EINVAL Invalid mode in @p mode
* @return -EINVAL Invalid clock in @p clock
* @return -ENOTSUP Unsupported but valid mode in @p mode
* @return -ENOTSUP Unsupported but valid clock in @p clock
* @retval -EINVAL Invalid mode in @p mode
* @retval -EINVAL Invalid clock in @p clock
* @retval -ENOTSUP Unsupported but valid mode in @p mode
* @retval -ENOTSUP Unsupported but valid clock in @p clock
*/
int spi_acquire(spi_t bus, spi_cs_t cs, spi_mode_t mode, spi_clk_t clk);