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:
@@ -49,7 +49,7 @@ int sb_log_tx_handler(struct udevice *dev, void *packet, unsigned int len);
|
||||
* syslog_test_setup() - Enable syslog logging ready for tests
|
||||
*
|
||||
* @uts: Test state
|
||||
* @return 0 if OK, -ENOENT if the syslog log driver is not found
|
||||
* Return: 0 if OK, -ENOENT if the syslog log driver is not found
|
||||
*/
|
||||
int syslog_test_setup(struct unit_test_state *uts);
|
||||
|
||||
@@ -57,7 +57,7 @@ int syslog_test_setup(struct unit_test_state *uts);
|
||||
* syslog_test_finish() - Disable syslog logging after tests
|
||||
*
|
||||
* @uts: Test state
|
||||
* @return 0 if OK, -ENOENT if the syslog log driver is not found
|
||||
* Return: 0 if OK, -ENOENT if the syslog log driver is not found
|
||||
*/
|
||||
int syslog_test_finish(struct unit_test_state *uts);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user