aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/cpp/static.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/static.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/static.rst')
-rw-r--r--docs/source/lang/cpp/static.rst56
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/source/lang/cpp/static.rst b/docs/source/lang/cpp/static.rst
deleted file mode 100644
index 8c52ba0..0000000
--- a/docs/source/lang/cpp/static.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-static:
-
-``static``
-==========
-
-The ``static`` keyword can be used to create variables that are
-visible to only one function. However, unlike local variables that get
-created and destroyed every time a function is called, ``static``
-variables persist beyond the function call, preserving their data
-between function calls.
-
-Variables declared as ``static`` will only be created and initialized
-the first time a function is called.
-
-.. note:: This is only one use of the ``static`` keyword in C++. It
- has some other important uses that are not documented here; consult
- a reliable C++ reference for details.
-
-Example
--------
-
-One use case for ``static`` variables is implementing counters that
-last longer than the functions which need them, but shouldn't be
-shared to other functions. Here's an example::
-
- void setup() {
- SerialUSB.begin();
- }
-
- void loop() {
- int reading;
- if (timeToReadSensors()) {
- reading = readSensors();
- }
- // do something with reading
- }
-
- int readSensors() {
- static int numSensorReadings = 0;
- numSensorReadings++;
- if (numSensorReadings % 100 == 0) {
- SerialUSB.print("just got to another 100 sensor readings");
- }
- return analogRead(...);
- }
-
-In this example, the static variable ``numSensorReadings`` is
-initialized to zero the first time ``readSensors()`` is called, and
-then incremented, so it starts out at one. Subsequent calls to
-``readSensors()`` won't reset ``numSensorReadings`` to zero, because
-it was declared ``static``. Thus, ``numSensorReadings`` is a count of
-the number of times that ``readSensors()`` has been called.
-
-.. include:: /arduino-cc-attribution.txt