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>

13 files changed, 32 insertions, 32 deletions

diff --git a/lib/efi_selftest/dtbdump.c b/lib/efi_selftest/dtbdump.c
index f6ddaa3072..ed3b985cab 100644
--- a/lib/efi_selftest/dtbdump.c
+++ b/lib/efi_selftest/dtbdump.c
@@ -160,7 +160,7 @@ static efi_status_t efi_input(u16 *buffer, efi_uintn_t buffer_size)
  * Convert FDT value to host endianness.
  *
  * @val		FDT value
- * @return	converted value
+ * Return:	converted value
  */
 static u32 f2h(fdt32_t val)
 {
diff --git a/lib/efi_selftest/efi_selftest.c b/lib/efi_selftest/efi_selftest.c
index 39ee2edf5d..3da34b1d46 100644
--- a/lib/efi_selftest/efi_selftest.c
+++ b/lib/efi_selftest/efi_selftest.c
@@ -75,7 +75,7 @@ void efi_st_exit_boot_services(void)
  *
  * @test	the test to be executed
  * @failures	counter that will be incremented if a failure occurs
- * @return	EFI_ST_SUCCESS for success
+ * Return:	EFI_ST_SUCCESS for success
  */
 static int setup(struct efi_unit_test *test, unsigned int *failures)
 {
@@ -100,7 +100,7 @@ static int setup(struct efi_unit_test *test, unsigned int *failures)
  *
  * @test	the test to be executed
  * @failures	counter that will be incremented if a failure occurs
- * @return	EFI_ST_SUCCESS for success
+ * Return:	EFI_ST_SUCCESS for success
  */
 static int execute(struct efi_unit_test *test, unsigned int *failures)
 {
@@ -125,7 +125,7 @@ static int execute(struct efi_unit_test *test, unsigned int *failures)
  *
  * @test	the test to be torn down
  * @failures	counter that will be incremented if a failure occurs
- * @return	EFI_ST_SUCCESS for success
+ * Return:	EFI_ST_SUCCESS for success
  */
 static int teardown(struct efi_unit_test *test, unsigned int *failures)
 {
diff --git a/lib/efi_selftest/efi_selftest_block_device.c b/lib/efi_selftest/efi_selftest_block_device.c
index 15f03751ac..ad53dac796 100644
--- a/lib/efi_selftest/efi_selftest_block_device.c
+++ b/lib/efi_selftest/efi_selftest_block_device.c
@@ -57,7 +57,7 @@ static u8 *image;
  * Reset service of the block IO protocol.
  *
  * @this	block IO protocol
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t EFIAPI reset(
 			struct efi_block_io *this,
@@ -74,7 +74,7 @@ static efi_status_t EFIAPI reset(
  * @lba		start of the read in logical blocks
  * @buffer_size	number of bytes to read
  * @buffer	target buffer
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t EFIAPI read_blocks(
 			struct efi_block_io *this, u32 media_id, u64 lba,
@@ -99,7 +99,7 @@ static efi_status_t EFIAPI read_blocks(
  * @lba		start of the write in logical blocks
  * @buffer_size	number of bytes to read
  * @buffer	source buffer
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t EFIAPI write_blocks(
 			struct efi_block_io *this, u32 media_id, u64 lba,
@@ -120,7 +120,7 @@ static efi_status_t EFIAPI write_blocks(
  * Flush service of the block IO protocol.
  *
  * @this	block IO protocol
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t EFIAPI flush_blocks(struct efi_block_io *this)
 {
@@ -131,7 +131,7 @@ static efi_status_t EFIAPI flush_blocks(struct efi_block_io *this)
  * Decompress the disk image.
  *
  * @image	decompressed disk image
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t decompress(u8 **image)
 {
@@ -278,7 +278,7 @@ static int teardown(void)
  * Get length of device path without end tag.
  *
  * @dp		device path
- * @return	length of device path in bytes
+ * Return:	length of device path in bytes
  */
 static efi_uintn_t dp_size(struct efi_device_path *dp)
 {
diff --git a/lib/efi_selftest/efi_selftest_controllers.c b/lib/efi_selftest/efi_selftest_controllers.c
index 38720bb63d..d2bbd1c4f6 100644
--- a/lib/efi_selftest/efi_selftest_controllers.c
+++ b/lib/efi_selftest/efi_selftest_controllers.c
@@ -35,7 +35,7 @@ static efi_handle_t handle_driver;
  * @handle	handle on which child controllers are installed
  * @protocol	protocol for which the child controllers were installed
  * @count	number of child controllers
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t count_child_controllers(efi_handle_t handle,
 					    efi_guid_t *protocol,
@@ -69,7 +69,7 @@ static efi_status_t count_child_controllers(efi_handle_t handle,
  * @this			driver binding protocol
  * @controller_handle		handle of the controller
  * @remaining_device_path	path specifying the child controller
- * @return			status code
+ * Return:			status code
  */
 static efi_status_t EFIAPI supported(
 		struct efi_driver_binding_protocol *this,
@@ -106,7 +106,7 @@ static efi_status_t EFIAPI supported(
  * @this			driver binding protocol
  * @controller_handle		handle of the controller
  * @remaining_device_path	path specifying the child controller
- * @return			status code
+ * Return:			status code
  */
 static efi_status_t EFIAPI start(
 		struct efi_driver_binding_protocol *this,
@@ -161,7 +161,7 @@ static efi_status_t EFIAPI start(
  *
  * @controller_handle	parent controller
  * @child_handle	child controller
- * @return		status code
+ * Return:		status code
  */
 static efi_status_t disconnect_child(efi_handle_t controller_handle,
 				     efi_handle_t child_handle)
@@ -191,7 +191,7 @@ static efi_status_t disconnect_child(efi_handle_t controller_handle,
  * @controller_handle		handle of the controller
  * @number_of_children		number of child controllers to remove
  * @child_handle_buffer		handles of the child controllers to remove
- * @return			status code
+ * Return:			status code
  */
 static efi_status_t EFIAPI stop(
 		struct efi_driver_binding_protocol *this,
diff --git a/lib/efi_selftest/efi_selftest_exception.c b/lib/efi_selftest/efi_selftest_exception.c
index 6e900a35dc..d86228a892 100644
--- a/lib/efi_selftest/efi_selftest_exception.c
+++ b/lib/efi_selftest/efi_selftest_exception.c
@@ -63,7 +63,7 @@ static u8 *image;
  * Decompress the disk image.
  *
  * @image	decompressed disk image
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t decompress(u8 **image)
 {
diff --git a/lib/efi_selftest/efi_selftest_fdt.c b/lib/efi_selftest/efi_selftest_fdt.c
index 412ba286ea..739f029b8c 100644
--- a/lib/efi_selftest/efi_selftest_fdt.c
+++ b/lib/efi_selftest/efi_selftest_fdt.c
@@ -51,7 +51,7 @@ static uint32_t f2h(fdt32_t val)
  *
  * @property	name of the property
  * @node	name of the node or NULL for root node
- * @return	value of the property
+ * Return:	value of the property
  */
 static char *get_property(const u16 *property, const u16 *node)
 {
diff --git a/lib/efi_selftest/efi_selftest_load_file.c b/lib/efi_selftest/efi_selftest_load_file.c
index 4473e7c36e..bf955cbf66 100644
--- a/lib/efi_selftest/efi_selftest_load_file.c
+++ b/lib/efi_selftest/efi_selftest_load_file.c
@@ -166,7 +166,7 @@ struct efi_device_path *dp_lf2_file_remainder = &dp_lf2_file.f.dp;
  * Decompress the disk image.
  *
  * @image	decompressed disk image
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t decompress(u8 **image)
 {
diff --git a/lib/efi_selftest/efi_selftest_loadimage.c b/lib/efi_selftest/efi_selftest_loadimage.c
index 06a87df862..4975d80ff1 100644
--- a/lib/efi_selftest/efi_selftest_loadimage.c
+++ b/lib/efi_selftest/efi_selftest_loadimage.c
@@ -370,7 +370,7 @@ static efi_status_t EFIAPI flush(struct efi_file_handle *this)
  * Decompress the disk image.
  *
  * @image	decompressed disk image
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t decompress(u8 **image)
 {
diff --git a/lib/efi_selftest/efi_selftest_miniapp_exception.c b/lib/efi_selftest/efi_selftest_miniapp_exception.c
index 59b7e5100a..9be0e7e3eb 100644
--- a/lib/efi_selftest/efi_selftest_miniapp_exception.c
+++ b/lib/efi_selftest/efi_selftest_miniapp_exception.c
@@ -15,7 +15,7 @@
  *
  * @handle	handle of the loaded image
  * @systable	system table
- * @return	status code
+ * Return:	status code
  */
 efi_status_t EFIAPI efi_main(efi_handle_t handle,
 			     struct efi_system_table *systable)
diff --git a/lib/efi_selftest/efi_selftest_miniapp_return.c b/lib/efi_selftest/efi_selftest_miniapp_return.c
index 5709e39cac..25a2bd1637 100644
--- a/lib/efi_selftest/efi_selftest_miniapp_return.c
+++ b/lib/efi_selftest/efi_selftest_miniapp_return.c
@@ -16,7 +16,7 @@
  *
  * @handle	handle of the loaded image
  * @systable	system table
- * @return	status code
+ * Return:	status code
  */
 efi_status_t EFIAPI efi_main(efi_handle_t handle,
 			     struct efi_system_table *systable)
diff --git a/lib/efi_selftest/efi_selftest_startimage_exit.c b/lib/efi_selftest/efi_selftest_startimage_exit.c
index 11207b8162..5d4c0a6972 100644
--- a/lib/efi_selftest/efi_selftest_startimage_exit.c
+++ b/lib/efi_selftest/efi_selftest_startimage_exit.c
@@ -43,7 +43,7 @@ static u8 *image;
  * Decompress the disk image.
  *
  * @image	decompressed disk image
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t decompress(u8 **image)
 {
diff --git a/lib/efi_selftest/efi_selftest_startimage_return.c b/lib/efi_selftest/efi_selftest_startimage_return.c
index fabf53d983..44c23644ea 100644
--- a/lib/efi_selftest/efi_selftest_startimage_return.c
+++ b/lib/efi_selftest/efi_selftest_startimage_return.c
@@ -43,7 +43,7 @@ static u8 *image;
  * Decompress the disk image.
  *
  * @image	decompressed disk image
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t decompress(u8 **image)
 {
diff --git a/lib/efi_selftest/efi_selftest_tcg2.c b/lib/efi_selftest/efi_selftest_tcg2.c
index c5b0b7dd02..2eed588eea 100644
--- a/lib/efi_selftest/efi_selftest_tcg2.c
+++ b/lib/efi_selftest/efi_selftest_tcg2.c
@@ -401,7 +401,7 @@ static struct boot_variable boot_variable_test[] = {
  * efi_status_t decompress() - Decompress the disk image.
  *
  * @image	decompressed disk image
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t decompress(u8 **image)
 {
@@ -438,7 +438,7 @@ static efi_status_t decompress(u8 **image)
  * Preexisting variable values are saved and will be restored by
  * calling restore_boot_variable().
  *
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t setup_boot_variable(void)
 {
@@ -494,7 +494,7 @@ static efi_status_t setup_boot_variable(void)
  *
  * Restore the variable values saved in setup_boot_variable().
  *
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t restore_boot_variable(void)
 {
@@ -536,7 +536,7 @@ static efi_status_t restore_boot_variable(void)
  * void *find_smbios_table() - Find smbios table
  *
  * @systable	system table
- * @return	status code
+ * Return:	status code
  */
 static void *find_smbios_table(const struct efi_system_table *systable)
 {
@@ -554,7 +554,7 @@ static void *find_smbios_table(const struct efi_system_table *systable)
  * efi_status_t setup_smbios_table() - Prepare the dummy SMBIOS table
  *
  * @systable	system table
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t setup_smbios_table(const struct efi_system_table *systable)
 {
@@ -676,7 +676,7 @@ static int efi_st_tcg2_setup(const efi_handle_t img_handle,
  *
  * @tcg2		tcg2 protocol
  * @manufacturer_id	pointer to the manufacturer_id
- * @return		status code
+ * Return:		status code
  */
 static efi_status_t get_manufacturer_id(struct efi_tcg2_protocol *tcg2, u32 *manufacturer_id)
 {
@@ -716,7 +716,7 @@ static efi_status_t get_manufacturer_id(struct efi_tcg2_protocol *tcg2, u32 *man
  *
  * @tcg2		tcg2 protocol
  * @manufacturer_id	pointer to the manufacturer_id
- * @return		status code
+ * Return:		status code
  */
 static efi_status_t get_manufacturer_id_buffer_small(struct efi_tcg2_protocol *tcg2)
 {
@@ -742,7 +742,7 @@ static efi_status_t get_manufacturer_id_buffer_small(struct efi_tcg2_protocol *t
  *
  * @tcg2	tcg2 protocol
  * @idx		pcr index to read
- * @return	status code
+ * Return:	status code
  */
 static efi_status_t read_pcr(struct efi_tcg2_protocol *tcg2, u32 idx)
 {
@@ -779,7 +779,7 @@ static efi_status_t read_pcr(struct efi_tcg2_protocol *tcg2, u32 idx)
 /**
  * int validate_pcrs() - Compare the expected and actual pcrs
  *
- * @return	status code
+ * Return:	status code
  */
 static int validate_pcrs(void)
 {