doc: fix misspelling in API doxygen comments

Fix misspellings in API doxygen comments missed during regular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-10-28 16:27:57 -07:00 committed by Kumar Gala
commit 73896c0bf0
13 changed files with 18 additions and 18 deletions

View file

@ -25,7 +25,7 @@ extern "C" {
* *
* This will send a GATT notification to all current subscribers. * This will send a GATT notification to all current subscribers.
* *
* @param heartrate The heartrate measuremennt in beats per minute. * @param heartrate The heartrate measurement in beats per minute.
* *
* @return Zero in case of success and error code in case of error. * @return Zero in case of success and error code in case of error.
*/ */

View file

@ -576,7 +576,7 @@ static inline int z_impl_can_recover(struct device *dev, s32_t timeout)
* @brief Register an ISR callback for state change interrupt * @brief Register an ISR callback for state change interrupt
* *
* Only one callback can be registered per controller. * Only one callback can be registered per controller.
* Calling this function again, overrides the previos call. * Calling this function again, overrides the previous call.
* *
* @param dev Pointer to the device structure for the driver instance. * @param dev Pointer to the device structure for the driver instance.
* @param isr Pointer to ISR * @param isr Pointer to ISR

View file

@ -90,7 +90,7 @@ enum espi_io_mode {
* @brief eSPI channel. * @brief eSPI channel.
* *
* Identifies each eSPI logical channel supported by eSPI controller * Identifies each eSPI logical channel supported by eSPI controller
* Each channel allows idependent traffic, but the assignment of channel * Each channel allows independent traffic, but the assignment of channel
* type to channel number is fixed. * type to channel number is fixed.
* *
* Note that generic commands are not associated with any channel, so traffic * Note that generic commands are not associated with any channel, so traffic

View file

@ -9,7 +9,7 @@
* @brief Public API for Keyboard scan matrix devices. * @brief Public API for Keyboard scan matrix devices.
* The scope of this API is simply to report which key event was triggered * The scope of this API is simply to report which key event was triggered
* and users can later decode keys using their desired scan code tables in * and users can later decode keys using their desired scan code tables in
* their application. In additon, typematic rate and delay can easily be * their application. In addition, typematic rate and delay can easily be
* implemented using a timer if desired. * implemented using a timer if desired.
*/ */
@ -70,7 +70,7 @@ struct kscan_driver_api {
* *
* @param dev Pointer to the device structure for the driver instance. * @param dev Pointer to the device structure for the driver instance.
* @param callback called when keyboard devices reply to to a keyboard * @param callback called when keyboard devices reply to to a keyboard
* event susch as key pressed/released. * event such as key pressed/released.
* *
* @retval 0 If successful. * @retval 0 If successful.
* @retval Negative errno code if failure. * @retval Negative errno code if failure.

View file

@ -20,7 +20,7 @@
* @param child HT16K33 keyscan child device. * @param child HT16K33 keyscan child device.
* @param keyscan_idx Index of the keyscan line handled by the keyscan * @param keyscan_idx Index of the keyscan line handled by the keyscan
* child device (0, 1, or 2). * child device (0, 1, or 2).
* @return 0 if successful, negative errne code on failure. * @return 0 if successful, negative errno code on failure.
*/ */
int ht16k33_register_keyscan_device(struct device *parent, int ht16k33_register_keyscan_device(struct device *parent,
struct device *child, struct device *child,

View file

@ -56,7 +56,7 @@ struct video_format {
* *
* Used to describe a video endpoint format capability. * Used to describe a video endpoint format capability.
* *
* @param pixelformat is a list of suported pixel formats (0 terminated). * @param pixelformat is a list of supported pixel formats (0 terminated).
* @param width_min is the minimum supported frame width. * @param width_min is the minimum supported frame width.
* @param width_max is the maximum supported frame width. * @param width_max is the maximum supported frame width.
* @param height_min is the minimum supported frame width. * @param height_min is the minimum supported frame width.

View file

@ -45,7 +45,7 @@ enum k_fatal_error_reason {
* @brief Halt the system on a fatal error * @brief Halt the system on a fatal error
* *
* Invokes architecture-specific code to power off or halt the system in * Invokes architecture-specific code to power off or halt the system in
* a low power state. Lacking that, lock interupts and sit in an idle loop. * a low power state. Lacking that, lock interrupts and sit in an idle loop.
* *
* @param reason Fatal exception reason code * @param reason Fatal exception reason code
*/ */

View file

@ -191,7 +191,7 @@ typedef int (*fcb_walk_cb)(struct fcb_entry_ctx *loc_ctx, void *arg);
/** /**
* Walk over all entries in the FCB sector * Walk over all entries in the FCB sector
* *
* @param[in] sector fcb sector to be wallked. If null, traverse entire * @param[in] sector fcb sector to be walked. If null, traverse entire
* storage. * storage.
* @param[in] fcb FCB instance structure. * @param[in] fcb FCB instance structure.
* @param[in] cb pointer to the function which gets called for every * @param[in] cb pointer to the function which gets called for every
@ -290,7 +290,7 @@ int fcb_clear(struct fcb *fcb);
*/ */
/** /**
* @brief Flash Circular internall * @brief Flash Circular internal
* @defgroup fcb_internall fcb non-API prototypes * @defgroup fcb_internall fcb non-API prototypes
* @ingroup fcb * @ingroup fcb
* @{ * @{

View file

@ -1330,7 +1330,7 @@ const char *k_thread_name_get(k_tid_t thread_id);
* *
* @param thread_id Thread to obtain name information * @param thread_id Thread to obtain name information
* @param buf Destination buffer * @param buf Destination buffer
* @param size Destinatiomn buffer size * @param size Destination buffer size
* @retval -ENOSPC Destination buffer too small * @retval -ENOSPC Destination buffer too small
* @retval -EFAULT Memory access error * @retval -EFAULT Memory access error
* @retval -ENOSYS Thread name feature not enabled * @retval -ENOSYS Thread name feature not enabled
@ -3106,7 +3106,7 @@ extern void k_work_poll_init(struct k_work_poll *work,
* Submitting a previously submitted triggered work item that is still * Submitting a previously submitted triggered work item that is still
* waiting for the event cancels the existing submission and reschedules it * waiting for the event cancels the existing submission and reschedules it
* the using the new event list. Note that this behavior is inherently subject * the using the new event list. Note that this behavior is inherently subject
* to race conditions with the pre-existig triggered work item and work queue, * to race conditions with the pre-existing triggered work item and work queue,
* so care must be taken to synchronize such resubmissions externally. * so care must be taken to synchronize such resubmissions externally.
* *
* @note Can be called by ISRs. * @note Can be called by ISRs.
@ -3146,7 +3146,7 @@ extern int k_work_poll_submit_to_queue(struct k_work_q *work_q,
* Submitting a previously submitted triggered work item that is still * Submitting a previously submitted triggered work item that is still
* waiting for the event cancels the existing submission and reschedules it * waiting for the event cancels the existing submission and reschedules it
* the using the new event list. Note that this behavior is inherently subject * the using the new event list. Note that this behavior is inherently subject
* to race conditions with the pre-existig triggered work item and work queue, * to race conditions with the pre-existing triggered work item and work queue,
* so care must be taken to synchronize such resubmissions externally. * so care must be taken to synchronize such resubmissions externally.
* *
* @note Can be called by ISRs. * @note Can be called by ISRs.
@ -3185,7 +3185,7 @@ static inline int k_work_poll_submit(struct k_work_poll *work,
* *
* @param work Address of delayed work item. * @param work Address of delayed work item.
* *
* @retval 0 Work tiem canceled. * @retval 0 Work item canceled.
* @retval -EINVAL Work item is being processed or has completed its work. * @retval -EINVAL Work item is being processed or has completed its work.
*/ */
extern int k_work_poll_cancel(struct k_work_poll *work); extern int k_work_poll_cancel(struct k_work_poll *work);

View file

@ -636,7 +636,7 @@ void __printf_like(2, 3) log_from_user(struct log_msg_ids src_level,
/* Internal function used by log_from_user(). */ /* Internal function used by log_from_user(). */
__syscall void z_log_string_from_user(u32_t src_level_val, const char *str); __syscall void z_log_string_from_user(u32_t src_level_val, const char *str);
/** @brief Log binary data (displayed as hexdump) from user mode conext. /** @brief Log binary data (displayed as hexdump) from user mode context.
* *
* @note This function is intended to be used internally * @note This function is intended to be used internally
* by the logging subsystem. * by the logging subsystem.

View file

@ -172,7 +172,7 @@ struct settings_handler_static {
* @param _commit commit routine (can be NULL) * @param _commit commit routine (can be NULL)
* @param _export export routine (can be NULL) * @param _export export routine (can be NULL)
* *
* This createa a variable _hname prepended by settings_handler_. * This creates a variable _hname prepended by settings_handler_.
* *
*/ */

View file

@ -75,7 +75,7 @@ void shell_history_mode_exit(struct shell_history *history);
* @param[in] history Shell history instance. * @param[in] history Shell history instance.
* @param[in] up Direction. * @param[in] up Direction.
* @param[out] dst Buffer where line is copied. * @param[out] dst Buffer where line is copied.
* @param[in,out] len Buffer size (intput), amount of copied * @param[in,out] len Buffer size (input), amount of copied
* data (output). * data (output).
* @return True if remains in history mode. * @return True if remains in history mode.
*/ */

View file

@ -6,7 +6,7 @@
/** /**
* @file * @file
* @brief Extra arithmetic and bitmanipulation functions. * @brief Extra arithmetic and bit manipulation functions.
* *
* @details This header file provides portable wrapper functions for a number of * @details This header file provides portable wrapper functions for a number of
* arithmetic and bit-counting functions that are often provided by compiler * arithmetic and bit-counting functions that are often provided by compiler