Skip to content

Commit d1369ef

Browse files
committed
HardwareTimer: fix typo in comments
Signed-off-by: Alexandre Bourdiol <[email protected]>
1 parent 7e56d54 commit d1369ef

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

cores/arduino/HardwareTimer.cpp

+13-13
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ void HardwareTimer::pauseChannel(uint32_t channel)
211211
*/
212212
void HardwareTimer::resume(void)
213213
{
214-
// Clear flag and ennable IT
214+
// Clear flag and enable IT
215215
if (callbacks[0]) {
216216
__HAL_TIM_CLEAR_FLAG(&(_timerObj.handle), TIM_FLAG_UPDATE);
217217
__HAL_TIM_ENABLE_IT(&(_timerObj.handle), TIM_IT_UPDATE);
@@ -470,7 +470,7 @@ void HardwareTimer::setPrescaleFactor(uint32_t prescaler)
470470

471471
/**
472472
* @brief Retrieve overflow (rollover) value from hardware register
473-
* @param format of returned value. If ommited default format is Tick
473+
* @param format of returned value. If omitted default format is Tick
474474
* @retval overflow depending on format value:
475475
* TICK_FORMAT: return number of tick for overflow
476476
* MICROSEC_FORMAT: return number of microsecondes for overflow
@@ -505,7 +505,7 @@ uint32_t HardwareTimer::getOverflow(TimerFormat_t format)
505505
* (usually the next timer overflow). See setPreloadEnable()
506506
* for controlling this behaviour.
507507
* @param overflow: depend on format parameter
508-
* @param format of overflow parameter. If ommited default format is Tick
508+
* @param format of overflow parameter. If omitted default format is Tick
509509
* TICK_FORMAT: overflow is the number of tick for overflow
510510
* MICROSEC_FORMAT: overflow is the number of microsecondes for overflow
511511
* HERTZ_FORMAT: overflow is the frequency in hertz for overflow
@@ -549,7 +549,7 @@ void HardwareTimer::setOverflow(uint32_t overflow, TimerFormat_t format)
549549

550550
/**
551551
* @brief Retreive timer counter value
552-
* @param format of returned value. If ommited default format is Tick
552+
* @param format of returned value. If omitted default format is Tick
553553
* @retval overflow depending on format value:
554554
* TICK_FORMAT: return number of tick for counter
555555
* MICROSEC_FORMAT: return number of microsecondes for counter
@@ -578,7 +578,7 @@ uint32_t HardwareTimer::getCount(TimerFormat_t format)
578578
/**
579579
* @brief Set timer counter value
580580
* @param counter: depend on format parameter
581-
* @param format of overflow parameter. If ommited default format is Tick
581+
* @param format of overflow parameter. If omitted default format is Tick
582582
* TICK_FORMAT: counter is the number of tick
583583
* MICROSEC_FORMAT: counter is the number of microsecondes
584584
* HERTZ_FORMAT: counter is the frequency in hertz
@@ -793,7 +793,7 @@ void HardwareTimer::setPreloadEnable(bool value)
793793
* @brief Set channel Capture/Compare register
794794
* @param channel: Arduino channel [1..4]
795795
* @param compare: compare value depending on format
796-
* @param format of compare parameter. If ommited default format is Tick
796+
* @param format of compare parameter. If omitted default format is Tick
797797
* TICK_FORMAT: compare is the number of tick
798798
* MICROSEC_FORMAT: compare is the number of microsecondes
799799
* HERTZ_FORMAT: compare is the frequency in hertz
@@ -857,7 +857,7 @@ void HardwareTimer::setCaptureCompare(uint32_t channel, uint32_t compare, TimerC
857857
/**
858858
* @brief Retrieve Capture/Compare value
859859
* @param channel: Arduino channel [1..4]
860-
* @param format of return value. If ommited default format is Tick
860+
* @param format of return value. If omitted default format is Tick
861861
* TICK_FORMAT: return value is the number of tick for Capture/Compare value
862862
* MICROSEC_FORMAT: return value is the number of microsecondes for Capture/Compare value
863863
* HERTZ_FORMAT: return value is the frequency in hertz for Capture/Compare value
@@ -913,9 +913,9 @@ uint32_t HardwareTimer::getCaptureCompare(uint32_t channel, TimerCompareFormat_
913913
/**
914914
* @param channel: Arduino channel [1..4]
915915
* @param pin: Arduino pin number, ex D1, 1 or PA1
916-
* @param frequency: PWM frequency expessed in hertz
916+
* @param frequency: PWM frequency expressed in hertz
917917
* @param dutycycle: PWM dutycycle expressed in percentage
918-
* @param PeriodCallback: timer period callback (timer rollover upon udate event)
918+
* @param PeriodCallback: timer period callback (timer rollover upon update event)
919919
* @param CompareCallback: timer compare callback
920920
* @retval None
921921
*/
@@ -928,9 +928,9 @@ void HardwareTimer::setPWM(uint32_t channel, uint32_t pin, uint32_t frequency, u
928928
* @brief All in one function to configure PWM
929929
* @param channel: Arduino channel [1..4]
930930
* @param pin: pin name, ex PB_0
931-
* @param frequency: PWM frequency expessed in hertz
931+
* @param frequency: PWM frequency expressed in hertz
932932
* @param dutycycle: PWM dutycycle expressed in percentage
933-
* @param PeriodCallback: timer period callback (timer rollover upon udate event)
933+
* @param PeriodCallback: timer period callback (timer rollover upon update event)
934934
* @param CompareCallback: timer compare callback
935935
* @retval None
936936
*/
@@ -1033,7 +1033,7 @@ void HardwareTimer::attachInterrupt(uint32_t channel, callback_function_t callba
10331033
}
10341034

10351035
/**
1036-
* @brief Dettach interrupt callback on Capture/Compare event
1036+
* @brief Detach interrupt callback on Capture/Compare event
10371037
* @param channel: Arduino channel [1..4]
10381038
* @retval None
10391039
*/
@@ -1118,7 +1118,7 @@ void HardwareTimer::updateCallback(TIM_HandleTypeDef *htim)
11181118
}
11191119

11201120
/**
1121-
* @brief Generic Caputre and Compare callback which will call user callback
1121+
* @brief Generic Capture and Compare callback which will call user callback
11221122
* @param htim: HAL timer handle
11231123
* @retval None
11241124
*/

0 commit comments

Comments
 (0)