Add comments stating burden on caller

Author: James Munns

nrf52-hal-common/src/rtc.rs

@@ -82,6 +82,10 @@ where
     }
 
     /// Enable the generation of a hardware interrupt from a given stimulus
+    ///
+    /// If access to the NVIC is not provided, the interrupt must ALSO be enabled
+    /// there outside of this function (e.g. manually call `nvic.enable`, or through
+    /// the use of RTFM).
     pub fn enable_interrupt(&mut self, int: RtcInterrupt, nvic: Option<&mut NVIC>) {
         match int {
             RtcInterrupt::Tick => self.periph.intenset.write(|w| w.tick().set()),
@@ -97,6 +101,10 @@ where
     }
 
     /// Disable the generation of a hardware interrupt from a given stimulus
+    ///
+    /// If access to the NVIC is not provided, the interrupt must ALSO be disabled
+    /// there outside of this function (e.g. manually call `nvic.enable`, or through
+    /// the use of RTFM).
     pub fn disable_interrupt(&mut self, int: RtcInterrupt, nvic: Option<&mut NVIC>) {
         match int {
             RtcInterrupt::Tick => self.periph.intenclr.write(|w| w.tick().clear()),

nrf52-hal-common/src/timer.rs

@@ -60,6 +60,10 @@ where
     ///
     /// Enables an interrupt that is fired when the timer reaches the value that
     /// is given as an argument to `start`.
+    ///
+    /// If access to the NVIC is not provided, the interrupt must ALSO be enabled
+    /// there outside of this function (e.g. manually call `nvic.enable`, or through
+    /// the use of RTFM).
     pub fn enable_interrupt(&mut self, nvic: Option<&mut NVIC>) {
         // As of this writing, the timer code only uses
         // `cc[0]`/`events_compare[0]`. If the code is extended to use other
@@ -75,6 +79,10 @@ where
     ///
     /// Disables an interrupt that is fired when the timer reaches the value
     /// that is given as an argument to `start`.
+    ///
+    /// If access to the NVIC is not provided, the interrupt must ALSO be disabled
+    /// there outside of this function (e.g. manually call `nvic.enable`, or through
+    /// the use of RTFM).
     pub fn disable_interrupt(&mut self, nvic: Option<&mut NVIC>) {
         // As of this writing, the timer code only uses
         // `cc[0]`/`events_compare[0]`. If the code is extended to use other