diff options
author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 20:05:50 +0300 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 20:11:34 +0300 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /include/u-boot | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) | |
download | u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.xz |
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>
Diffstat (limited to 'include/u-boot')
-rw-r--r-- | include/u-boot/crc.h | 10 | ||||
-rw-r--r-- | include/u-boot/ecdsa.h | 2 | ||||
-rw-r--r-- | include/u-boot/fdt-libcrypto.h | 2 | ||||
-rw-r--r-- | include/u-boot/hash-checksum.h | 2 | ||||
-rw-r--r-- | include/u-boot/lz4.h | 2 | ||||
-rw-r--r-- | include/u-boot/rsa.h | 4 |
6 files changed, 11 insertions, 11 deletions
diff --git a/include/u-boot/crc.h b/include/u-boot/crc.h index bfd477f31d..52ec6a9e2d 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 @@ void crc16_ccitt_wd_buf(const uint8_t *in, uint len, * 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 @@ uint32_t crc32(uint32_t crc, const unsigned char *buf, uint len); * @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 @@ uint32_t crc32_wd(uint32_t crc, const unsigned char *buf, uint len, * 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 @@ void crc32c_init(uint32_t *crc32c_table, uint32_t pol); * @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 f6951c7346..0ceb0c1a08 100644 --- a/include/u-boot/ecdsa.h +++ b/include/u-boot/ecdsa.h @@ -57,7 +57,7 @@ int ecdsa_add_verify_data(struct image_sign_info *info, void *keydest); * @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 5142f37039..b15d8a1eaf 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 7f16b37a9a..bcc6ba48fc 100644 --- a/include/u-boot/hash-checksum.h +++ b/include/u-boot/hash-checksum.h @@ -21,7 +21,7 @@ struct image_region; * @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 1276fb98a3..e18b39a5dc 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 7556aa5b4b..2ed2ac7e53 100644 --- a/include/u-boot/rsa.h +++ b/include/u-boot/rsa.h @@ -75,7 +75,7 @@ int rsa_add_verify_data(struct image_sign_info *info, void *keydest); * @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 @@ int rsa_verify_hash(struct image_sign_info *info, * @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, |