aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/cpp/modulo.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
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/lang/cpp/modulo.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
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/modulo.rst')
-rw-r--r--docs/source/lang/cpp/modulo.rst70
1 files changed, 0 insertions, 70 deletions
diff --git a/docs/source/lang/cpp/modulo.rst b/docs/source/lang/cpp/modulo.rst
deleted file mode 100644
index 013d07e..0000000
--- a/docs/source/lang/cpp/modulo.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-modulo:
-
-Modulo Operator (``%``)
-=======================
-
-Calculates the `remainder <http://en.wikipedia.org/wiki/Remainder>`_
-when one integer is divided by another. It is useful for keeping a
-variable within a particular range (e.g. the size of an array).
-
-Syntax
-------
-
-::
-
- dividend % divisor
-
-Parameters
-----------
-
-**dividend**: the number to be divided
-
-**divisor**: the number to divide by
-
-Returns
--------
-
-The remainder of **dividend**\ /\ **divisor**\ .
-
-Examples
---------
-
-::
-
- int x;
- x = 7 % 5; // x now contains 2
- x = 9 % 5; // x now contains 4
- x = 5 % 5; // x now contains 0
- x = 4 % 5; // x now contains 4
-
-::
-
- /* update one value in an array each time through a loop */
-
- int values[10];
- int i = 0;
-
- void setup() {
- // no setup necessary
- }
-
- void loop() {
- values[i] = analogRead(0);
- i = (i + 1) % 10; // modulo operator makes sure i stays between 0 and 9
- }
-
-Tip
----
-
-The modulo operator does not work on floats. For that, you can use
-the C standard library function `fmod()
-<http://sourceware.org/newlib/libm.html#fmod>`_.
-
-See Also
---------
-
-- :ref:`Arithmetic <lang-arithmetic>`
-
-.. include:: /arduino-cc-attribution.txt