doc: Fix misspellings in header/doxygen comments
Occasional scan for misspellings missed during PR reviews Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
parent
1965e5e9fc
commit
4600c37ff1
20 changed files with 28 additions and 28 deletions
|
@ -8,7 +8,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Per-arch thread definition
|
* @brief Per-arch thread definition
|
||||||
*
|
*
|
||||||
* This file contains defintions for
|
* This file contains definitions for
|
||||||
*
|
*
|
||||||
* struct _thread_arch
|
* struct _thread_arch
|
||||||
* struct _callee_saved
|
* struct _callee_saved
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Per-arch thread definition
|
* @brief Per-arch thread definition
|
||||||
*
|
*
|
||||||
* This file contains defintions for
|
* This file contains definitions for
|
||||||
*
|
*
|
||||||
* struct _thread_arch
|
* struct _thread_arch
|
||||||
* struct _callee_saved
|
* struct _callee_saved
|
||||||
|
|
|
@ -25,7 +25,7 @@
|
||||||
*
|
*
|
||||||
* Setup the SoC clocks according to section 28.12 in datasheet.
|
* Setup the SoC clocks according to section 28.12 in datasheet.
|
||||||
*
|
*
|
||||||
* Setup Slow, Main, PLLA, Procesor and Master clocks during the device boot.
|
* Setup Slow, Main, PLLA, Processor and Master clocks during the device boot.
|
||||||
* It is assumed that the relevant registers are at their reset value.
|
* It is assumed that the relevant registers are at their reset value.
|
||||||
*/
|
*/
|
||||||
static ALWAYS_INLINE void clock_init(void)
|
static ALWAYS_INLINE void clock_init(void)
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Per-arch thread definition
|
* @brief Per-arch thread definition
|
||||||
*
|
*
|
||||||
* This file contains defintions for
|
* This file contains definitions for
|
||||||
*
|
*
|
||||||
* struct _thread_arch
|
* struct _thread_arch
|
||||||
* struct _callee_saved
|
* struct _callee_saved
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Per-arch thread definition
|
* @brief Per-arch thread definition
|
||||||
*
|
*
|
||||||
* This file contains defintions for
|
* This file contains definitions for
|
||||||
*
|
*
|
||||||
* struct _thread_arch
|
* struct _thread_arch
|
||||||
* struct _callee_saved
|
* struct _callee_saved
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Per-arch thread definition
|
* @brief Per-arch thread definition
|
||||||
*
|
*
|
||||||
* This file contains defintions for
|
* This file contains definitions for
|
||||||
*
|
*
|
||||||
* struct _thread_arch
|
* struct _thread_arch
|
||||||
* struct _callee_saved
|
* struct _callee_saved
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Per-arch thread definition
|
* @brief Per-arch thread definition
|
||||||
*
|
*
|
||||||
* This file contains defintions for
|
* This file contains definitions for
|
||||||
*
|
*
|
||||||
* struct _thread_arch
|
* struct _thread_arch
|
||||||
* struct _callee_saved
|
* struct _callee_saved
|
||||||
|
|
|
@ -32,9 +32,9 @@ struct i2c_bitbang {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Initialise an i2c_bitbang instance
|
* @brief Initialize an i2c_bitbang instance
|
||||||
*
|
*
|
||||||
* @param bitbang The instance to initialise
|
* @param bitbang The instance to initialize
|
||||||
* @param io Functions to use for controlling I2C bus lines
|
* @param io Functions to use for controlling I2C bus lines
|
||||||
* @param io_context Context pointer to pass to i/o functions when then are
|
* @param io_context Context pointer to pass to i/o functions when then are
|
||||||
* called.
|
* called.
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
* is read it must return the state of the physical hardware line, not just the
|
* is read it must return the state of the physical hardware line, not just the
|
||||||
* last state written to it for output.
|
* last state written to it for output.
|
||||||
*
|
*
|
||||||
* The SCL pin should be configued in the same manner as SDA, or, if it is known
|
* The SCL pin should be configured in the same manner as SDA, or, if it is known
|
||||||
* that the hardware attached to pin doesn't attempt clock stretching, then the
|
* that the hardware attached to pin doesn't attempt clock stretching, then the
|
||||||
* SCL pin may be a push/pull output.
|
* SCL pin may be a push/pull output.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -215,9 +215,9 @@ void _timer_idle_enter(s32_t sys_ticks)
|
||||||
#ifdef CONFIG_TICKLESS_KERNEL
|
#ifdef CONFIG_TICKLESS_KERNEL
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief provides total systicks programed.
|
* @brief provides total systicks programmed.
|
||||||
*
|
*
|
||||||
* returns : total number of sys ticks programed.
|
* returns : total number of sys ticks programmed.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
uint32_t _get_program_time(void)
|
uint32_t _get_program_time(void)
|
||||||
|
@ -226,9 +226,9 @@ uint32_t _get_program_time(void)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief provides total systicks remaining since last programing of RTC.
|
* @brief provides total systicks remaining since last programming of RTC.
|
||||||
*
|
*
|
||||||
* returns : total number of sys ticks remaining since last RTC programing.
|
* returns : total number of sys ticks remaining since last RTC programming.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
uint32_t _get_remaining_program_time(void)
|
uint32_t _get_remaining_program_time(void)
|
||||||
|
@ -242,9 +242,9 @@ uint32_t _get_remaining_program_time(void)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief provides total systicks passed since last programing of RTC.
|
* @brief provides total systicks passed since last programming of RTC.
|
||||||
*
|
*
|
||||||
* returns : total number of sys ticks passed since last RTC programing.
|
* returns : total number of sys ticks passed since last RTC programming.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
uint32_t _get_elapsed_program_time(void)
|
uint32_t _get_elapsed_program_time(void)
|
||||||
|
@ -305,7 +305,7 @@ void _set_time(uint32_t time)
|
||||||
* @brief provides time remaining to reach rtc count overflow.
|
* @brief provides time remaining to reach rtc count overflow.
|
||||||
*
|
*
|
||||||
* This function returns how many sys RTC remaining for rtc to overflow.
|
* This function returns how many sys RTC remaining for rtc to overflow.
|
||||||
* This will be required when we will programe RTC compare value to maximum
|
* This will be required when we will program RTC compare value to maximum
|
||||||
* possible value.
|
* possible value.
|
||||||
*
|
*
|
||||||
* returns : difference between current systick and Maximum possible systick.
|
* returns : difference between current systick and Maximum possible systick.
|
||||||
|
@ -334,7 +334,7 @@ int32_t _get_max_clock_time(void)
|
||||||
/**
|
/**
|
||||||
* @brief Enable sys Clock.
|
* @brief Enable sys Clock.
|
||||||
*
|
*
|
||||||
* This is used to programe RTC clock to maximum Clock time incase Clock to
|
* This is used to program RTC clock to maximum Clock time in case Clock to
|
||||||
* remain On.
|
* remain On.
|
||||||
*/
|
*/
|
||||||
void _enable_sys_clock(void)
|
void _enable_sys_clock(void)
|
||||||
|
|
|
@ -17,7 +17,7 @@
|
||||||
* There is a bit of an impedance mismatch between the Zephyr
|
* There is a bit of an impedance mismatch between the Zephyr
|
||||||
* usb_device and the STM32 Cube HAL layer where higher levels make
|
* usb_device and the STM32 Cube HAL layer where higher levels make
|
||||||
* assumptions about the low level drivers that don't quite match how
|
* assumptions about the low level drivers that don't quite match how
|
||||||
* the low level drivers actuall work.
|
* the low level drivers actually work.
|
||||||
*
|
*
|
||||||
* The usb_dc_ep_read function expects to get the data it wants
|
* The usb_dc_ep_read function expects to get the data it wants
|
||||||
* immediately while the HAL_PCD_EP_Receive function only starts a
|
* immediately while the HAL_PCD_EP_Receive function only starts a
|
||||||
|
|
|
@ -788,7 +788,7 @@ static inline u16_t coap_next_id(void)
|
||||||
*
|
*
|
||||||
* @return the net_buf fragment pointer and offset value if payload exists
|
* @return the net_buf fragment pointer and offset value if payload exists
|
||||||
* NULL pointer and offset set to 0 in case there is no payload
|
* NULL pointer and offset set to 0 in case there is no payload
|
||||||
* NULL pointer and offset value 0xffff incase of an error
|
* NULL pointer and offset value 0xffff in case of an error
|
||||||
*/
|
*/
|
||||||
struct net_buf *coap_packet_get_payload(const struct coap_packet *cpkt,
|
struct net_buf *coap_packet_get_payload(const struct coap_packet *cpkt,
|
||||||
u16_t *offset,
|
u16_t *offset,
|
||||||
|
|
|
@ -1396,7 +1396,7 @@ void net_pkt_get_info(struct k_mem_slab **rx,
|
||||||
/**
|
/**
|
||||||
* @brief Get source socket address.
|
* @brief Get source socket address.
|
||||||
*
|
*
|
||||||
* @param pkt Nework packet
|
* @param pkt Network packet
|
||||||
* @param addr Source socket address
|
* @param addr Source socket address
|
||||||
* @param addrlen The length of source socket address
|
* @param addrlen The length of source socket address
|
||||||
* @return 0 on success, <0 otherwise.
|
* @return 0 on success, <0 otherwise.
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file
|
* @file
|
||||||
* @brief USB Communicatons Device Class (CDC) public header
|
* @brief USB Communications Device Class (CDC) public header
|
||||||
*
|
*
|
||||||
* Header follows the Class Definitions for
|
* Header follows the Class Definitions for
|
||||||
* Communications Devices Specification (CDC120-20101103-track.pdf),
|
* Communications Devices Specification (CDC120-20101103-track.pdf),
|
||||||
|
|
|
@ -266,7 +266,7 @@ static inline int _obj_validation_check(struct _k_object *ko,
|
||||||
*
|
*
|
||||||
* Calls _k_object_validate and triggers a kernel oops if the check files.
|
* Calls _k_object_validate and triggers a kernel oops if the check files.
|
||||||
* For use in system call handlers which are not init functions; a fatal
|
* For use in system call handlers which are not init functions; a fatal
|
||||||
* error will occur if the object is not intiailized.
|
* error will occur if the object is not initialized.
|
||||||
*
|
*
|
||||||
* @param ptr Untrusted kernel object pointer
|
* @param ptr Untrusted kernel object pointer
|
||||||
* @param type Expected kernel object type
|
* @param type Expected kernel object type
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
* BUTTON1 is on DIO_4
|
* BUTTON1 is on DIO_4
|
||||||
* BUTTON2 is on DIO_0
|
* BUTTON2 is on DIO_0
|
||||||
*
|
*
|
||||||
* This sample toogles LED1 and wait interrupt on BUTTON1.
|
* This sample toggles LED1 and wait interrupt on BUTTON1.
|
||||||
* Note that an internet pull-up is set on BUTTON1 as the button
|
* Note that an internet pull-up is set on BUTTON1 as the button
|
||||||
* only drives low when pressed.
|
* only drives low when pressed.
|
||||||
*
|
*
|
||||||
|
|
|
@ -12,7 +12,7 @@
|
||||||
* @details All TESTPOINTs extracted from kernel documentation.
|
* @details All TESTPOINTs extracted from kernel documentation.
|
||||||
* https://www.zephyrproject.org/doc/kernel/memory/heap.html#concepts
|
* https://www.zephyrproject.org/doc/kernel/memory/heap.html#concepts
|
||||||
*
|
*
|
||||||
* TESTPOINTs cover testable kernel behaviours that preserve across internal
|
* TESTPOINTs cover testable kernel behaviors that preserve across internal
|
||||||
* implementation change or kernel version change.
|
* implementation change or kernel version change.
|
||||||
* As a black-box test, TESTPOINTs do not cover internal operations.
|
* As a black-box test, TESTPOINTs do not cover internal operations.
|
||||||
* @}
|
* @}
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
* @{
|
* @{
|
||||||
* @defgroup t_mpool_threadsafe test_mpool_threadsafe
|
* @defgroup t_mpool_threadsafe test_mpool_threadsafe
|
||||||
* @brief TestPurpose: verify API thread safe in multi-threads environment.
|
* @brief TestPurpose: verify API thread safe in multi-threads environment.
|
||||||
* @details This's an extensive test. Multiple threads in same priority are
|
* @details This is an extensive test. Multiple threads in same priority are
|
||||||
* created, with time slice scheduling enabled in a very small slicing size:
|
* created, with time slice scheduling enabled in a very small slicing size:
|
||||||
* 1 millisecond (refer to prj.conf).
|
* 1 millisecond (refer to prj.conf).
|
||||||
* All threads share a same entry function to invoke same kernel APIs.
|
* All threads share a same entry function to invoke same kernel APIs.
|
||||||
|
|
|
@ -35,7 +35,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* IPv6 Source and Destination address
|
* IPv6 Source and Destination address
|
||||||
* Example addresses are based on SAC (Source Adddress Compression),
|
* Example addresses are based on SAC (Source Address Compression),
|
||||||
* SAM (Source Address Mode), DAC (Destination Address Compression),
|
* SAM (Source Address Mode), DAC (Destination Address Compression),
|
||||||
* DAM (Destination Address Mode) and also if the destination address
|
* DAM (Destination Address Mode) and also if the destination address
|
||||||
* is Multicast address.
|
* is Multicast address.
|
||||||
|
|
|
@ -33,7 +33,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* IPv6 Source and Destination address
|
* IPv6 Source and Destination address
|
||||||
* Example addresses are based on SAC (Source Adddress Compression),
|
* Example addresses are based on SAC (Source Address Compression),
|
||||||
* SAM (Source Address Mode), DAC (Destination Address Compression),
|
* SAM (Source Address Mode), DAC (Destination Address Compression),
|
||||||
* DAM (Destination Address Mode) and also if the destination address
|
* DAM (Destination Address Mode) and also if the destination address
|
||||||
* is Multicast address.
|
* is Multicast address.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue