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>
diff --git a/include/u-boot/crc.h b/include/u-boot/crc.h
index bfd477f..52ec6a9 100644
--- a/include/u-boot/crc.h
+++ b/include/u-boot/crc.h
@@ -21,7 +21,7 @@
* @crc_start: CRC8 start value
* @vptr: Buffer to checksum
* @len: Length of buffer in bytes
- * @return CRC8 checksum
+ * Return: CRC8 checksum
*/
unsigned int crc8(unsigned int crc_start, const unsigned char *vptr, int len);
@@ -48,7 +48,7 @@
* calculation)
* @buf: Bytes to checksum
* @len: Number of bytes to checksum
- * @return checksum value
+ * Return: checksum value
*/
uint32_t crc32(uint32_t crc, const unsigned char *buf, uint len);
@@ -63,7 +63,7 @@
* @buf: Bytes to checksum
* @len: Number of bytes to checksum
* @chunk_sz: Chunk size to use between watchdog resets
- * @return checksum
+ * Return: checksum
*/
uint32_t crc32_wd(uint32_t crc, const unsigned char *buf, uint len,
uint chunk_sz);
@@ -78,7 +78,7 @@
* calculation)
* @buf: Bytes to checksum
* @len: Number of bytes to checksum
- * @return checksum value
+ * Return: checksum value
*/
uint32_t crc32_no_comp(uint32_t crc, const unsigned char *buf, uint len);
@@ -115,7 +115,7 @@
* @data: Data bytes to checksum
* @length: Number of bytes to process
* @crc32c_table:: CRC table
- * @return checksum value
+ * Return: checksum value
*/
uint32_t crc32c_cal(uint32_t crc, const char *data, int length,
uint32_t *crc32c_table);
diff --git a/include/u-boot/ecdsa.h b/include/u-boot/ecdsa.h
index f6951c7..0ceb0c1 100644
--- a/include/u-boot/ecdsa.h
+++ b/include/u-boot/ecdsa.h
@@ -57,7 +57,7 @@
* @data_len: Data length
* @sig: Signature
* @sig_len: Number of bytes in signature
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
int ecdsa_verify(struct image_sign_info *info,
const struct image_region region[], int region_count,
diff --git a/include/u-boot/fdt-libcrypto.h b/include/u-boot/fdt-libcrypto.h
index 5142f37..b15d8a1 100644
--- a/include/u-boot/fdt-libcrypto.h
+++ b/include/u-boot/fdt-libcrypto.h
@@ -19,7 +19,7 @@
* @prop_name: What to call the property in the FDT
* @num: pointer to a libcrypto big number
* @num_bits: How big is 'num' in bits?
- * @return 0 if all good all working, -ve on horror
+ * Return: 0 if all good all working, -ve on horror
*/
int fdt_add_bignum(void *blob, int noffset, const char *prop_name,
BIGNUM *num, int num_bits);
diff --git a/include/u-boot/hash-checksum.h b/include/u-boot/hash-checksum.h
index 7f16b37..bcc6ba4 100644
--- a/include/u-boot/hash-checksum.h
+++ b/include/u-boot/hash-checksum.h
@@ -21,7 +21,7 @@
* @region_count: Number of regions in the region array
* @checksum: Buffer contanining the output hash
*
- * @return 0 if OK, < 0 if error
+ * Return: 0 if OK, < 0 if error
*/
int hash_calculate(const char *name,
const struct image_region *region, int region_count,
diff --git a/include/u-boot/lz4.h b/include/u-boot/lz4.h
index 1276fb9..e18b39a 100644
--- a/include/u-boot/lz4.h
+++ b/include/u-boot/lz4.h
@@ -13,7 +13,7 @@
* @srcn: Length of source data
* @dst: Destination for uncompressed data
* @dstn: Returns length of uncompressed data
- * @return 0 if OK, -EPROTONOSUPPORT if the magic number or version number are
+ * Return: 0 if OK, -EPROTONOSUPPORT if the magic number or version number are
* not recognised or independent blocks are used, -EINVAL if the reserved
* fields are non-zero, or input is overrun, -EENOBUFS if the destination
* buffer is overrun, -EEPROTO if the compressed data causes an error in
diff --git a/include/u-boot/rsa.h b/include/u-boot/rsa.h
index 7556aa5..2ed2ac7 100644
--- a/include/u-boot/rsa.h
+++ b/include/u-boot/rsa.h
@@ -75,7 +75,7 @@
* @hash: Hash according to algorithm specified in @info
* @sig: Signature
* @sig_len: Number of bytes in signature
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
int rsa_verify_hash(struct image_sign_info *info,
const uint8_t *hash, uint8_t *sig, uint sig_len);
@@ -90,7 +90,7 @@
* @data_len: Data length
* @sig: Signature
* @sig_len: Number of bytes in signature
- * @return 0 if verified, -ve on error
+ * Return: 0 if verified, -ve on error
*/
int rsa_verify(struct image_sign_info *info,
const struct image_region region[], int region_count,