aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/unimplemented/nointerrupts.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-11-29 01:49:26 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-11-29 01:49:26 -0500
commit078edc158da7906ba72e7e6528e1a811e07270e7 (patch)
tree1bc7b2e8137fb5ebfc7b59d59294d7adb9e95468 /docs/source/lang/unimplemented/nointerrupts.rst
parent5e587be27a7c3bd854b686952a5c9637a2432ff0 (diff)
downloadlibrambutan-078edc158da7906ba72e7e6528e1a811e07270e7.tar.gz
librambutan-078edc158da7906ba72e7e6528e1a811e07270e7.zip
Finished converting the Arduino docs
Diffstat (limited to 'docs/source/lang/unimplemented/nointerrupts.rst')
-rw-r--r--docs/source/lang/unimplemented/nointerrupts.rst59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/source/lang/unimplemented/nointerrupts.rst b/docs/source/lang/unimplemented/nointerrupts.rst
new file mode 100644
index 0000000..fb2e5f9
--- /dev/null
+++ b/docs/source/lang/unimplemented/nointerrupts.rst
@@ -0,0 +1,59 @@
+.. _lang-nointerrupts:
+
+noInterrupts()
+==============
+
+Description
+-----------
+
+Disables interrupts (you can re-enable them with interrupts()).
+Interrupts allow certain important tasks to happen in the
+background and are enabled by default. Some functions will not work
+while interrupts are disabled, and incoming communication may be
+ignored. Interrupts can slightly disrupt the timing of code,
+however, and may be disabled for particularly critical sections of
+code.
+
+
+
+Parameters
+----------
+
+None.
+
+
+
+Returns
+-------
+
+None.
+
+
+
+Example
+-------
+
+::
+
+ void setup() {}
+
+ void loop()
+ {
+ noInterrupts();
+ // critical, time-sensitive code here
+ interrupts();
+ // other code here
+ }
+
+
+
+See Also
+--------
+
+
+- `interrupts <http://arduino.cc/en/Reference/Interrupts>`_\ ()
+
+
+
+
+.. include:: /lang/cc-attribution.txt