aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/bitwrite.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-11-28 11:23:33 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-11-28 11:23:33 -0500
commit5e587be27a7c3bd854b686952a5c9637a2432ff0 (patch)
tree09d4ceeb46f19287ee874a24516c68be90c9ad8e /docs/source/lang/bitwrite.rst
parentdb4ff6ba53e9b702c77411ae19cd53d914a675de (diff)
downloadlibrambutan-5e587be27a7c3bd854b686952a5c9637a2432ff0.tar.gz
librambutan-5e587be27a7c3bd854b686952a5c9637a2432ff0.zip
reorganized all the arduino/ docs into a lang/ subdirectory since
they're properly CC attributed now.
Diffstat (limited to 'docs/source/lang/bitwrite.rst')
-rw-r--r--docs/source/lang/bitwrite.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/source/lang/bitwrite.rst b/docs/source/lang/bitwrite.rst
new file mode 100644
index 0000000..86df26e
--- /dev/null
+++ b/docs/source/lang/bitwrite.rst
@@ -0,0 +1,40 @@
+.. _lang-bitwrite:
+
+bitWrite(x, n, b)
+=================
+
+Description
+-----------
+
+(Macro) Writes a bit of a numeric variable.
+
+Parameters
+----------
+
+**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
+-------
+
+Nothing.
+
+Arduino Compatibility
+---------------------
+
+Maple's version of ``bitWrite()`` is compatible with Arduino.
+
+See also
+--------
+
+- :ref:`bit() <lang-bit>`
+- :ref:`bitRead() <lang-bitRead>`
+- :ref:`bitSet() <lang-bitSet>`
+- :ref:`bitClear() <lang-bitClear>`
+
+
+.. include:: cc-attribution.txt