Update HardwareTimer.h documentation.

topin89 · web-flow · commit e961f5bb1897 · 2017-11-21T16:48:45.000+03:00
"attachInterrupt" and "attachInterrupt" functions can attach ISRs to channel 0,
which is overflow interrupt (update interrupt in RMs).
diff --git a/STM32F1/cores/maple/HardwareTimer.h b/STM32F1/cores/maple/HardwareTimer.h
@@ -177,7 +177,8 @@ class HardwareTimer {
      * This interrupt handler will be called when the timer's counter
      * reaches the given channel compare value.
      *
-     * @param channel the channel to attach the ISR to, from 1 to 4.
+     * @param channel the channel to attach the ISR to, from 0 to 4.
+     *   Channel 0 is for overflow interrupt (update interrupt).
      * @param handler The ISR to attach to the given channel.
      * @see voidFuncPtr
      */
@@ -189,7 +190,8 @@ class HardwareTimer {
      *
      * The handler will no longer be called by this timer.
      *
-     * @param channel the channel whose interrupt to detach, from 1 to 4.
+     * @param channel the channel whose interrupt to detach, from 0 to 4.
+     *   Channel 0 is for overflow interrupt (update interrupt).
      * @see HardwareTimer::attachInterrupt()
      */
     void detachInterrupt(int channel);

Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,8 @@ class HardwareTimer {`
`177`	`177`	`* This interrupt handler will be called when the timer's counter`
`178`	`178`	`* reaches the given channel compare value.`
`179`	`179`	`*`
`180`		`- * @param channel the channel to attach the ISR to, from 1 to 4.`
	180	`+ * @param channel the channel to attach the ISR to, from 0 to 4.`
	`181`	`+ * Channel 0 is for overflow interrupt (update interrupt).`
`181`	`182`	`* @param handler The ISR to attach to the given channel.`
`182`	`183`	`* @see voidFuncPtr`
`183`	`184`	`*/`
`@@ -189,7 +190,8 @@ class HardwareTimer {`
`189`	`190`	`*`
`190`	`191`	`* The handler will no longer be called by this timer.`
`191`	`192`	`*`
`192`		`- * @param channel the channel whose interrupt to detach, from 1 to 4.`
	`193`	`+ * @param channel the channel whose interrupt to detach, from 0 to 4.`
	`194`	`+ * Channel 0 is for overflow interrupt (update interrupt).`
`193`	`195`	`* @see HardwareTimer::attachInterrupt()`
`194`	`196`	`*/`
`195`	`197`	`void detachInterrupt(int channel);`