aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/detachinterrupt.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/arduino/detachinterrupt.rst')
-rw-r--r--docs/source/arduino/detachinterrupt.rst32
1 files changed, 20 insertions, 12 deletions
diff --git a/docs/source/arduino/detachinterrupt.rst b/docs/source/arduino/detachinterrupt.rst
index f0342df..f770de1 100644
--- a/docs/source/arduino/detachinterrupt.rst
+++ b/docs/source/arduino/detachinterrupt.rst
@@ -1,26 +1,34 @@
.. _arduino-detachinterrupt:
-detachInterrupt(interrupt)
-==========================
+detachInterrupt()
+=================
-Description
------------
+Used to disable an interrupt specified with
+:ref:`arduino-attachinterrupt`\ .
-Turns off the given interrupt.
+Library Documentation
+---------------------
+.. doxygenfunction:: detachInterrupt
-Parameters
-----------
+Arduino Compatibility
+---------------------
-interrupt: the number of interrupt to disable (0 or 1).
+There is one important difference between the Maple version of
+detachInterrupt and the Arduino version. On the Maple, the argument
+to ``detachInterrupt()`` is the *pin* on which the interrupt is
+attached, while on the Arduino, the argument is the *interrupt
+number*, which is different from the pin the interrupt is enabled on.
+If you're calling this function, you've already called
+:ref:`arduino-attachinterrupt` to set up your interrupt handler, so
+just call ``detachInterrupt()`` with the same pin argument you gave to
+``attachInterrupt()``.
-
-See also
+See Also
--------
-
-- `attachInterrupt <http://arduino.cc/en/Reference/AttachInterrupt>`_\ ()
+- :ref:`attachInterrupt() <arduino-attachInterrupt>`