aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/bitwrite.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/api/bitwrite.rst')
-rw-r--r--docs/source/lang/api/bitwrite.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/lang/api/bitwrite.rst b/docs/source/lang/api/bitwrite.rst
new file mode 100644
index 0000000..b3feff2
--- /dev/null
+++ b/docs/source/lang/api/bitwrite.rst
@@ -0,0 +1,46 @@
+.. highlight:: cpp
+
+.. _lang-bitwrite:
+
+bitWrite()
+==========
+
+(Macro) Writes a bit of a numeric variable.
+
+Syntax
+------
+
+::
+
+ bitWrite(x, n, b)
+
+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