aboutsummaryrefslogtreecommitdiff
path: root/docs/source/lang/cpp/boolean.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commitf36a1d98492fba4c96bde76106aff161a30b389a (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/lang/cpp/boolean.rst
parentc092b10afb3620dc739646c9dca5fcf41c5f6084 (diff)
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'docs/source/lang/cpp/boolean.rst')
-rw-r--r--docs/source/lang/cpp/boolean.rst90
1 files changed, 0 insertions, 90 deletions
diff --git a/docs/source/lang/cpp/boolean.rst b/docs/source/lang/cpp/boolean.rst
deleted file mode 100644
index f09345e..0000000
--- a/docs/source/lang/cpp/boolean.rst
+++ /dev/null
@@ -1,90 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-boolean:
-
-Boolean Operators
-=================
-
-These can be used inside the condition of an :ref:`if <lang-if>`
-statement. Evaluate to :ref:`true <lang-constants-true>` or
-:ref:`false <lang-constants-false>`.
-
-.. contents:: Contents
- :local:
-
-.. _lang-boolean-and:
-
-&& (logical and)
-----------------
-
-True only if both operands are true. For example::
-
- if (digitalRead(2) == HIGH && digitalRead(3) == HIGH) { // read two switches
- // ...
- }
-
-is true only if both inputs are high. Another example::
-
- if (a >= 10 && a <= 20){} // true if a is between 10 and 20
-
-**Be careful** not to say ``10 <= a <= 20``! This won't work the way
-you want. You have to separately test whether ``a`` is at least 10
-using ``a >= 10``, then test whether ``a`` is at most 20 using ``a <=
-20``, then combine the results using ``&&``.
-
-
-.. _lang-boolean-or:
-
-\|\| (logical or)
------------------
-
-True if either operand is true. For example::
-
- if (x > 0 || y > 0) {
- // ...
- }
-
-is true if either ``x`` or ``y`` is greater than 0.
-
-.. _lang-boolean-not:
-
-! (logical not)
----------------
-
-True if the operand is false. For example::
-
- if (!x) {
- // ...
- }
-
-is true if ``x`` is false (i.e. if ``x`` is zero).
-
-Some Advice
------------
-
-.. warning::
-
- Make sure you don't mistake the boolean AND operator ``&&``
- (double ampersand) for the :ref:`bitwise AND operator
- <lang-bitwisemath-and>` ``&`` (single ampersand). They are
- entirely different beasts.
-
- Similarly, do not confuse the boolean OR operator ``||`` (double
- pipe) with the :ref:`bitwise OR operator <lang-bitwisemath-or>`
- ``|`` (single pipe).
-
- The :ref:`bitwise NOT operator <lang-bitwisemath-not>` ``~``
- (tilde) looks much different than the boolean not operator ``!``
- (exclamation point, or "bang", as some programmers say), but you
- still have to be sure which one you want.
-
-
-See Also
---------
-
-- :ref:`Bitwise operators <lang-bitwisemath>` (``&``, ``|``, ``^``, ``~``)
-- :ref:`Compound bitwise operators <lang-compoundbitwise>` (``&=``,
- ``|=``, ``^=``).
-- :ref:`if statement <lang-if>`
-
-.. include:: /arduino-cc-attribution.txt