aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/cpp/sizeof.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/sizeof.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/sizeof.rst')
-rw-r--r--docs/source/lang/cpp/sizeof.rst64
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/source/lang/cpp/sizeof.rst b/docs/source/lang/cpp/sizeof.rst
deleted file mode 100644
index ec2dea6..0000000
--- a/docs/source/lang/cpp/sizeof.rst
+++ /dev/null
@@ -1,64 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-sizeof:
-
-``sizeof()``
-============
-
-The ``sizeof`` operator on the Maple returns the number of bytes
-needed to store a value of a given type\ [#fcharsize]_. This can be
-an ordinary numeric type, like ``int``. It can be something more
-complicated, like a ``struct`` or ``union``. If the argument to
-``sizeof`` is an array, it returns the total number of bytes occupied
-by the array.
-
-The general syntax looks like this::
-
- sizeof(type)
- sizeof(var)
-
-Example
--------
-
-The ``sizeof`` operator is useful for dealing with arrays (such as
-strings) where it is convenient to be able to change the size of the
-array without breaking other parts of the program.
-
-This program prints out a text string one character at a time. Try
-changing the text phrase::
-
- char myStr[] = "this is a test";
- int i;
-
- void setup() {
- Serial.begin(9600);
- }
-
- void loop() {
- for (i = 0; i < sizeof(myStr) - 1; i++) {
- Serial.print(i, DEC);
- Serial.print(" = ");
- Serial.println(myStr[i], BYTE);
- }
- }
-
-
-Note that ``sizeof`` returns the total number of bytes. So for larger
-variable types such as ``int``, the :ref:`for loop <lang-for>`
-would look something like this::
-
- for (i = 0; i < (sizeof(myInts)/sizeof(int)) - 1; i++) {
- // do something with myInts[i]
- }
-
-.. rubric:: Footnotes
-
-.. [#fcharsize] Technically (and pedantically) speaking, ``sizeof``
- returns a multiple of the number of bits a ``char`` occupies in
- memory. However, on the Maple (this goes for most C++
- implementations), a ``char`` occupies 8 bits = 1 byte. All the C++
- standard guarantees, however, is that a ``char`` occupies at
- *least* 8 bits.
-
-.. include:: /arduino-cc-attribution.txt
-