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>

9 files changed, 19 insertions, 19 deletions

diff --git a/board/Marvell/octeontx/board-fdt.c b/board/Marvell/octeontx/board-fdt.c
index e989c37..6642b16 100644
--- a/board/Marvell/octeontx/board-fdt.c
+++ b/board/Marvell/octeontx/board-fdt.c
@@ -299,7 +299,7 @@ int ft_board_setup(void *blob, struct bd_info *bd)
 /**
  * Return the FDT base address that was passed by ATF
  *
- * @return	FDT base address received from ATF in x1 register
+ * Return:	FDT base address received from ATF in x1 register
  */
 void *board_fdt_blob_setup(int *err)
 {
diff --git a/board/Marvell/octeontx2/board-fdt.c b/board/Marvell/octeontx2/board-fdt.c
index e2cfe01..04be9fb 100644
--- a/board/Marvell/octeontx2/board-fdt.c
+++ b/board/Marvell/octeontx2/board-fdt.c
@@ -213,7 +213,7 @@ int ft_board_setup(void *blob, struct bd_info *bd)
 /**
  * Return the FDT base address that was passed by ATF
  *
- * @return	FDT base address received from ATF in x1 register
+ * Return:	FDT base address received from ATF in x1 register
  */
 void *board_fdt_blob_setup(int *err)
 {
diff --git a/board/emulation/qemu-ppce500/qemu-ppce500.c b/board/emulation/qemu-ppce500/qemu-ppce500.c
index 7d8ba34..348fcf3 100644
--- a/board/emulation/qemu-ppce500/qemu-ppce500.c
+++ b/board/emulation/qemu-ppce500/qemu-ppce500.c
@@ -331,7 +331,7 @@ u32 cpu_mask(void)
 /**
  * Return the virtual address of FDT that was passed by QEMU
  *
- * @return virtual address of FDT received from QEMU in r3 register
+ * Return: virtual address of FDT received from QEMU in r3 register
  */
 void *board_fdt_blob_setup(int *err)
 {
diff --git a/board/gdsys/a38x/hre.c b/board/gdsys/a38x/hre.c
index de5411a..2f16a4d 100644
--- a/board/gdsys/a38x/hre.c
+++ b/board/gdsys/a38x/hre.c
@@ -98,7 +98,7 @@ static const uint8_t vendor[] = "Guntermann & Drunck";
  * @param tpm		TPM device
  * @param index	NV index of the area to get size for
  * @param size	pointer to the size
- * @return 0 on success, != 0 on error
+ * Return: 0 on success, != 0 on error
  */
 static int get_tpm_nv_size(struct udevice *tpm, uint32_t index, uint32_t *size)
 {
@@ -135,7 +135,7 @@ static int get_tpm_nv_size(struct udevice *tpm, uint32_t index, uint32_t *size)
  * @param auth	usage auth of the key to search for
  * @param pubkey_digest	(SHA1) hash of the pub key structure of the key
  * @param[out] handle	the handle of the key iff found
- * @return 0 if key was found in TPM; != 0 if not.
+ * Return: 0 if key was found in TPM; != 0 if not.
  */
 static int find_key(struct udevice *tpm, const uint8_t auth[20],
 		    const uint8_t pubkey_digest[20], uint32_t *handle)
@@ -180,7 +180,7 @@ static int find_key(struct udevice *tpm, const uint8_t auth[20],
 /**
  * @brief read CCDM common data from TPM NV
  * @param tpm		TPM device
- * @return 0 if CCDM common data was found and read, !=0 if something failed.
+ * Return: 0 if CCDM common data was found and read, !=0 if something failed.
  */
 static int read_common_data(struct udevice *tpm)
 {
@@ -216,7 +216,7 @@ static int read_common_data(struct udevice *tpm)
 /**
  * @brief get pointer to  hash register by specification
  * @param spec	specification of a hash register
- * @return pointer to hash register or NULL if @a spec does not qualify a
+ * Return: pointer to hash register or NULL if @a spec does not qualify a
  * valid hash register; NULL else.
  */
 static struct h_reg *get_hreg(uint8_t spec)
@@ -245,7 +245,7 @@ static struct h_reg *get_hreg(uint8_t spec)
  * @param tpm		TPM device
  * @param spec	specification of a hash register
  * @param mode	access mode (read or write or read/write)
- * @return pointer to hash register if found and valid; NULL else.
+ * Return: pointer to hash register if found and valid; NULL else.
  *
  * This func uses @a get_reg() to determine the hash register for a given spec.
  * If a register is found it is validated according to the desired access mode.
@@ -372,7 +372,7 @@ static int hre_op_loadkey(struct udevice *tpm, struct h_reg *src_reg,
  * @param tpm		TPM device
  * @param[in,out] ip	pointer to the opcode (instruction pointer)
  * @param[in,out] code_size	(remaining) size of the code
- * @return new instruction pointer on success, NULL on error.
+ * Return: new instruction pointer on success, NULL on error.
  */
 static const uint8_t *hre_execute_op(struct udevice *tpm, const uint8_t **ip,
 				     size_t *code_size)
@@ -497,7 +497,7 @@ end:
  * @param tpm		TPM device
  * @param code		pointer to the (HRE) code.
  * @param code_size	size of the code (in bytes).
- * @return 0 on success, != 0 on failure.
+ * Return: 0 on success, != 0 on failure.
  */
 int hre_run_program(struct udevice *tpm, const uint8_t *code, size_t code_size)
 {
diff --git a/board/google/chromebook_coral/coral.c b/board/google/chromebook_coral/coral.c
index 53c5171..182cf75 100644
--- a/board/google/chromebook_coral/coral.c
+++ b/board/google/chromebook_coral/coral.c
@@ -98,7 +98,7 @@ static int get_memconfig(struct udevice *dev)
  *     EC              - reading from the EC (backup)
  *
  * @dev: sysinfo device to use
- * @return SKU ID, or -ve error if not found
+ * Return: SKU ID, or -ve error if not found
  */
 static int get_skuconfig(struct udevice *dev)
 {
diff --git a/board/ti/dra7xx/evm.c b/board/ti/dra7xx/evm.c
index 23e8005..a854d61 100644
--- a/board/ti/dra7xx/evm.c
+++ b/board/ti/dra7xx/evm.c
@@ -628,7 +628,7 @@ int get_voltrail_opp(int rail_offset)
 /**
  * @brief board_init
  *
- * @return 0
+ * Return: 0
  */
 int board_init(void)
 {
diff --git a/board/ti/omap5_uevm/evm.c b/board/ti/omap5_uevm/evm.c
index 4777622..929668e 100644
--- a/board/ti/omap5_uevm/evm.c
+++ b/board/ti/omap5_uevm/evm.c
@@ -138,7 +138,7 @@ int usb_gadget_handle_interrupts(int index)
 /**
  * @brief board_init
  *
- * @return 0
+ * Return: 0
  */
 int board_init(void)
 {
@@ -172,7 +172,7 @@ int board_eth_init(struct bd_info *bis)
  * such as power configurations, ethernet initialization as phase2 of
  * boot sequence
  *
- * @return 0
+ * Return: 0
  */
 int misc_init_r(void)
 {
@@ -212,7 +212,7 @@ int board_mmc_init(struct bd_info *bis)
  * @brief board_usb_init - Configure EVM board specific configurations
  * for the LDO's and clocks for the USB blocks.
  *
- * @return 0
+ * Return: 0
  */
 int board_usb_init(int index, enum usb_init_type init)
 {
diff --git a/board/ti/panda/panda.c b/board/ti/panda/panda.c
index d806299..2209318 100644
--- a/board/ti/panda/panda.c
+++ b/board/ti/panda/panda.c
@@ -39,7 +39,7 @@ struct omap4_scrm_regs *const scrm = (struct omap4_scrm_regs *)0x4a30a000;
 /**
  * @brief board_init
  *
- * @return 0
+ * Return: 0
  */
 int board_init(void)
 {
@@ -215,7 +215,7 @@ void emif_get_dmm_regs(const struct dmm_lisa_map_regs
  * such as power configurations, ethernet initialization as phase2 of
  * boot sequence
  *
- * @return 0
+ * Return: 0
  */
 int misc_init_r(void)
 {
diff --git a/board/ti/sdp4430/sdp.c b/board/ti/sdp4430/sdp.c
index 69726eb..2c9ae79 100644
--- a/board/ti/sdp4430/sdp.c
+++ b/board/ti/sdp4430/sdp.c
@@ -25,7 +25,7 @@ const struct omap_sysinfo sysinfo = {
 /**
  * @brief board_init
  *
- * @return 0
+ * Return: 0
  */
 int board_init(void)
 {
@@ -46,7 +46,7 @@ int board_eth_init(struct bd_info *bis)
  * such as power configurations, ethernet initialization as phase2 of
  * boot sequence
  *
- * @return 0
+ * Return: 0
  */
 int misc_init_r(void)
 {