aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/bit.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/bit.rst')
-rw-r--r--docs/source/lang/bit.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/source/lang/bit.rst b/docs/source/lang/bit.rst
new file mode 100644
index 0000000..c342fdd
--- /dev/null
+++ b/docs/source/lang/bit.rst
@@ -0,0 +1,48 @@
+.. _lang-bit:
+
+bit()
+=====
+
+Description
+-----------
+
+(Macro) Computes the value of an (unsigned) integer with the specified
+bit set (``bit(0)`` is 1, ``bit(1)`` is 2, ``bit(2)`` is 4, then 8,
+16, 32, etc.).
+
+
+Syntax
+------
+
+``bit(n)``
+
+
+Parameters
+----------
+
+* **n** the bit to set.
+
+
+Value
+-----
+
+The value of an integer with the given bit set.
+
+
+Arduino Compatibility
+---------------------
+
+The Maple implementation of bit is compatible with Arduino.
+
+
+See also
+--------
+
+
+- :ref:`lang-bitread`
+- :ref:`lang-bitwrite`
+- :ref:`lang-bitset`
+- :ref:`lang-bitclear`
+
+
+.. include:: cc-attribution.txt