From 185f812c419f1b4f0d10d9787d59cf9f11a2a600 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 19 Jan 2022 18:05:50 +0100 Subject: 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 --- include/hw_sha.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'include/hw_sha.h') diff --git a/include/hw_sha.h b/include/hw_sha.h index d4f3471c43..b9bb583810 100644 --- a/include/hw_sha.h +++ b/include/hw_sha.h @@ -65,7 +65,7 @@ void hw_sha1(const uchar *in_addr, uint buflen, uchar *out_addr, * * @algo: Pointer to the hash_algo struct * @ctxp: Pointer to the pointer of the context for hashing - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_init(struct hash_algo *algo, void **ctxp); @@ -79,7 +79,7 @@ int hw_sha_init(struct hash_algo *algo, void **ctxp); * @buf: Pointer to the buffer being hashed * @size: Size of the buffer being hashed * @is_last: 1 if this is the last update; 0 otherwise - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_update(struct hash_algo *algo, void *ctx, const void *buf, unsigned int size, int is_last); @@ -93,7 +93,7 @@ int hw_sha_update(struct hash_algo *algo, void *ctx, const void *buf, * @ctx: Pointer to the context for hashing * @dest_buf: Pointer to the destination buffer where hash is to be copied * @size: Size of the buffer being hashed - * @return 0 if ok, -ve on error + * Return: 0 if ok, -ve on error */ int hw_sha_finish(struct hash_algo *algo, void *ctx, void *dest_buf, int size); -- cgit v1.2.3