From 016c39c3b24e390f4672e3a2a649230acab0afd3 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 18 Sep 2024 23:49:40 +0200 Subject: doc: include/getopt.h: remove comments confusing Sphinx The Sphinx documentation build process cannot handle the interspersed 'private:' and 'public:' comments. Remove them. Signed-off-by: Heinrich Schuchardt --- include/getopt.h | 3 --- 1 file changed, 3 deletions(-) (limited to 'include') diff --git a/include/getopt.h b/include/getopt.h index 8645082da2a..0cf7ee84d6f 100644 --- a/include/getopt.h +++ b/include/getopt.h @@ -20,11 +20,9 @@ struct getopt_state { * parsed all of @argv, then @index will equal @argc. */ int index; - /* private: */ /** @arg_index: Index within the current argument */ int arg_index; union { - /* public: */ /** * @opt: Option being parsed when an error occurs. @opt is only * valid when getopt() returns ``?`` or ``:``. @@ -35,7 +33,6 @@ struct getopt_state { * is only valid when getopt() returns an option character. */ char *arg; - /* private: */ }; }; -- cgit v1.3.1 From 89d911e386cc439c68ab961e76937c377e7d7127 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 18 Sep 2024 23:51:34 +0200 Subject: efi_loader: correct efi_set_variable_int() description The name used in the function description must match the function. Signed-off-by: Heinrich Schuchardt Reviewed-by: Ilias Apalodimas --- include/efi_variable.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'include') diff --git a/include/efi_variable.h b/include/efi_variable.h index 223bb9a4a5b..4065cf45eca 100644 --- a/include/efi_variable.h +++ b/include/efi_variable.h @@ -38,7 +38,7 @@ efi_status_t efi_get_variable_int(const u16 *variable_name, void *data, u64 *timep); /** - * efi_set_variable() - set value of a UEFI variable + * efi_set_variable_int() - set value of a UEFI variable * * @variable_name: name of the variable * @vendor: vendor GUID -- cgit v1.3.1 From 55ff5ffdd4aa4e27464f7dc5758ade4b31219bc9 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 18 Sep 2024 23:54:08 +0200 Subject: sandbox: fix OS function descriptions * Add missing function names. * Align names used in descriptions with function names. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- include/os.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'include') diff --git a/include/os.h b/include/os.h index 877404a6c13..4f73f0b60f1 100644 --- a/include/os.h +++ b/include/os.h @@ -24,7 +24,7 @@ struct sandbox_state; int os_printf(const char *format, ...); /** - * Access to the OS read() system call + * os_read() - access the OS read() system call * * @fd: File descriptor as returned by os_open() * @buf: Buffer to place data @@ -34,7 +34,7 @@ int os_printf(const char *format, ...); ssize_t os_read(int fd, void *buf, size_t count); /** - * Access to the OS write() system call + * os_write() - access the OS write() system call * * @fd: File descriptor as returned by os_open() * @buf: Buffer containing data to write @@ -44,7 +44,7 @@ ssize_t os_read(int fd, void *buf, size_t count); ssize_t os_write(int fd, const void *buf, size_t count); /** - * Access to the OS lseek() system call + * os_lseek() - access the OS lseek() system call * * @fd: File descriptor as returned by os_open() * @offset: File offset (based on whence) @@ -67,7 +67,7 @@ off_t os_lseek(int fd, off_t offset, int whence); off_t os_filesize(int fd); /** - * Access to the OS open() system call + * os_open() - access the OS open() system call * * @pathname: Pathname of file to open * @flags: Flags, like OS_O_RDONLY, OS_O_RDWR @@ -162,7 +162,7 @@ void os_raise_sigalrm(void); void os_tty_raw(int fd, bool allow_sigs); /** - * os_fs_restore() - restore the tty to its original mode + * os_fd_restore() - restore the tty to its original mode * * Call this to restore the original terminal mode, after it has been changed * by os_tty_raw(). This is an internal function. @@ -207,14 +207,14 @@ void *os_realloc(void *ptr, size_t length); void os_usleep(unsigned long usec); /** - * Gets a monotonic increasing number of nano seconds from the OS + * os_get_nsec() - get monotonically increasing number of nano seconds from OS * - * Return: a monotonic increasing time scaled in nano seconds + * Return: a monotoniccally increasing time scaled in nano seconds */ uint64_t os_get_nsec(void); /** - * Parse arguments and update sandbox state. + * os_parse_args() - parse arguments and update sandbox state. * * @state: sandbox state to update * @argc: argument count -- cgit v1.3.1 From d168c637e4d4b70f9991f6e78520e3e987fa00f4 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 18 Sep 2024 23:58:03 +0200 Subject: boot: correct struct expo_action description Correct the description of the select.id member to fix a kernel-doc warning. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- include/expo.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'include') diff --git a/include/expo.h b/include/expo.h index 264745f7f01..c235fa2709d 100644 --- a/include/expo.h +++ b/include/expo.h @@ -42,7 +42,7 @@ enum expoact_type { * * @type: Action type (EXPOACT_NONE if there is no action) * @select: Used for EXPOACT_POINT_ITEM and EXPOACT_SELECT - * @id: ID number of the object affected. + * @select.id: ID number of the object affected. */ struct expo_action { enum expoact_type type; -- cgit v1.3.1 From 73de2598735e0698592a33096a91cc1038b9fedd Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Thu, 19 Sep 2024 00:01:13 +0200 Subject: events: correct event_uninit() description The function name in the description must match the function. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- include/event.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'include') diff --git a/include/event.h b/include/event.h index fb353ad623e..75141a192a4 100644 --- a/include/event.h +++ b/include/event.h @@ -385,7 +385,7 @@ static inline int event_notify_null(enum event_t type) int event_uninit(void); /** - * event_uninit() - Set up dynamic events + * event_init() - Set up dynamic events * * Init a list of dynamic event handlers, so that these can be added as * needed -- cgit v1.3.1