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

@@ -62,7 +62,7 @@ extern char * strchr(const char *,int);
* NULL
* @s: string to search
* @c: character to search for
* @return position of @c in @s, or end of @s if not found
* Return: position of @c in @s, or end of @s if not found
*/
const char *strchrnul(const char *s, int c);
@@ -89,7 +89,7 @@ extern __kernel_size_t strnlen(const char *,__kernel_size_t);
*
* @s: string to search
* @reject: strings which cause the search to halt
* @return number of characters at the start of @s which are not in @reject
* Return: number of characters at the start of @s which are not in @reject
*/
size_t strcspn(const char *s, const char *reject);
#endif
@@ -136,7 +136,7 @@ void *memchr_inv(const void *, int, size_t);
*
* @src: data to copy in
* @len: number of bytes to copy
* @return allocated buffer with the copied contents, or NULL if not enough
* Return: allocated buffer with the copied contents, or NULL if not enough
* memory is available
*
*/