aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/bitclear.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/api/bitclear.rst')
-rw-r--r--docs/source/lang/api/bitclear.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/source/lang/api/bitclear.rst b/docs/source/lang/api/bitclear.rst
new file mode 100644
index 0000000..f487059
--- /dev/null
+++ b/docs/source/lang/api/bitclear.rst
@@ -0,0 +1,39 @@
+.. _lang-bitclear:
+
+bitClear()
+==========
+
+(Macro) Clears (writes a 0 to) a bit of a numeric variable.
+
+Syntax
+------
+
+``bitClear(x, n)``
+
+Parameters
+----------
+
+* **x** the numeric variable whose bit to clear
+
+* **n** which bit to clear, starting at 0 for the least-significant
+ (rightmost) bit
+
+Returns
+-------
+
+Nothing.
+
+Arduino Compatibility
+---------------------
+
+The Maple implementation of ``bitClear()`` is compatible with Arduino.
+
+See Also
+--------
+
+- :ref:`bit <lang-bit>`\ ()
+- :ref:`bitRead <lang-bitread>`\ ()
+- :ref:`bitWrite <lang-bitwrite>`\ ()
+- :ref:`bitSet <lang-bitset>`\ ()
+
+.. include:: /arduino-cc-attribution.txt