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/lib/efi_loader/efi_acpi.c b/lib/efi_loader/efi_acpi.c
index a62c340..83f025e 100644
--- a/lib/efi_loader/efi_acpi.c
+++ b/lib/efi_loader/efi_acpi.c
@@ -15,7 +15,7 @@
/*
* Install the ACPI table as a configuration table.
*
- * @return status code
+ * Return: status code
*/
efi_status_t efi_acpi_register(void)
{
diff --git a/lib/efi_loader/efi_device_path.c b/lib/efi_loader/efi_device_path.c
index 735ed0b..c61f485 100644
--- a/lib/efi_loader/efi_device_path.c
+++ b/lib/efi_loader/efi_device_path.c
@@ -51,7 +51,7 @@
* Determine if an MMC device is an SD card.
*
* @desc block device descriptor
- * @return true if the device is an SD card
+ * Return: true if the device is an SD card
*/
static bool is_sd(struct blk_desc *desc)
{
@@ -223,7 +223,7 @@
* Determine the last device path node that is not the end node.
*
* @dp device path
- * @return last node before the end node if it exists
+ * Return: last node before the end node if it exists
* otherwise NULL
*/
const struct efi_device_path *efi_dp_last_node(const struct efi_device_path *dp)
@@ -572,7 +572,7 @@
*
* @buf pointer to the end of the device path
* @dev device
- * @return pointer to the end of the device path
+ * Return: pointer to the end of the device path
*/
__maybe_unused static void *dp_fill(void *buf, struct udevice *dev)
{
diff --git a/lib/efi_loader/efi_device_path_to_text.c b/lib/efi_loader/efi_device_path_to_text.c
index 57fa9d9..d8a83c8 100644
--- a/lib/efi_loader/efi_device_path_to_text.c
+++ b/lib/efi_loader/efi_device_path_to_text.c
@@ -225,7 +225,7 @@
*
* @s output buffer
* @dp device path node
- * @return next unused buffer address
+ * Return: next unused buffer address
*/
static char *dp_media(char *s, struct efi_device_path *dp)
{
@@ -310,7 +310,7 @@
*
* @buffer output buffer
* @dp device path or node
- * @return end of string
+ * Return: end of string
*/
static char *efi_convert_single_device_node_to_text(
char *buffer,
@@ -350,7 +350,7 @@
* device_node device node to be converted
* display_only true if the shorter text representation shall be used
* allow_shortcuts true if shortcut forms may be used
- * @return text representation of the device path
+ * Return: text representation of the device path
* NULL if out of memory of device_path is NULL
*/
static uint16_t EFIAPI *efi_convert_device_node_to_text(
@@ -383,7 +383,7 @@
* device_path device path to be converted
* display_only true if the shorter text representation shall be used
* allow_shortcuts true if shortcut forms may be used
- * @return text representation of the device path
+ * Return: text representation of the device path
* NULL if out of memory of device_path is NULL
*/
static uint16_t EFIAPI *efi_convert_device_path_to_text(
diff --git a/lib/efi_loader/efi_device_path_utilities.c b/lib/efi_loader/efi_device_path_utilities.c
index 9401532..a07d9ba 100644
--- a/lib/efi_loader/efi_device_path_utilities.c
+++ b/lib/efi_loader/efi_device_path_utilities.c
@@ -22,7 +22,7 @@
* for details.
*
* @device_path device path
- * @return size in bytes
+ * Return: size in bytes
*/
static efi_uintn_t EFIAPI get_device_path_size(
const struct efi_device_path *device_path)
@@ -50,7 +50,7 @@
* for details.
*
* @device_path device path
- * @return copy of the device path
+ * Return: copy of the device path
*/
static struct efi_device_path * EFIAPI duplicate_device_path(
const struct efi_device_path *device_path)
@@ -70,7 +70,7 @@
*
* @src1 1st device path
* @src2 2nd device path
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_path(
const struct efi_device_path *src1,
@@ -91,7 +91,7 @@
*
* @device_path device path
* @device_node device node
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_node(
const struct efi_device_path *device_path,
@@ -112,7 +112,7 @@
*
* @device_path 1st device path
* @device_path_instance 2nd device path
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI append_device_path_instance(
const struct efi_device_path *device_path,
@@ -134,7 +134,7 @@
*
* @device_path_instance next device path instance
* @device_path_instance_size size of the device path instance
- * @return concatenated device path
+ * Return: concatenated device path
*/
static struct efi_device_path * EFIAPI get_next_device_path_instance(
struct efi_device_path **device_path_instance,
@@ -156,7 +156,7 @@
*
* @device_path device path
* @device_node device node
- * @return concatenated device path
+ * Return: concatenated device path
*/
static bool EFIAPI is_device_path_multi_instance(
const struct efi_device_path *device_path)
@@ -177,7 +177,7 @@
* @node_type node type
* @node_sub_type node sub type
* @node_length node length
- * @return device path node
+ * Return: device path node
*/
static struct efi_device_path * EFIAPI create_device_node(
uint8_t node_type, uint8_t node_sub_type, uint16_t node_length)
diff --git a/lib/efi_loader/efi_memory.c b/lib/efi_loader/efi_memory.c
index 7f0b507..1c51a3f 100644
--- a/lib/efi_loader/efi_memory.c
+++ b/lib/efi_loader/efi_memory.c
@@ -452,7 +452,7 @@
* @memory_type usage type of the allocated memory
* @pages number of pages to be allocated
* @memory allocated memory
- * @return status code
+ * Return: status code
*/
efi_status_t efi_allocate_pages(enum efi_allocate_type type,
enum efi_memory_type memory_type,
@@ -680,7 +680,7 @@
* @map_key key for the memory map
* @descriptor_size size of an individual memory descriptor
* @descriptor_version version number of the memory descriptor structure
- * @return status code
+ * Return: status code
*/
efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
struct efi_mem_desc *memory_map,
diff --git a/lib/efi_loader/efi_smbios.c b/lib/efi_loader/efi_smbios.c
index fc0b233..306c0bc 100644
--- a/lib/efi_loader/efi_smbios.c
+++ b/lib/efi_loader/efi_smbios.c
@@ -16,7 +16,7 @@
/*
* Install the SMBIOS table as a configuration table.
*
- * @return status code
+ * Return: status code
*/
efi_status_t efi_smbios_register(void)
{