diff options
Diffstat (limited to 'source/lang/cpp')
49 files changed, 56 insertions, 118 deletions
diff --git a/source/lang/cpp/arithmetic.rst b/source/lang/cpp/arithmetic.rst index 26e2811..cef3954 100644 --- a/source/lang/cpp/arithmetic.rst +++ b/source/lang/cpp/arithmetic.rst @@ -121,4 +121,4 @@ See Also - :ref:`sizeof <lang-sizeof>`\ () -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/array.rst b/source/lang/cpp/array.rst index 30a818f..39d4d91 100644 --- a/source/lang/cpp/array.rst +++ b/source/lang/cpp/array.rst @@ -113,11 +113,9 @@ Arduino Compatibility Arrays on Maple are identical those on Arduino. -See also +See Also -------- - :ref:`Storing arrays in FLASH memory <arm-gcc-attribute-flash>` - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/assignment.rst b/source/lang/cpp/assignment.rst index f9430b4..6379298 100644 --- a/source/lang/cpp/assignment.rst +++ b/source/lang/cpp/assignment.rst @@ -57,4 +57,4 @@ See Also <http://icu-project.org/docs/papers/cpp_report/the_anatomy_of_the_assignment_operator.html>`_ for more information. -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/bitshift.rst b/source/lang/cpp/bitshift.rst index e1c8de0..47413f2 100644 --- a/source/lang/cpp/bitshift.rst +++ b/source/lang/cpp/bitshift.rst @@ -140,5 +140,4 @@ See Also - :ref:`lang-bitwrite` - :ref:`lang-bitclear` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/bitwisemath.rst b/source/lang/cpp/bitwisemath.rst index 28fe6bf..59794ba 100644 --- a/source/lang/cpp/bitwisemath.rst +++ b/source/lang/cpp/bitwisemath.rst @@ -182,5 +182,4 @@ See Also - :ref:`Compound bitwise operations <lang-compoundbitwise>` (``&=``, ``|=``, ``^=``). - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/boolean.rst b/source/lang/cpp/boolean.rst index 8d6aa5c..f09345e 100644 --- a/source/lang/cpp/boolean.rst +++ b/source/lang/cpp/boolean.rst @@ -87,5 +87,4 @@ See Also ``|=``, ``^=``). - :ref:`if statement <lang-if>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/booleanvariables.rst b/source/lang/cpp/booleanvariables.rst index 6051b8c..0d76a12 100644 --- a/source/lang/cpp/booleanvariables.rst +++ b/source/lang/cpp/booleanvariables.rst @@ -42,13 +42,11 @@ Example } } -See also +See Also -------- - - :ref:`Boolean constants <lang-constants-bool>` - :ref:`Boolean operators <lang-boolean>` - :ref:`Variables <lang-variables>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/break.rst b/source/lang/cpp/break.rst index ce8ac17..f367b99 100644 --- a/source/lang/cpp/break.rst +++ b/source/lang/cpp/break.rst @@ -29,7 +29,4 @@ Example delay(50); } - - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/byte.rst b/source/lang/cpp/byte.rst index 45c9d5f..4634594 100644 --- a/source/lang/cpp/byte.rst +++ b/source/lang/cpp/byte.rst @@ -30,5 +30,4 @@ See Also - :ref:`byte() <lang-bytecast>` (casting a value to a byte) - :ref:`Variables <lang-variables>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/bytecast.rst b/source/lang/cpp/bytecast.rst index b3f0de2..24c3b9e 100644 --- a/source/lang/cpp/bytecast.rst +++ b/source/lang/cpp/bytecast.rst @@ -24,13 +24,11 @@ Syntax ``byte(x)`` - Parameters ---------- **x**: a value of any integer type - Returns ------- @@ -38,13 +36,9 @@ The value, converted to a ``byte``. Note, however, that if the value is larger than the maximum value you can store in a byte (255), then the results might be strange and unexpected. - See Also -------- - :ref:`lang-byte` - - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/char.rst b/source/lang/cpp/char.rst index b8747f3..686c0d1 100644 --- a/source/lang/cpp/char.rst +++ b/source/lang/cpp/char.rst @@ -10,7 +10,6 @@ value from -128 to 127). Character literals are written in single quotes, like this: ``'A'`` (for multiple characters - strings - use double quotes: ``"ABC"``). - Just like everything else on a computer, characters are stored as numbers. You can see the specific encoding in the `ASCII chart <http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters>`_\ @@ -25,26 +24,21 @@ The ``char`` datatype is a signed type, meaning that it encodes numbers from -128 to 127. For an unsigned type, which stores values from 0 to 255, just use the type ``unsigned char`` (two words). - Example ------- :: - // the following two lines are equivalent, using the ASCII + // The following two lines are equivalent, using the ASCII // character encoding: char c = 'A'; char c = 65; - -See also +See Also -------- - - :ref:`lang-int` - :ref:`lang-array` (a string is just an array of ``char``\ s) - :ref:`Serial.println() <lang-serial-println>` - - .. include:: cc-attribution.txt diff --git a/source/lang/cpp/charcast.rst b/source/lang/cpp/charcast.rst index a480dec..640ad85 100644 --- a/source/lang/cpp/charcast.rst +++ b/source/lang/cpp/charcast.rst @@ -12,13 +12,11 @@ Syntax ``char(x)`` - Parameters ---------- **x**: a value of any type - Returns ------- @@ -26,11 +24,9 @@ The value, converted to a ``char``. Note, however, that if the value is outside the range of a ``char`` (-128 to 127), then the results might be strange and unexpected. - See Also -------- - :ref:`char <lang-char>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/comments.rst b/source/lang/cpp/comments.rst index c5f118a..1428dc3 100644 --- a/source/lang/cpp/comments.rst +++ b/source/lang/cpp/comments.rst @@ -61,7 +61,4 @@ just ignores them. This can be especially useful when trying to locate a problem, or when a program refuses to compile and the compiler error is cryptic or unhelpful. - - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/comparison.rst b/source/lang/cpp/comparison.rst index b24355f..9cd0a9f 100644 --- a/source/lang/cpp/comparison.rst +++ b/source/lang/cpp/comparison.rst @@ -83,5 +83,4 @@ Comparison operators, along with :ref:`boolean operators appears within a conditional doesn't mean it's automatically wrong. Be careful to know what you mean.) - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/compoundarithmetic.rst b/source/lang/cpp/compoundarithmetic.rst index 420f1db..d70a43c 100644 --- a/source/lang/cpp/compoundarithmetic.rst +++ b/source/lang/cpp/compoundarithmetic.rst @@ -40,5 +40,4 @@ See Also - :ref:`Arithmetic operators <lang-arithmetic>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/compoundbitwise.rst b/source/lang/cpp/compoundbitwise.rst index 8231130..4efe5df 100644 --- a/source/lang/cpp/compoundbitwise.rst +++ b/source/lang/cpp/compoundbitwise.rst @@ -226,5 +226,4 @@ See Also - :ref:`Boolean operations <lang-boolean>` (``&&``, ``||``) - :ref:`Bitwise operators <lang-bitwisemath>` (``&``, ``|``, ``^``, ``~``) - .. include:: cc-attribution.txt diff --git a/source/lang/cpp/const.rst b/source/lang/cpp/const.rst index 52de85f..ad0c580 100644 --- a/source/lang/cpp/const.rst +++ b/source/lang/cpp/const.rst @@ -21,7 +21,7 @@ method for defining constants than ``#define``. Example ------- -:: + :: // this defines a variable called "pi", which cannot be changed: const float pi = 3.14; @@ -33,7 +33,6 @@ Example pi = 7; // illegal - you can't write to (modify) a constant - **#define** or **const** ------------------------ @@ -48,5 +47,4 @@ See Also - :ref:`#define <lang-define>` - :ref:`volatile <lang-volatile>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/continue.rst b/source/lang/cpp/continue.rst index 13d1815..2a694f6 100644 --- a/source/lang/cpp/continue.rst +++ b/source/lang/cpp/continue.rst @@ -27,6 +27,4 @@ Example delay(50); } - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/curly-braces.rst b/source/lang/cpp/curly-braces.rst index a4bd3dc..df2fe2a 100644 --- a/source/lang/cpp/curly-braces.rst +++ b/source/lang/cpp/curly-braces.rst @@ -99,11 +99,8 @@ reference page for more information):: .. rubric:: Footnotes -.. TODO remove this once IDE 0.1.0 released - .. [#fbug] At present this feature is slightly buggy as the IDE will often find (incorrectly) a brace in text that has been commented out. - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/define.rst b/source/lang/cpp/define.rst index 677390d..bdf7283 100644 --- a/source/lang/cpp/define.rst +++ b/source/lang/cpp/define.rst @@ -13,7 +13,6 @@ defined value at compile time. This can have some unwanted side effects. In general, the :ref:`const <lang-const>` keyword is preferred for defining constants. - Syntax ------ @@ -42,7 +41,7 @@ is, **don't do this, either**:: Example ------- -:: + :: #define LED_PIN 13 // The compiler will replace any mention of LED_PIN with @@ -52,5 +51,4 @@ See Also -------- - :ref:`const <lang-const>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/double.rst b/source/lang/cpp/double.rst index 1527778..59422eb 100644 --- a/source/lang/cpp/double.rst +++ b/source/lang/cpp/double.rst @@ -43,6 +43,4 @@ See Also - :ref:`float <lang-float>` - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/doublecast.rst b/source/lang/cpp/doublecast.rst index 16a9907..d3f32ce 100644 --- a/source/lang/cpp/doublecast.rst +++ b/source/lang/cpp/doublecast.rst @@ -24,4 +24,4 @@ See Also - :ref:`float <lang-float>` - :ref:`float() <lang-floatcast>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/dowhile.rst b/source/lang/cpp/dowhile.rst index fe92226..d229122 100644 --- a/source/lang/cpp/dowhile.rst +++ b/source/lang/cpp/dowhile.rst @@ -23,5 +23,4 @@ Example:: x = readSensors(); // check the sensors } while (x < 100); - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/float.rst b/source/lang/cpp/float.rst index 6937c8c..5195fac 100644 --- a/source/lang/cpp/float.rst +++ b/source/lang/cpp/float.rst @@ -47,4 +47,4 @@ See Also - :ref:`double <lang-double>` - :ref:`Variables <lang-variables>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/floatcast.rst b/source/lang/cpp/floatcast.rst index 4766478..af92543 100644 --- a/source/lang/cpp/floatcast.rst +++ b/source/lang/cpp/floatcast.rst @@ -25,4 +25,4 @@ See Also - :ref:`double <lang-double>` - :ref:`double() <lang-doublecast>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/for.rst b/source/lang/cpp/for.rst index 71c5aca..78ea562 100644 --- a/source/lang/cpp/for.rst +++ b/source/lang/cpp/for.rst @@ -123,7 +123,7 @@ questions (answers are in footnote [#fanswers]_\ ): 2. Why does it stop at 64? -See also +See Also -------- - :ref:`while <lang-while>` loops @@ -139,4 +139,4 @@ See also false, and the loop stops. -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/goto.rst b/source/lang/cpp/goto.rst index ff2f248..2c0b3b0 100644 --- a/source/lang/cpp/goto.rst +++ b/source/lang/cpp/goto.rst @@ -126,5 +126,4 @@ See Also - Knuth, Donald. `Structured Programming with go to Statements <http://pplab.snu.ac.kr/courses/adv_pl05/papers/p261-knuth.pdf>`_ (PDF) - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/if.rst b/source/lang/cpp/if.rst index bef89e2..d57b9f1 100644 --- a/source/lang/cpp/if.rst +++ b/source/lang/cpp/if.rst @@ -118,4 +118,4 @@ See Also - :ref:`boolean operators <lang-boolean>` - :ref:`comparison operators <lang-comparison>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/include.rst b/source/lang/cpp/include.rst index 74fe7af..163509d 100644 --- a/source/lang/cpp/include.rst +++ b/source/lang/cpp/include.rst @@ -67,6 +67,4 @@ root <http://en.wikipedia.org/wiki/Cube_root>`_ of a number:: SerialUSB.println(cubeRootOf3); } - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/increment.rst b/source/lang/cpp/increment.rst index 6dffa80..c423d1a 100644 --- a/source/lang/cpp/increment.rst +++ b/source/lang/cpp/increment.rst @@ -34,4 +34,4 @@ See Also - :ref:`lang-compoundarithmetic` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/intcast.rst b/source/lang/cpp/intcast.rst index 386fe14..da838c7 100644 --- a/source/lang/cpp/intcast.rst +++ b/source/lang/cpp/intcast.rst @@ -23,7 +23,4 @@ See Also - :ref:`int <lang-int>` - - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/longcast.rst b/source/lang/cpp/longcast.rst index f588fc6..493ad67 100644 --- a/source/lang/cpp/longcast.rst +++ b/source/lang/cpp/longcast.rst @@ -24,4 +24,4 @@ See Also - :ref:`long <lang-long>` - :ref:`long long <lang-longlong>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/longlong.rst b/source/lang/cpp/longlong.rst index 0ba56ed..d942cb4 100644 --- a/source/lang/cpp/longlong.rst +++ b/source/lang/cpp/longlong.rst @@ -53,4 +53,4 @@ See Also - :ref:`Integer Constants <lang-constants-integers>` - :ref:`Variables <lang-variables>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/modulo.rst b/source/lang/cpp/modulo.rst index 289fba0..013d07e 100644 --- a/source/lang/cpp/modulo.rst +++ b/source/lang/cpp/modulo.rst @@ -67,4 +67,4 @@ See Also - :ref:`Arithmetic <lang-arithmetic>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/pointer.rst b/source/lang/cpp/pointer.rst index 0a42270..ff4ec32 100644 --- a/source/lang/cpp/pointer.rst +++ b/source/lang/cpp/pointer.rst @@ -28,4 +28,4 @@ See Also - http://xkcd.com/138/ -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/return.rst b/source/lang/cpp/return.rst index b4ef5fd..d9aecbe 100644 --- a/source/lang/cpp/return.rst +++ b/source/lang/cpp/return.rst @@ -57,5 +57,4 @@ See Also - :ref:`comments <lang-comments>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/scope.rst b/source/lang/cpp/scope.rst index 7b65bab..a270428 100644 --- a/source/lang/cpp/scope.rst +++ b/source/lang/cpp/scope.rst @@ -117,4 +117,4 @@ See Also - `C++ programming Wikibook <http://en.wikibooks.org/wiki/C%2B%2B_Programming/Programming_Languages/C%2B%2B/Code/Statements/Scope>`_. - Wikipedia article on `scope <http://en.wikipedia.org/wiki/Scope_%28programming%29>`_ -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/semicolon.rst b/source/lang/cpp/semicolon.rst index 8164616..05e6218 100644 --- a/source/lang/cpp/semicolon.rst +++ b/source/lang/cpp/semicolon.rst @@ -19,7 +19,4 @@ compiler error comes up, one of the first things to check is a missing semicolon, in the immediate vicinity, preceding the line at which the compiler complained. - - - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/sizeof.rst b/source/lang/cpp/sizeof.rst index eae509c..ec2dea6 100644 --- a/source/lang/cpp/sizeof.rst +++ b/source/lang/cpp/sizeof.rst @@ -60,5 +60,5 @@ would look something like this:: standard guarantees, however, is that a ``char`` occupies at *least* 8 bits. -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/sqrt.rst b/source/lang/cpp/sqrt.rst index 956a754..fbabf82 100644 --- a/source/lang/cpp/sqrt.rst +++ b/source/lang/cpp/sqrt.rst @@ -21,5 +21,4 @@ See Also - :ref:`pow <lang-pow>` - :ref:`sq <lang-sq>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/static.rst b/source/lang/cpp/static.rst index 5d1802e..8c52ba0 100644 --- a/source/lang/cpp/static.rst +++ b/source/lang/cpp/static.rst @@ -53,5 +53,4 @@ then incremented, so it starts out at one. Subsequent calls to it was declared ``static``. Thus, ``numSensorReadings`` is a count of the number of times that ``readSensors()`` has been called. - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/string.rst b/source/lang/cpp/string.rst index 0a270da..84917c1 100644 --- a/source/lang/cpp/string.rst +++ b/source/lang/cpp/string.rst @@ -124,5 +124,4 @@ See Also - :ref:`__attribute__ <arm-gcc-attribute-flash>` - :ref:`Variables <lang-variables>` - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/switchcase.rst b/source/lang/cpp/switchcase.rst index b484bc5..e31ccf3 100644 --- a/source/lang/cpp/switchcase.rst +++ b/source/lang/cpp/switchcase.rst @@ -110,9 +110,9 @@ value as the variable to compare. In this case, you can write down all of the values the ``enum`` takes as ``case`` statements, and be sure you've covered all the possibilities. -See also: +See Also: --------- - :ref:`if/else <lang-if>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/unsignedchar.rst b/source/lang/cpp/unsignedchar.rst index 5b946ed..45fedeb 100644 --- a/source/lang/cpp/unsignedchar.rst +++ b/source/lang/cpp/unsignedchar.rst @@ -16,18 +16,17 @@ won't store negative numbers; it is also subject to the same Example ------- -:: + :: unsigned char c = 240; See Also -------- - - :ref:`byte <lang-byte>` - :ref:`int <lang-int>` - :ref:`array <lang-array>` - :ref:`SerialUSB.println() <lang-serialusb-println>` - :ref:`Serial.println() <lang-serial-println>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/unsignedint.rst b/source/lang/cpp/unsignedint.rst index ad3e2f2..b7d9716 100644 --- a/source/lang/cpp/unsignedint.rst +++ b/source/lang/cpp/unsignedint.rst @@ -56,4 +56,4 @@ See Also - :ref:`Integer Constants <lang-constants-integers>` - :ref:`Variables <lang-variables>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/unsignedlonglong.rst b/source/lang/cpp/unsignedlonglong.rst index 910b7e4..a1143f0 100644 --- a/source/lang/cpp/unsignedlonglong.rst +++ b/source/lang/cpp/unsignedlonglong.rst @@ -40,4 +40,4 @@ See Also - :ref:`Integer Constants <lang-constants-integers>` - :ref:`Variables <lang-variables>` -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/variables.rst b/source/lang/cpp/variables.rst index 336d5ab..9ffdd1d 100644 --- a/source/lang/cpp/variables.rst +++ b/source/lang/cpp/variables.rst @@ -165,6 +165,5 @@ See Also (usually) stored <http://en.wikipedia.org/wiki/Two%27s_complement>`_ on computers. - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/void.rst b/source/lang/cpp/void.rst index 88c9c64..7af0acd 100644 --- a/source/lang/cpp/void.rst +++ b/source/lang/cpp/void.rst @@ -28,6 +28,4 @@ Example // ... } -.. TODO doc page on function declaration? - -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt diff --git a/source/lang/cpp/while.rst b/source/lang/cpp/while.rst index 9047d05..e66e0aa 100644 --- a/source/lang/cpp/while.rst +++ b/source/lang/cpp/while.rst @@ -35,4 +35,4 @@ Example var++; } -.. include:: cc-attribution.txt +.. include:: /arduino-cc-attribution.txt |