efi_loader: fix some function descriptions
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Wed, 18 Sep 2024 21:37:28 +0000 (23:37 +0200)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sat, 21 Sep 2024 08:54:42 +0000 (10:54 +0200)
* The function name must be provided in the description.
* The function name must match the name used in the description.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
lib/efi_loader/efi_console.c
lib/efi_loader/efi_file.c
lib/efi_loader/efi_rng.c
lib/efi_loader/efi_unicode_collation.c

index c944c10..b760e36 100644 (file)
@@ -100,7 +100,7 @@ static int term_get_char(s32 *c)
 }
 
 /**
- * Receive and parse a reply from the terminal.
+ * term_read_reply() - receive and parse a reply from the terminal
  *
  * @n:         array of return values
  * @num:       number of return values expected
index 222001d..c92d8cc 100644 (file)
@@ -295,7 +295,7 @@ out:
 }
 
 /**
- * efi_file_open_()
+ * efi_file_open() - open file synchronously
  *
  * This function implements the Open service of the File Protocol.
  * See the UEFI spec for details.
index 9bad7ed..4734f95 100644 (file)
@@ -91,7 +91,7 @@ back:
 }
 
 /**
- * rng_getrng() - get random value
+ * getrng() - get random value
  *
  * This function implement the GetRng() service of the EFI random number
  * generator protocol. See the UEFI spec for details.
index 627bb91..d48700a 100644 (file)
@@ -266,7 +266,7 @@ static void EFIAPI efi_fat_to_str(struct efi_unicode_collation_protocol *this,
 }
 
 /**
- * efi_fat_to_str() - convert a utf-16 string to legal characters for a FAT
+ * efi_str_to_fat() - convert a utf-16 string to legal characters for a FAT
  *                    file name in an OEM code page
  *
  * @this:      unicode collation protocol instance