doc: Correct spelling errors in the code documentation

Part-of: <https://gitlab.freedesktop.org/libinput/libei/-/merge_requests/343>
This commit is contained in:
Jason Gerecke 2025-07-02 14:00:59 -07:00
parent ac9b92bbae
commit 6aa4dc0c7e
6 changed files with 14 additions and 14 deletions

View file

@ -127,7 +127,7 @@ struct brei_object {
/**
* Marshal the message for the given object id, opcode and signature into
* a struct iobuf. On succes, the returned result has that iobuf
* a struct iobuf. On success, the returned result has that iobuf
* as brei_result_get_data(), otherwise the result is the error.
*/
struct brei_result *

View file

@ -727,9 +727,9 @@ ei_log_context_get_func(struct ei_log_context *ctx);
* messages with a log level equal or greater than than the one set in
* ei_log_set_priority().
*
* The context passed to this function contains auxilary information about
* The context passed to this function contains auxiliary information about
* this log message such as the line number, file name and function name
* this message occured in. The log context is valid only within the current
* this message occurred in. The log context is valid only within the current
* invocation of the log handler.
*
* @param ei The EI context
@ -1046,7 +1046,7 @@ ei_seat_get_name(struct ei_seat *seat);
/**
* @ingroup libei-seat
*
* Return true if the capabilitiy is available on this seat or false
* Return true if the capability is available on this seat or false
* otherwise. The return value of this function is not affected by
* ei_seat_confirm_capability().
*/
@ -1078,7 +1078,7 @@ __attribute__((sentinel));
/**
* @ingroup libei-seat
*
* Unbind a seat's capabilities, terminatd by ``NULL``.
* Unbind a seat's capabilities, terminated by ``NULL``.
* This function indicates the the application is
* no longer interested in devices with the given capability.
*
@ -1433,7 +1433,7 @@ ei_region_get_height(struct ei_region *region);
* Get the unique identifier (representing an external resource) that is
* attached to this region, if any. This is only available if the EIS
* implementation supports version 2 or later of the ei_device protocol
* interface *and* the EIS implementation chooses to attach such an identifer to
* interface *and* the EIS implementation chooses to attach such an identifier to
* the region.
*
* This ID can be used by the client to identify an external resource that has a

View file

@ -327,7 +327,7 @@ iobuf_append_fd(struct iobuf *buf, int fd)
/**
* Append all available data from the file descriptor to the pointer. The
* file descriptor shold be in O_NONBLOCK or this call will block. If the
* file descriptor should be in O_NONBLOCK or this call will block. If the
* data exceeds the current buffer size it is resized automatically.
*
* @return The number of bytes read or a negative errno on failure. Zero
@ -356,7 +356,7 @@ iobuf_append_from_fd(struct iobuf *buf, int fd)
/**
* Append all available data from the file descriptor to the pointer. The
* file descriptor shold be in O_NONBLOCK or this call will block. If the
* file descriptor should be in O_NONBLOCK or this call will block. If the
* data exceeds the current buffer size it is resized automatically.
*
* Any file descriptors passed through the fd are placed into the struct
@ -628,7 +628,7 @@ MUNIT_TEST(test_iobuf_append_short)
_cleanup_iobuf_ struct iobuf *buf = iobuf_new(10);
/* Append only the first few bytes out of a larger data field, i.e.
* make sure we honor the lenght parameter */
* make sure we honor the length parameter */
const char data[] = "foobar";
const char nullbyte = '\0';
iobuf_append(buf, data, 3);

View file

@ -330,7 +330,7 @@ iobuf_append_fd(struct iobuf *buf, int fd);
/**
* Append all available data from the file descriptor to the pointer. The
* file descriptor shold be in O_NONBLOCK or this call will block. If the
* file descriptor should be in O_NONBLOCK or this call will block. If the
* data exceeds the current buffer size it is resized automatically.
*
* @return The number of bytes read or a negative errno on failure. Zero
@ -341,7 +341,7 @@ iobuf_append_from_fd(struct iobuf *buf, int fd);
/**
* Append all available data from the file descriptor to the pointer. The
* file descriptor shold be in O_NONBLOCK or this call will block. If the
* file descriptor should be in O_NONBLOCK or this call will block. If the
* data exceeds the current buffer size it is resized automatically.
*
* Any file descriptors passed through the fd are placed

View file

@ -119,7 +119,7 @@ strv_from_string(const char *in, const char *separators)
* An empty strv ([NULL]) returns NULL, same for passing NULL as either
* argument.
*
* @param strv Input string arrray
* @param strv Input string array
* @param joiner Joiner between the elements in the final string
*
* @return A null-terminated string joining all elements

View file

@ -270,7 +270,7 @@ peck_eis_now(struct peck *peck);
/**
* Dispatch all events according to the currently defined behavior.
* When this function returns false, the connection is in a "stable" state
* and futher calls to this function will not change that state. This stable
* and further calls to this function will not change that state. This stable
* state may mean either there are no events or events pending to be
* processed by the caller.
*
@ -285,7 +285,7 @@ _peck_dispatch_eis(struct peck *peck, int lineno);
/**
* Dispatch all events according to the currently defined behavior.
* When this function returns false, the connection is in a "stable" state
* and futher calls to this function will not change that state. This stable
* and further calls to this function will not change that state. This stable
* state may mean either there are no events or events pending to be
* processed by the caller.
*