aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/bitwrite.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-10-25 21:15:28 -0400
committerMarti Bolivar <mbolivar@mit.edu>2010-11-17 12:44:28 -0500
commit95783b750fda95f5f4c1fac00ab24da03b31b517 (patch)
tree2b0bf89c101aa58af5796fbe76c7ec98eebbb0a5 /docs/source/arduino/bitwrite.rst
parent3a9a119e9a8ce72c0e1b8fa4d3904bdf84ce355c (diff)
downloadlibrambutan-95783b750fda95f5f4c1fac00ab24da03b31b517.tar.gz
librambutan-95783b750fda95f5f4c1fac00ab24da03b31b517.zip
arduino language reference nearing completion, properly CC-BY-SA 3.0 attributed
Diffstat (limited to 'docs/source/arduino/bitwrite.rst')
-rw-r--r--docs/source/arduino/bitwrite.rst45
1 files changed, 15 insertions, 30 deletions
diff --git a/docs/source/arduino/bitwrite.rst b/docs/source/arduino/bitwrite.rst
index 5d95506..b35a54f 100644
--- a/docs/source/arduino/bitwrite.rst
+++ b/docs/source/arduino/bitwrite.rst
@@ -1,52 +1,37 @@
.. _arduino-bitwrite:
-bitWrite()
-==========
+bitWrite(x, n, b)
+=================
Description
-----------
-Writes a bit of a numeric variable.
-
-
-
-Syntax
-------
-
-bitWrite(x, n, b)
-
-
+(Macro) Writes a bit of a numeric variable.
Parameters
----------
-x: the numeric variable to which to write
-
-
-
-n: which bit of the number to write, starting at 0 for the
-least-significant (rightmost) bit
-
-
-
-b: the value to write to the bit (0 or 1)
+**x**: the numeric variable whose bit to write.
+**n**: which bit of the number to write, starting at 0 for the
+least-significant (rightmost) bit.
+**b**: the value to write to the bit (0 or 1).
Returns
-------
-none
+Nothing.
+Arduino Compatibility
+---------------------
+Maple's version of ``bitWrite()`` is compatible with Arduino.
See also
--------
-
-- `bit <http://arduino.cc/en/Reference/Bit>`_\ ()
-- `bitRead <http://arduino.cc/en/Reference/BitRead>`_\ ()
-- `bitSet <http://arduino.cc/en/Reference/BitSet>`_\ ()
-- `bitClear <http://arduino.cc/en/Reference/BitClear>`_\ ()
-
-
+- :ref:`bit() <arduino-bit>`
+- :ref:`bitRead() <arduino-bitRead>`
+- :ref:`bitSet() <arduino-bitSet>`
+- :ref:`bitClear() <arduino-bitClear>`